platform

Gerenciamento de funções

31 views 20/08/2019 19/11/2019 integrador 0

2.0info: 5.0.1 Gerenciamento de funções description: Responsável pelas funções na plataforma Senior X x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: functions contact: name: Senior X Platform url: http://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: /functions/queries/getEndpointStages: post: description: Retorna as etapas de configuração do endpoint tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – stages properties: stages: type: array items: type: object allOf: – #/definitions/endpointStage minimum: 1 description: Etapas de configuração do endpoint default: description: Error response schema: #/definitions/genericError get: description: Retorna as etapas de configuração do endpoint tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – stages properties: stages: type: array items: type: object allOf: – #/definitions/endpointStage minimum: 1 description: Etapas de configuração do endpoint default: description: Error response schema: #/definitions/genericError /functions/queries/listFunctions: post: description: Lista todas as funções do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/persistedFunction minimum: 1 description: Lista com todas as funções do tenant default: description: Error response schema: #/definitions/genericError get: description: Lista todas as funções do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/persistedFunction minimum: 1 description: Lista com todas as funções do tenant default: description: Error response schema: #/definitions/genericError /functions/queries/getFunction: post: description: Retorna informações detalhadas de uma função tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name – domainName – serviceName properties: name: type: string description: Nome da primitiva domainName: type: string description: Nome do dominio serviceName: type: string description: Nome do servico responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedFunction default: description: Error response schema: #/definitions/genericError get: description: Retorna informações detalhadas de uma função tags: – Queries x-senior-visibility: PUBLIC parameters: – name: name description: Nome da primitiva in: query required: true type: string – name: domainName description: Nome do dominio in: query required: true type: string – name: serviceName description: Nome do servico in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedFunction default: description: Error response schema: #/definitions/genericError /functions/queries/searchFunction: post: description: Retorna informações detalhadas das funções encontradas contendo o nome passado por parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: parte do nome da função responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/persistedFunction minimum: 1 description: Lista com as funções encontradas default: description: Error response schema: #/definitions/genericError get: description: Retorna informações detalhadas das funções encontradas contendo o nome passado por parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: name description: parte do nome da função in: query required: true type: string responses: 200: description: Ok schema: type: object required: – functions properties: functions: type: array items: type: object allOf: – #/definitions/persistedFunction minimum: 1 description: Lista com as funções encontradas default: description: Error response schema: #/definitions/genericError /functions/queries/getEnvironmentInformation: post: description: Retorna as informações do ambiente do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/environmentInformation default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do ambiente do tenant tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/environmentInformation default: description: Error response schema: #/definitions/genericError /functions/queries/getFunctionsAccess: post: description: Retorna informações que o tenant necessita para chamar as funções via HTTP tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/functionsAccess default: description: Error response schema: #/definitions/genericError get: description: Retorna informações que o tenant necessita para chamar as funções via HTTP tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/functionsAccess default: description: Error response schema: #/definitions/genericError /functions/queries/listSupportedRuntimes: post: description: Retorna os runtimes suportados pelas plataforma tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – runtimes properties: runtimes: type: array items: type: string minimum: 1 description: Lista com todos o runtimes de função suportadas default: description: Error response schema: #/definitions/genericError get: description: Retorna os runtimes suportados pelas plataforma tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – runtimes properties: runtimes: type: array items: type: string minimum: 1 description: Lista com todos o runtimes de função suportadas default: description: Error response schema: #/definitions/genericError /functions/queries/listDevelopers: post: description: Retorna todos os desenvolvedores do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Termo a ser buscado offset: type: integer format: int64 description: size: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedDeveloper minimum: 1 description: Lista de todos os desenvolvedores default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os desenvolvedores do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: filter description: Termo a ser buscado in: query required: true type: string – name: offset description: in: query type: integer format: int64 – name: size description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedDeveloper minimum: 1 description: Lista de todos os desenvolvedores default: description: Error response schema: #/definitions/genericError /functions/queries/requestFunctionUpload: post: description: Retorna o caminho disponibilizado para o upload do código da função tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – functionName – fileName properties: functionName: type: string description: Nome da função fileName: type: string description: Nome do arquivo para fazer upload responses: 200: description: Ok schema: type: object required: – uploadUrl – uploadId properties: uploadUrl: type: string description: Url de destino para o upload do código da função uploadId: type: string description: Identificador do upload default: description: Error response schema: #/definitions/genericError get: description: Retorna o caminho disponibilizado para o upload do código da função tags: – Queries x-senior-visibility: PUBLIC parameters: – name: functionName description: Nome da função in: query required: true type: string – name: fileName description: Nome do arquivo para fazer upload in: query required: true type: string responses: 200: description: Ok schema: type: object required: – uploadUrl – uploadId properties: uploadUrl: type: string description: Url de destino para o upload do código da função uploadId: type: string description: Identificador do upload default: description: Error response schema: #/definitions/genericError /functions/queries/getStages: post: description: Requisita os status dos processos executados pela criação do environment tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/stages default: description: Error response schema: #/definitions/genericError get: description: Requisita os status dos processos executados pela criação do environment tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/stages default: description: Error response schema: #/definitions/genericError /functions/queries/retrieveDeveloper: post: description: localizar um desenvolvedor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do desenvolvedor responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedDeveloper default: description: Error response schema: #/definitions/genericError get: description: localizar um desenvolvedor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador único do desenvolvedor in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedDeveloper default: description: Error response schema: #/definitions/genericError /functions/queries/retrieveConsultant: post: description: localizar um consultor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID do consultor responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedConsultant default: description: Error response schema: #/definitions/genericError get: description: localizar um consultor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID do consultor in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedConsultant default: description: Error response schema: #/definitions/genericError /functions/queries/listConsultants: post: description: Lista os consultores cadastrados na plataforma tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Termo a ser buscado offset: type: integer format: int64 description: size: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedConsultant minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Lista os consultores cadastrados na plataforma tags: – Queries x-senior-visibility: PUBLIC parameters: – name: filter description: Termo a ser buscado in: query required: true type: string – name: offset description: in: query type: integer format: int64 – name: size description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedConsultant minimum: 1 description: default: description: Error response schema: #/definitions/genericError /functions/queries/listTenantConsultants: post: description: Lista os consultores convidados do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Termo a ser buscado offset: type: integer format: int64 description: size: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedTenantConsultant minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Lista os consultores convidados do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: filter description: Termo a ser buscado in: query required: true type: string – name: offset description: in: query type: integer format: int64 – name: size description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/persistedTenantConsultant minimum: 1 description: default: description: Error response schema: #/definitions/genericError /functions/queries/searchKnowledge: post: description: Busca os conhecimentos pelo titulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – search properties: search: type: string description: Termo utilizado para realizar a busca dos conhecimentos responses: 200: description: Ok schema: type: object required: – persistedKnowledge properties: persistedKnowledge: type: array items: type: object allOf: – #/definitions/persistedKnowledge minimum: 1 description: Lista de conhecimentos encontrados na busca default: description: Error response schema: #/definitions/genericError get: description: Busca os conhecimentos pelo titulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo utilizado para realizar a busca dos conhecimentos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – persistedKnowledge properties: persistedKnowledge: type: array items: type: object allOf: – #/definitions/persistedKnowledge minimum: 1 description: Lista de conhecimentos encontrados na busca default: description: Error response schema: #/definitions/genericError /functions/queries/searchWorkProducts: post: description: Busca os produtos pelo titulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – search properties: search: type: string description: Texto utilizado para realizar a busca dos produtos responses: 200: description: Ok schema: type: object required: – persistedWorkProduct properties: persistedWorkProduct: type: array items: type: object allOf: – #/definitions/persistedWorkProduct minimum: 1 description: Lista de produtos encontrados na busca default: description: Error response schema: #/definitions/genericError get: description: Busca os produtos pelo titulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Texto utilizado para realizar a busca dos produtos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – persistedWorkProduct properties: persistedWorkProduct: type: array items: type: object allOf: – #/definitions/persistedWorkProduct minimum: 1 description: Lista de produtos encontrados na busca default: description: Error response schema: #/definitions/genericError /functions/queries/getFileSystemStatus: post: description: Verifica se o file system já foi criado e está pronto para ser usado tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/fileSystemAccessStatus description: Status de liberação do file system default: description: Error response schema: #/definitions/genericError get: description: Verifica se o file system já foi criado e está pronto para ser usado tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/fileSystemAccessStatus description: Status de liberação do file system default: description: Error response schema: #/definitions/genericError /functions/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: 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: default: description: Error response schema: #/definitions/genericError /functions/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 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 default: description: Error response schema: #/definitions/genericError /functions/actions/configureEndpoint: post: description: Gatilho para inicio da configuração de um endpoint. No modo padrão, caso o endpoint já esteja configurado, retorna o mesmo.\n O processo é assincrono, e caso o status de retorno seja CREATING, a configuração com o provedor nuvem foi iniciado tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status – stages properties: status: type: string allOf: – #/definitions/endpointStatus description: Situação atual após inicio, quando necessário, da configuração stages: type: array items: type: object allOf: – #/definitions/endpointStage minimum: 1 description: Etapas de configuração do endpoint default: description: Error response schema: #/definitions/genericError /functions/actions/migrateEndpoint: post: description: Realiza a migração de ambiente (endpoint) configurado em um ambiente nuvem para outro ambiente nuvem. A execução desta primitiva exige que\n as configurações apontem para um ambiente diferente do atual ativo, caso exista. Caso ainda não exista ambiente ativo, prefira utilizar a\n primitiva configureEndpoint. Caso algum erro aconteça na execução desta primitiva, ajuste o que for necessário e execute novamente até que o\n o procedimento seja concluído com sucesso tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/endpointStatus description: Situação atual após inicio da migração default: description: Error response schema: #/definitions/genericError /functions/actions/createFunction: post: description: Cria uma função tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/functionDef responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedFunction default: description: Error response schema: #/definitions/genericError /functions/actions/applyFunctionUpload: post: description: Aplica o código da função que foi feita upload tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – functionName – uploadId properties: functionName: type: string description: Nome da função uploadId: type: string description: Identificador do upload responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem com o status da requisição default: description: Error response schema: #/definitions/genericError /functions/actions/createEnvironment: post: description: Inicia o processo de criação do environment tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedEnvironment default: description: Error response schema: #/definitions/genericError /functions/actions/createDeveloper: post: description: Inicia o processo de criação do desenvolvedor tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/developerInfo responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedDeveloper default: description: Error response schema: #/definitions/genericError /functions/actions/toggleDeveloperStatus: post: description: Ativa/Desativa um developer tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – developerId properties: developerId: type: string description: Id do usuário na plataforma SeniorX responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: mensagem de retorno default: description: Error response schema: #/definitions/genericError /functions/actions/toggleConsultantStatus: post: description: Ativa/Desativa um developer tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – consultantId properties: consultantId: type: string description: Id do consultor responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: default: description: Error response schema: #/definitions/genericError /functions/actions/deleteDeveloper: post: description: Deletar um desenvolvedor tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – developerId properties: developerId: type: string description: Identificador único do desenvolvedor responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: mensagem de retorno default: description: Error response schema: #/definitions/genericError /functions/actions/createUser: post: description: Inicia o processo de criação do usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/userInfo responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedUser default: description: Error response schema: #/definitions/genericError /functions/actions/attachUserToEnvironment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: default: description: Error response schema: #/definitions/genericError /functions/actions/detachUserFromEnvironment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: default: description: Error response schema: #/definitions/genericError /functions/actions/createConsultant: post: description: Cria um consultor e a conta AWS associada ao mesmo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/consultantInfo responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedConsultant default: description: Error response schema: #/definitions/genericError /functions/actions/updateConsultant: post: description: Atualiza os dados do consultor tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/consultantInfo responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedConsultant default: description: Error response schema: #/definitions/genericError /functions/actions/createKnowledge: post: description: Cria um novo conhecimento tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/newKnowledge responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedKnowledge default: description: Error response schema: #/definitions/genericError /functions/actions/createWorkProduct: post: description: Cria um novo produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/newWorkProduct responses: 200: description: Ok schema: type: object allOf: – #/definitions/persistedWorkProduct default: description: Error response schema: #/definitions/genericError /functions/actions/inviteConsultant: post: description: Convidar um consultor para participar do desenvolvimento do ambiente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – consultantId – platformId – platformUsername properties: consultantId: type: string description: Id do consultor platformId: type: string description: Id do usuário na plataforma platformUsername: type: string description: Nome do usuário na plataforma responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: default: description: Error response schema: #/definitions/genericError /functions/actions/requestAccessToFileSystem: post: description: Executa processo que permite acesso ao file system da instância do environment do Cloud 9 tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Estado da criação do ambiente default: description: Error response schema: #/definitions/genericError /functions/actions/addFileToInstance: post: description: Cria o arquivo passado dentro da função no environment do Cloud 9 tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName – filePath – functionName properties: fileName: type: string description: Nome do arquivo a ser criado filePath: type: string description: Caminho para o arquivo, deve estar público functionName: type: string description: Nome do função para adicionar o arquivo responses: 200: description: Ok schema: type: object required: – createdFileName properties: createdFileName: type: string description: Arquivo que foi criado default: description: Error response schema: #/definitions/genericError /functions/actions/importFunctionToEnvironment: post: description: Endpoint para executar o import command de uma function criada, para adicioná-la no ambiente Cloud9 tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – functionName properties: functionName: type: string description: Nome da função responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError definitions: stageStatus: description: Status da etapa de configuração type: string enum: – SUCCESS – ERROR functionStatus: description: Situações possiveis de uma função persistida type: string enum: – INITIAL – CREATING – CREATION_ERROR – CREATED – INTEGRATED – INTEGRATION_ERROR environmentStatus: description: Situações possiveis de um environment type: string enum: – CREATING – CREATED – CREATION_ERROR – INTEGRATED – INTEGRATION_ERROR endpointStatus: description: Situações possíveis de um endpoint type: string enum: – CREATING – CREATION_ERROR – ACTIVATED – DEACTIVATED configurationStatus: description: Status dos estágios de configuração do ambiente type: string enum: – PENDING – CREATING – ERROR – DONE methodHook: description: Definição do gatilho que será chamada a função type: string enum: – BEFORE – AFTER – INTERCEPT – WEB_HOOK fileSystemAccessStatus: description: Status da liberação de acesso ao filesystem type: string enum: – CREATING – CREATED – CREATION_ERROR – NOT_STARTED 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 endpointStage: description: Etapa de configuração do endpoint type: object required: – description – status – endTime properties: description: type: string description: Descrição da etapa message: type: string description: Mensagem correspondente ao status da etapa status: type: string allOf: – #/definitions/stageStatus description: Status da etapa endTime: type: string format: date-time description: Hora que a etapa foi finalizada functionsAccess: description: Informações de acesso para chamadas de função via HTTP type: object required: – endpoint – accessKey properties: endpoint: type: string description: URL de acesso para chamadas de funções do tenant accessKey: type: string description: Chave de acesso do tenant functionDef: description: Função da plataforma discriminator: _discriminator type: object required: – name – domainName – serviceName – primitiveName – _discriminator properties: name: type: string description: Nome da função description: type: string description: Descrição mais detalhada sobre a função, o que pode incluir seu modo de funcionamento e possíveis aplicações runtime: type: string description: Runtime para execução da função. O valor default é nodejs8.10. Utilize a primitiva listSupportedRuntimes para descobrir os runtimes possíveis default: nodejs8.10 memorySize: type: integer format: int64 description: Quantidade de memória que a função poderá alocar para suas execuções. O valor deve ser em MB e múltiplo de 64, e seu default é 128 minimum: 64 maximum: 1024 default: 128 handler: type: string description: Nome da função interna do código que será executada pela função Senior X default: index.handler methodHook: type: string allOf: – #/definitions/methodHook description: Quando o método deverá ser acionado (Antes, Depois ou Interceptar) domainName: type: string description: Nome do dominio da primitiva serviceName: type: string description: Nome do serviço da primitiva primitiveName: type: string description: Nome da primitiva _discriminator: type: string description: persistedFunction: description: Função persistida na base de dados, o que pode conter informações locais geradas pela aplicação e também informações adicionais do provedor nuvem allOf: – #/definitions/functionDef – type: object properties: status: type: string allOf: – #/definitions/functionStatus description: Situação da função endpoint: type: string description: endpoint para acesso cloud functionName: type: string description: nome da função importCommand: type: string description: Comando para importar a função no ambiente cloud9 persistedEnvironment: description: Environment criado via AWS API para o tenant type: object required: – name – environmentId – status properties: name: type: string description: Nome dado ao environment environmentId: type: string description: Id do environment gerado pela AWS para posterior consultas status: type: string allOf: – #/definitions/environmentStatus description: Status do processo de criação do environment stages: description: Status dos processos executados pela criação do environment type: object required: – name – startStatus – environmentStatus – permissionStatus – integrationStatus properties: name: type: string description: Nome dado ao environment startStatus: type: string allOf: – #/definitions/configurationStatus description: Status do inicio de todas as criações environmentStatus: type: string allOf: – #/definitions/configurationStatus description: Status da criação do environment permissionStatus: type: string allOf: – #/definitions/configurationStatus description: Status da criação das permissões integrationStatus: type: string allOf: – #/definitions/configurationStatus description: Status da criação da integração environmentInformation: description: Informações do ambiente type: object required: – id – name – arn – url properties: id: type: string description: Id do ambiente name: type: string description: Nome do ambiente arn: type: string description: ARN do ambiente url: type: string description: URL do ambiente userInfo: description: Informações utilizadas na criação de um usuário type: object required: – name – fullName – email – plataformId properties: name: type: string description: UserName do usuário na plataforma fullName: type: string description: Nome completo do usuário email: type: string description: Email do usuário plataformId: type: string description: Id da plataforma Seniox developerInfo: description: Informações utilizadas na criação de um desenvolvedor type: object required: – name – email – plataformId properties: name: type: string description: UserName do usuário na plataforma seniorX fullName: type: string description: Nome completo do usuário na plataforma seniorX email: type: string description: Email do usuário na plataforma seniorX plataformId: type: string description: Id da plataforma Seniox persistedUser: description: Usuário persistido na base de dados, o que pode conter informações locais geradas pela aplicação e também informações adicionais do provedor nuvem type: object properties: arn: type: string description: Amazon resource name do usuário email: type: string description: Email do usuario name: type: string description: Nome do usuário awsUserId: type: string description: Id do usuário na aws persistedDeveloper: description: Desenvolvedor persistido na base de dados, contêm informações do provedor da nuvem e dados adicionais gerados pela aplicação type: object required: – developerId properties: developerId: type: string description: Id do developer arn: type: string description: Amazon resource name do usuário awsUserId: type: string description: Id do usuário na aws name: type: string description: Nome do usuário email: type: string description: Email do usuario plataformId: type: string description: Id da plataforma seniorx status: type: boolean description: Status de ativo/inativo do developer default: false newWorkProduct: description: Novo produto a ser cadastrado para uso posterior no cadastro do consultor type: object required: – title properties: type: string description: Titulo do conhecimento workProduct: description: Produtos os quais o consultor atua type: object required: – id properties: id: type: string description: ID do produto persistedWorkProduct: description: Produto de trabalho cadastrado type: object required: – id – title – description properties: id: type: string description: ID do produto persistido type: string description: Titulo do produto description: type: string description: Descrição do produto newKnowledge: description: Novo conhecimento a ser cadastrado para uso posterior no cadastro do consultor type: object required: – title properties: type: string description: Titulo do conhecimento knowledge: description: Conhecimento tecnico o qual o consultor possui. type: object required: – id properties: id: type: string description: ID do conhecimento persistedKnowledge: description: Conhecimento cadastrado type: object required: – id – title – description properties: id: type: string description: ID do conhecimento persistido type: string description: Titulo do conhecimento description: type: string description: Descrição do conhecimento consultantInfo: description: Dados do consultor a ser criado type: object required: – name – email – state – city properties: id: type: string description: ID do consultor name: type: string description: Nome do consultor email: type: string description: Email a ser utilizada na criação da conta state: type: string description: Estado city: type: string description: Cidade workProducts: type: array items: type: object allOf: – #/definitions/workProduct description: Produtos de trabalho knowledge: type: array items: type: object allOf: – #/definitions/knowledge description: Conhecimentos do consultor persistedConsultant: description: Dados do consultor criado type: object required: – id – name – email – city – state – workProducts – knowledge properties: id: type: string description: name: type: string description: Nome do consultor email: type: string description: Email utilizado para criação do usuario city: type: string description: state: type: string description: workProducts: type: array items: type: object allOf: – #/definitions/persistedWorkProduct minimum: 1 description: knowledge: type: array items: type: object allOf: – #/definitions/persistedKnowledge minimum: 1 description: persistedTenantConsultant: description: type: object required: – id – name – platformUsername – email – attached properties: id: type: string description: name: type: string description: Nome do consultor platformUsername: type: string description: Nome do usuário da plataforma associado ao consultor email: type: string description: Email utilizado para criação do usuario attached: type: boolean description: Status do consultor 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

Este artigo foi útil para você?

Leave A Comment