2.0info: 5.1.1 translation_hub description: Translation hub service x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: translation_hub contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /translation_hub/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/requestImportTranslations: post: description: Requests a location to import translations to translation hub service. The returned id must be used to apply the translations. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url – id properties: url: type: string description: Url to upload translations file. id: type: string description: Identifier of the content to be uploaded. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Requests a location to import translations to translation hub service. The returned id must be used to apply the translations. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url – id properties: url: type: string description: Url to upload translations file. id: type: string description: Identifier of the content to be uploaded. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/exportGlobalTranslations: post: description: Exports only global translations. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – language – format properties: language: type: string description: Language of wich export translations. format: type: string allOf: – #/definitions/fileFormat description: Destination file format. responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Destination file url. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/exportDomainTranslations: post: description: Exports domain and global translations. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – language – format properties: domainName: type: string description: Domain of wich export translations. language: type: string description: Language of wich export translations. format: type: string allOf: – #/definitions/fileFormat description: Destination file format. responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Destination file url. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/exportServiceTranslations: post: description: Exports service, domain and global translations. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – language – format properties: domainName: type: string description: Domain of wich export translations. serviceName: type: string description: Service of wich export translations. language: type: string description: Language of wich export translations. format: type: string allOf: – #/definitions/fileFormat description: Destination file format. responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Destination file url. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/getTranslationBundle: post: description: Returns translation bundle. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – format properties: domainName: type: string description: Domain of wich get translations. serviceName: type: string description: Service of wich get translations. format: type: string allOf: – #/definitions/fileFormat description: Destination file format. splitMode: type: boolean description: Translations in two separated files, shared and tenant responses: 200: description: Ok schema: type: object required: – bundleFiles properties: bundleFiles: type: array items: type: object allOf: – #/definitions/bundleFile minimum: 1 description: Bundle files. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/getTranslationInfo: post: description: API DEPRECIADA: Utilize listServices | DATA: 2021-03-01 | Returns information about domains and services translations. tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – info properties: info: type: object allOf: – #/definitions/translationInfo description: Translations info. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Utilize listServices | DATA: 2021-03-01 | Returns information about domains and services translations. tags: – Queries deprecated : true x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – info properties: info: type: object allOf: – #/definitions/translationInfo description: Translations info. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/listServices: post: description: Lista os serviços que possuem alguma tradução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – language properties: language: type: string description: Idioma responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/listServiceItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os serviços que possuem alguma tradução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: language description: Idioma in: query required: true type: string responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/listServiceItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/listLanguages: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listTenantLanguages: type: boolean description: responses: 200: description: Ok schema: type: object required: – languages properties: languages: type: array items: type: object allOf: – #/definitions/language minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listTenantLanguages description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – languages properties: languages: type: array items: type: object allOf: – #/definitions/language minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/actions/updateTranslations: post: description: Creates or updates current tenant translations tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bundles properties: bundles: type: array items: type: object allOf: – #/definitions/translationBundle minimum: 1 description: Translation bundles to update responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/actions/deleteTranslations: post: description: Deletes current tenant translations tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – translations properties: translations: type: array items: type: object allOf: – #/definitions/translationMetaData minimum: 1 description: Translations to delete responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /translation_hub/signals/importDefaultTranslations: post: description: Imports all content previously uploaded to the translation hub. This content is applied globally. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – language – format properties: id: type: string description: Identifier of the content uploaded, as returned by the requestImportTranslations query. language: type: string description: Language to which import translations. format: type: string allOf: – #/definitions/fileFormat description: Source file format. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /translation_hub/signals/importTranslations: post: description: Imports all content previously uploaded to the translation hub identified by the given id. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – language – format properties: id: type: string description: Identifier of the content, as returned by the requestImportTranslations query. language: type: string description: Language to which import translations. format: type: string allOf: – #/definitions/fileFormat description: Source file format. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /translation_hub/events/bundlesChanged: post: description: Notifies bundles changes. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – bundles properties: bundles: type: array items: type: object allOf: – #/definitions/bundleHeader minimum: 1 description: Bundles changed responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN fileFormat: description: Supported translation file formats. type: string enum: – PROPERTIES – FLAT_JSON – XLIFF_1_2 – JSON userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente translationBundle: description: Translation bundle type: object required: – language – translations properties: language: type: string description: Bundle language translations: type: array items: type: object allOf: – #/definitions/translationData minimum: 1 description: Bundle translations translationData: description: Translation data type: object required: – translations properties: translationDomain: type: string description: Translations domain translationService: type: string description: Translations service translations: type: array items: type: object allOf: – #/definitions/translation minimum: 1 description: Translations translation: description: Translation type: object required: – key – value properties: key: type: string description: Translation key value: type: string description: Translated value translationMetaData: description: Translation data type: object required: – keys properties: translationDomain: type: string description: Translations domain translationService: type: string description: Translations service keys: type: array items: type: string minimum: 1 description: Translation keys bundleFile: description: Bundle file information. type: object required: – language – url – overridden properties: language: type: string description: File language. url: type: string description: File URL. overridden: type: boolean description: Tenant overridden bundle. tenantUrl: type: string description: Custom translations file url translationInfo: description: Translations info. type: object required: – translationCount – domainsInfo properties: translationCount: type: integer format: int64 description: Total translation count. domainsInfo: type: array items: type: object allOf: – #/definitions/domainTranslationInfo minimum: 1 description: Domains translations info. domainTranslationInfo: description: Domain translations info. type: object required: – name – translationCount – servicesInfo properties: name: type: string description: Domain name. translationCount: type: integer format: int64 description: Domain translation count. servicesInfo: type: array items: type: object allOf: – #/definitions/serviceTranslationInfo minimum: 1 description: Domains translations info. serviceTranslationInfo: description: Service translations info. type: object required: – name – translationCount properties: name: type: string description: Service name. translationCount: type: integer format: int64 description: Service translation count. bundleHeader: description: Bundle header type: object required: – language properties: domainName: type: string description: Bundle domain. If not informed, consider all services. serviceName: type: string description: Bundle service. if not informed, consider all domain services. language: type: string description: Bundle language. listServiceItem: description: type: object required: – count – overriddenCount properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço count: type: integer format: int64 description: Quantidade de chaves existes com o valor padrão overriddenCount: type: integer format: int64 description: Quantidade de chaves sobrescritas language: description: Registro de idioma type: object required: – tag – name properties: tag: type: string description: Identificador do idioma name: type: string description: Nome traduzido do idioma notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE