diff --git a/dictionary/variableIncomesGetInvestmentsInvestmentIdBalances_v1.csv b/dictionary/variableIncomesGetInvestmentsInvestmentIdBalances_v1.csv index 24bf4a4bc..722a9602f 100644 --- a/dictionary/variableIncomesGetInvestmentsInvestmentIdBalances_v1.csv +++ b/dictionary/variableIncomesGetInvestmentsInvestmentIdBalances_v1.csv @@ -11,5 +11,5 @@ /data/blockedBalance/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL; /data/quantity;quantity;Quatidade total do ativo na data de referência.;Texto;25;Obrigatório;^-?\d{1,15}\.\d{2,8}$;;1;1;"";Não permitido;string;1000.00000004; /data/closingPrice;closingPrice;Preço de fechamento da data de referência.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/closingPrice/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; +/data/closingPrice/amount;amount;Valor relacionado ao objeto.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; /data/closingPrice/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL; diff --git a/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv index cb1693df4..e5bf42a12 100644 --- a/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv +++ b/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv @@ -32,7 +32,7 @@ OUTROS";1;1;"";Não permitido;string;DIVIDENDOS; [Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'transactionType' for preenchido com os valores 'COMPRA' ou 'VENDA'. ";Objeto;;Condicional;;;0;1;" Campo de preenchimento obrigatório pelas participantes quando o campo 'transactionType' for preenchido com os valores 'COMPRA' ou 'VENDA'. ";Não permitido;object;; -/data/transactionUnitPrice/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; +/data/transactionUnitPrice/amount;amount;Valor relacionado ao objeto.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; /data/transactionUnitPrice/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL; /data/transactionQuantity;transactionQuantity;"Quantidade de ativos movimentados. diff --git a/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactions_v1.csv b/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactions_v1.csv index cb1693df4..e5bf42a12 100644 --- a/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactions_v1.csv +++ b/dictionary/variableIncomesGetInvestmentsInvestmentIdTransactions_v1.csv @@ -32,7 +32,7 @@ OUTROS";1;1;"";Não permitido;string;DIVIDENDOS; [Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'transactionType' for preenchido com os valores 'COMPRA' ou 'VENDA'. ";Objeto;;Condicional;;;0;1;" Campo de preenchimento obrigatório pelas participantes quando o campo 'transactionType' for preenchido com os valores 'COMPRA' ou 'VENDA'. ";Não permitido;object;; -/data/transactionUnitPrice/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; +/data/transactionUnitPrice/amount;amount;Valor relacionado ao objeto.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004; /data/transactionUnitPrice/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL; /data/transactionQuantity;transactionQuantity;"Quantidade de ativos movimentados. diff --git a/swagger-apis/variable-incomes/1.0.0-rc3.0.yml b/swagger-apis/variable-incomes/1.0.0-rc3.0.yml index 533872375..e458ebd77 100644 --- a/swagger-apis/variable-incomes/1.0.0-rc3.0.yml +++ b/swagger-apis/variable-incomes/1.0.0-rc3.0.yml @@ -599,8 +599,8 @@ components: type: string format: double description: Valor relacionado ao objeto. - maxLength: 20 - pattern: '^\d{1,15}\.\d{2,4}$' + maxLength: 21 + pattern: '^-?\d{1,15}\.\d{2,4}$' example: '1000.0004' currency: type: string @@ -708,8 +708,8 @@ components: type: string format: double description: Valor relacionado ao objeto. - maxLength: 20 - pattern: '^\d{1,15}\.\d{2,4}$' + maxLength: 21 + pattern: '^-?\d{1,15}\.\d{2,4}$' example: '1000.0004' currency: type: string @@ -794,8 +794,8 @@ components: type: string format: double description: Valor relacionado ao objeto. - pattern: '^\d{1,15}\.\d{2,4}$' - maxLength: 20 + pattern: '^-?\d{1,15}\.\d{2,4}$' + maxLength: 21 example: '1000.0004' currency: type: string @@ -1240,6 +1240,108 @@ components: maxLength: 3 example: BRL additionalProperties: false + ResponseErrorMetaSingle: + type: object + required: + - errors + properties: + errors: + type: array + minItems: 1 + maxItems: 13 + items: + type: object + required: + - code + - title + - detail + properties: + code: + description: Código de erro específico do endpoint + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + title: + description: Título legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + detail: + description: Descrição legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 2048 + meta: + $ref: '#/components/schemas/MetaOnlyRequestDateTime' + MetaOnlyRequestDateTime: + type: object + description: Meta informações referente à API requisitada. + required: + - requestDateTime + properties: + requestDateTime: + description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.' + type: string + maxLength: 20 + format: date-time + example: '2021-05-21T08:30:00Z' + ResponseErrorWithAbleAdditionalProperties: + type: object + required: + - errors + properties: + errors: + type: array + minItems: 1 + maxItems: 13 + items: + type: object + required: + - code + - title + - detail + properties: + code: + description: Código de erro específico do endpoint + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + title: + description: Título legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + detail: + description: Descrição legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 2048 + meta: + $ref: '#/components/schemas/MetaWithAbleAdditionalProperties' + MetaWithAbleAdditionalProperties: + type: object + description: Meta informações referente à API requisitada. + required: + - totalRecords + - totalPages + - requestDateTime + properties: + totalRecords: + type: integer + format: int32 + description: Número total de registros no resultado + example: 1 + totalPages: + type: integer + format: int32 + description: Número total de páginas no resultado + example: 1 + requestDateTime: + description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.' + type: string + maxLength: 20 + format: date-time + example: '2021-05-21T08:30:00Z' parameters: InvestmentId: name: investmentId @@ -1438,25 +1540,25 @@ components: content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' Forbidden: description: O token tem escopo incorreto ou uma política de segurança foi violada content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' GatewayTimeout: description: GATEWAY TIMEOUT - A requisição não foi atendida dentro do tempo limite estabelecido content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' InternalServerError: description: Ocorreu um erro no gateway da API ou no microsserviço content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' Locked: description: Locked content: @@ -1509,73 +1611,73 @@ components: content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' NotAcceptable: description: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' NotFound: description: O recurso solicitado não existe ou não foi implementado content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' TooManyRequests: description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' Unauthorized: description: Cabeçalho de autenticação ausente/inválido ou token inválido content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' UnprocessableEntity: description: 'A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' Default: description: Erro inesperado. content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' SiteIsOverloaded: description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/Locked/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorMetaSingle' BadRequestWithAdditionalProperties: description: 'A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' ForbiddenWithAdditionalProperties: description: O token tem escopo incorreto ou uma política de segurança foi violada content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' GatewayTimeoutWithAdditionalProperties: description: GATEWAY TIMEOUT - A requisição não foi atendida dentro do tempo limite estabelecido content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' InternalServerErrorWithAdditionalProperties: description: Ocorreu um erro no gateway da API ou no microsserviço content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' LockedWithAdditionalProperties: description: Locked content: @@ -1640,46 +1742,46 @@ components: content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' NotAcceptableWithAdditionalProperties: description: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' NotFoundWithAdditionalProperties: description: O recurso solicitado não existe ou não foi implementado content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' TooManyRequestsWithAdditionalProperties: description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' UnauthorizedWithAdditionalProperties: description: Cabeçalho de autenticação ausente/inválido ou token inválido content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' UnprocessableEntityWithAdditionalProperties: description: 'A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' DefaultWithAdditionalProperties: description: Erro inesperado. content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties' SiteIsOverloadedWithAdditionalProperties: description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.' content: application/json; charset=utf-8: schema: - $ref: '#/components/responses/LockedWithAdditionalProperties/content/application~1json%3B%20charset%3Dutf-8/schema' + $ref: '#/components/schemas/ResponseErrorWithAbleAdditionalProperties'