2.0info: 3.10.1 frontend_updater description: Atualizador de frontends x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: frontend_updater 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: /frontend_updater/queries/listOrigins: post: description: Lista as origens existentes de todos os tipos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/origin minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as origens existentes de todos os tipos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/origin minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/listTargets: post: description: Lista os destinos existentes de todos os tipos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/target minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os destinos existentes de todos os tipos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/target minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/getOrigin: post: description: Retorna as informações básicas de uma origem tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da origem responses: 200: description: Ok schema: type: object allOf: – #/definitions/origin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas de uma origem tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador da origem in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/origin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/listDeploy: post: description: Lista as implantações/atualizações realizadas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/deployInfo minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as implantações/atualizações realizadas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/deployInfo minimum: 1 description: A página de resultados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/listFrontends: post: description: Lista todos os frontends de uma determinada origem. Os resultados são paginados e é possível informar um filtro para limitar o retorno.\n Existe um cache da lista de frontends, para atualizar o cache chame a primitiva updateFrontendsListCache. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – originId properties: originId: type: string description: Id da origem dos frontends. page: type: integer format: int64 description: Índice da página. A primeira página corresponde ao índice 1. minimum: 1 limit: type: integer format: int64 description: Quantidade de frontends. filter: type: string description: Lista os frontends que contenham este texto no app/domínio/serviço. Se não for informado lista todos. responses: 200: description: Ok schema: type: object required: – frontends – total properties: frontends: type: array items: type: object allOf: – #/definitions/frontend minimum: 1 description: Frontends listados. total: type: integer format: int64 description: Quantidade total de frontends. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os frontends de uma determinada origem. Os resultados são paginados e é possível informar um filtro para limitar o retorno.\n Existe um cache da lista de frontends, para atualizar o cache chame a primitiva updateFrontendsListCache. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: originId description: Id da origem dos frontends. in: query required: true type: string – name: page description: Índice da página. A primeira página corresponde ao índice 1. in: query type: integer format: int64 – name: limit description: Quantidade de frontends. in: query type: integer format: int64 – name: filter description: Lista os frontends que contenham este texto no app/domínio/serviço. Se não for informado lista todos. in: query type: string responses: 200: description: Ok schema: type: object required: – frontends – total properties: frontends: type: array items: type: object allOf: – #/definitions/frontend minimum: 1 description: Frontends listados. total: type: integer format: int64 description: Quantidade total de frontends. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/listVersionsOfFrontend: post: description: Retorna uma lista com todas as versões de um frontend. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – originId – appName – domainName – serviceName properties: originId: type: string description: Id da origem do frontend. appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend responses: 200: description: Ok schema: type: object required: – versions properties: versions: type: array items: type: string minimum: 1 description: Lista com as versões do frontend solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todas as versões de um frontend. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: originId description: Id da origem do frontend. in: query required: true type: string – name: appName description: Nome do app do frontend in: query required: true type: string – name: domainName description: Nome do domínio do frontend in: query required: true type: string – name: serviceName description: Nome do serviço do frontend in: query required: true type: string responses: 200: description: Ok schema: type: object required: – versions properties: versions: type: array items: type: string minimum: 1 description: Lista com as versões do frontend solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/getFrontend: post: description: Retorna informações do frontend tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – identifiers properties: identifiers: type: array items: type: object allOf: – #/definitions/frontendIdentifier minimum: 1 description: Identificadores dos frontends responses: 200: description: Ok schema: type: object required: – frontends properties: frontends: type: array items: type: object allOf: – #/definitions/frontendInformation minimum: 1 description: As informações dos frontends requisitados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/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 /frontend_updater/queries/exportOriginS3: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/exportTargetS3: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/exportTargetFileSystem: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /frontend_updater/actions/insertDeploy: post: description: Realiza uma nova implantação de forma assíncrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – originId – targetId – appName – domainName – serviceName – version – alias properties: originId: type: string description: Informações da origem targetId: type: string description: Informações do destino appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string maxLength: 255 description: Versão do frontend implantado alias: type: string description: Alias do frontend publicado moduleId: type: string description: Id do modulo ao qual o frontend deve ser associado.\n Quando essa propriedade é informada significa que o\n frontend que está sendo implantado é novo e ainda não\n tem o arquivo config.json associado ao seu módulo do menu responses: 200: description: Ok schema: type: object required: – deployId properties: deployId: type: string description: Identificador único da implantação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/updateDeploy: post: description: Realiza uma atualização de um frontend implantado de forma assíncrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – deployId – version properties: deployId: type: string description: Identificador único da implantação type: string maxLength: 255 description: Versão à qual se deseja realizar a atualização responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/updateFrontendsListCache: post: description: Atualiza o cache da lista de frontends de uma origem específica. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – originId properties: originId: type: string description: ID da origem dos frontends. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/doDeploy: post: description: Realiza o deploy de um frontend. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – appName – domainName – serviceName – version – originId – targetId – alias properties: appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string maxLength: 255 description: Versão do frontend que será implantada currentVersion: type: string maxLength: 255 description: Versão atual do frontend que está implantado. Esta informação é usada para fazer o rollback caso ocorra erro no deploy. originId: type: string description: Identificador único da origem do frontend targetId: type: string description: Identificador único do destino onde o frontend será implantado alias: type: string description: Alias (nome) do frontend implantado responses: 200: description: Ok schema: type: object required: – status – message properties: status: type: string allOf: – #/definitions/frontendDeployStatus description: Status final da implantação message: type: string description: Mensagem do resultado da implantação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/importOriginS3: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/importTargetS3: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/actions/importTargetFileSystem: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/signals/undeploy: post: description: Remove uma implantação de forma assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – frontends properties: frontends: type: array items: type: object allOf: – #/definitions/undeployFrontend minimum: 1 description: Frontends para serem removidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /frontend_updater/signals/insertDeploys: post: description: Realiza uma a implantação de uma lista de serviços de forma assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – installVersions properties: installVersions: type: array items: type: object allOf: – #/definitions/installVersion minimum: 1 description: Informações da origem responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /frontend_updater/signals/updateFrontends: post: description: Atualiza o cache da lista de frontends de uma origem específica. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – originId properties: originId: type: string description: ID da origem dos frontends. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/originS3: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/originS3 responses: 200: description: The created resource schema: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/originS3 responses: 200: description: The created resource schema: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/originS3/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/originS3 responses: 200: description: Ok schema: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/originS3 responses: 200: description: Ok schema: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/originS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/originS3/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/originS3 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetS3: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/targetS3 responses: 200: description: The created resource schema: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/targetS3 responses: 200: description: The created resource schema: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetS3/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/targetS3 responses: 200: description: Ok schema: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/targetS3 responses: 200: description: Ok schema: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/targetS3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetS3/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/targetS3 responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetFileSystem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/targetFileSystem responses: 200: description: The created resource schema: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/targetFileSystem responses: 200: description: The created resource schema: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetFileSystem/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/targetFileSystem responses: 200: description: Ok schema: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/targetFileSystem responses: 200: description: Ok schema: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/targetFileSystem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frontend_updater/entities/targetFileSystem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/targetFileSystem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: deployAction: description: Estado da implantação, se é nova ou atualização type: string enum: – CREATE – UPDATE originType: description: Os tipos de origem dos arquivos de frontend type: string enum: – S3 targetType: description: Os tipos de destino dos arquivos de frontend type: string enum: – S3 – FILE_SYSTEM frontendDeployStatus: description: Contém os status possíveis após uma implantação type: string enum: – OK – ROLLBACK_OK – ROLLBACK_ERROR – ERROR dependencyStateInfo: description: Estados em que uma dependencia de um deploy pode estar type: string enum: – OK – MAJOR_CHANGED – UNSUPPORTED – UNKNOWN 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR deployedFrontend: description: type: object required: – appName – domainName – serviceName – version – alias – message – status – action properties: appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string description: Versão do frontend que foi implantada alias: type: string description: Alias (nome) do frontend message: type: string description: O resultado da atualização status: type: string allOf: – #/definitions/frontendDeployStatus description: Status. Contém a mensagem de erro em caso de problemas na atualização ou rollback action: type: string allOf: – #/definitions/deployAction description: Indica se o frontend foi criado ou atualizado origin: description: Informações básicas de todas as origens type: object required: – id – name – type properties: id: type: string description: Identificador único da origem name: type: string description: Nome da origem type: type: string allOf: – #/definitions/originType description: Tipo da origem target: description: Informações básicas de todos os destinos type: object required: – id – name – type – baseUrl properties: id: type: string description: Identificador único do destino name: type: string description: Nome do destino type: type: string allOf: – #/definitions/targetType description: Tipo do destino baseUrl: type: string description: Url base de onde os frontends são deployados. Essa url é usada para ajustar o arquivo config.json frontend: description: Contém as informações e versões de um frontend. type: object required: – id – appName – domainName – serviceName – versions properties: id: type: string description: Identificador único do frontend appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend versions: type: array items: type: string minimum: 1 description: Lista com todas as versões do frontend deploy: description: Representa as informações de uma implantação (Não está sendo utilizado o ID do frontend pois ele é gerado novamente na limpeza do cache). discriminator: _discriminator type: object required: – origin – target – appName – domainName – serviceName – version – alias – _discriminator properties: origin: type: object allOf: – #/definitions/origin description: Informações da origem target: type: object allOf: – #/definitions/target description: Informações do destino appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string description: Versão do frontend implantado alias: type: string description: Alias do frontend publicado _discriminator: type: string description: deployInfo: description: Representa as informações das implantações/atualizações realizadas allOf: – #/definitions/deploy – type: object required: – deployId – deployDate – dependencies properties: deployId: type: string description: Identificador único da implantação ou atualização deployDate: type: string format: date-time description: Data e hora em que foi realizada a implantação ou atualização dependencies: type: array items: type: object allOf: – #/definitions/deployDependencyInfo minimum: 1 description: Lista de dependências vinculadas ao deploy deployDependencyInfo: description: Representa uma dependencia de uma implantação type: object required: – domainName – serviceName – supportedVersion – availableVersion – state properties: domainName: type: string description: Dominio da dependencia serviceName: type: string description: Serviço da dependencia supportedVersion: type: string description: Versão que o frontend suporta availableVersion: type: string description: Versão disponivel no ambiente cloud state: type: string allOf: – #/definitions/dependencyStateInfo description: Estado da dependencia conforme calculo sob a versão semantica frontendIdentifier: description: type: object required: – domainName – serviceName – appName properties: domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend appName: type: string description: Nome do app do frontend route: type: string description: Nome da rota interna no frontend frontendInformation: description: Informações do frontend deployado type: object required: – domainName – serviceName – appName – route – url – embeddedURL – currentVersion properties: domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend appName: type: string description: Nome do app do frontend route: type: string description: Nome da rota interna no frontend url: type: string description: URL base do local de deploy embeddedURL: type: string description: URL base concatenada com o caminho do do frontend currentVersion: type: string description: Versão atual undeployFrontend: description: type: object required: – domainName – serviceName – appName properties: domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend appName: type: string description: Nome do app do frontend installVersion: description: Objeto que representa a instalação de um front-end type: object required: – originId – targetId – appName – domainName – serviceName – version – alias properties: originId: type: string description: Informações da origem targetId: type: string description: Informações do destino appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string description: Versão do frontend implantado alias: type: string description: Alias do frontend publicado moduleId: type: string description: Id do modulo ao qual o frontend deve ser associado.\n Quando essa propriedade é informada significa que o\n frontend que está sendo implantado é novo e ainda não\n tem o arquivo config.json associado ao seu módulo do menu frontendUpdatedList: description: type: object required: – appName – domainName – serviceName – version – alias properties: appName: type: string description: Nome do app do frontend domainName: type: string description: Nome do domínio do frontend serviceName: type: string description: Nome do serviço do frontend type: string description: Versão do frontend que foi implantada alias: type: string description: Alias (nome) do frontend originS3: description: Origem dos arquivos de frontend no Amazon S3 type: object required: – id – name – bucketName properties: id: type: string description: Identificador único da origem name: type: string description: Nome da origem bucketName: type: string description: Identificador do bucket da S3 accessKey: type: string description: Chave de acesso ao Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_ACCESS_KEY_ID secretKey: type: string description: Secret de acesso ao Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_SECRET_KEY region: type: string description: Região do Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_REGION targetS3: description: Destino dos arquivos de frontend no Amazon S3 type: object required: – id – name – bucketName – baseUrl – distributionId properties: id: type: string description: Identificador único do destino name: type: string description: Nome do destino bucketName: type: string description: Identificador do bucket no Amazon S3 baseUrl: type: string maxLength: 2000 description: Url base de onde os frontends são deployados. Essa url é usada para ajustar o arquivo config.json distributionId: type: string description: Id da distribuição do CloudFront accessKey: type: string description: Chave de acesso ao Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_ACCESS_KEY_ID secretKey: type: string description: Secret de acesso ao Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_SECRET_KEY region: type: string description: Região do Amazon S3, quando não informado irá utilizar a variável de ambiente AWS_REGION targetFileSystem: description: Destino dos arquivos em um sistema de arquivos local type: object required: – id – name – baseUrl – folderRootName – folderLinkName properties: id: type: string description: Identificador único do destino name: type: string description: Nome do destino baseUrl: type: string maxLength: 2000 description: Url base de onde os frontends são deployados. Essa url é usada para ajustar o arquivo config.json folderRootName: type: string description: Nome do diretório raiz dos frontends descompactados folderLinkName: type: string description: Nome da pasta onde fica o link simbólico para os arquivos descompactados 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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