@one-view/oneview-cs-be-translations-types v0.0.6

FORMAT: 1A HOST: https://api.pd-oneview.net/translations

oneview-cs-be-translations

A Service which provide with BE side translation

List of Translations /v1/entity/{type}/{lang}

Translation list based on ccr

• Parameters

  • type (required, string, ccr)
  • lang (required, string, en)

• Attributes (Translations)

Bulk upload translations POST

• Request

  • Headers

      x-api-key: secretKey

• Attributes (UploadTranslationsPayload)

• Response 204 (application/json)

• Response 400 (application/json)

  • Attributes (Error)

• Response 401 (application/json)

  • Attributes (Error)

• Response 403 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

get translations GET

• Request

  • Headers

      x-api-key: secretKey

• Response 200 (application/json)

  • Attributes (Translations)

• Response 400 (application/json)

  • Attributes (Error)

• Response 401 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

Get translation /v1/entity/{type}/{lang}/{key}

• Parameters
  • type (required, string, ccr)
  • lang (required, string, eng)
  • key (required, string, 1A.1)

get translation GET

• Request

  • Headers

      x-api-key: secretKey

• Response 200 (application/json)

  • Attributes (Translation)

• Response 400 (application/json)

  • Attributes (Error)

• Response 401 (application/json)

  • Attributes (Error)

• Response 404 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

Data Structures

int32 (number)

int64 (number)

error_object (object)

• status (string)
• title (string)
• code (string)

Error (object)

• errors (arrayerror_object, fixed-type)

UploadTranslationsPayload

• data (object, required)

Translations

• list (arrayTranslation, fixed-type)

Translation

• key : 1C.1 (string, required) - key to be used to query
• type : ccr (string, required) - group of translation
• language : en (string, required) - language that will be queried
• text : example of translation (string, required) - text that has been translated