From 99332a564ab4362b509b28457c6ea665cd3d4465 Mon Sep 17 00:00:00 2001 From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com> Date: Thu, 13 Jul 2023 17:35:01 +0000 Subject: [PATCH 1/6] feat(Common): ORB-2863 - PC114 - page e page-size --- dictionary/getStatus_v2.csv | 17 +++ swagger-apis/common/2.0.0.yml | 203 +++++++++++++++++++++++++++++++++ swagger-apis/common/index.html | 5 +- 3 files changed, 223 insertions(+), 2 deletions(-) create mode 100644 dictionary/getStatus_v2.csv create mode 100644 swagger-apis/common/2.0.0.yml diff --git a/dictionary/getStatus_v2.csv b/dictionary/getStatus_v2.csv new file mode 100644 index 000000000..9bcd3c81c --- /dev/null +++ b/dictionary/getStatus_v2.csv @@ -0,0 +1,17 @@ +Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo +/data;data;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/status;status;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/status/code;code;"Condição atual da API: + * `OK` - A implementação é totalmente funcional + * `PARTIAL_FAILURE` - Um ou mais endpoints estão indisponíveis + * `UNAVAILABLE` - A implementação completa está indisponível + * `SCHEDULED_OUTAGE` - Uma interrupção anunciada está em vigor +";Texto;;Obrigatório;;"OK +PARTIAL_FAILURE +UNAVAILABLE +SCHEDULED_OUTAGE";1;1;"";Não permitido;string;OK; +/data/status/explanation;explanation;Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;;Obrigatório;;;1;1;"";Não permitido;string;Retorno com Sucesso; +/data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; +/data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;;Opcional;;;0;N;"";Não permitido;array;; diff --git a/swagger-apis/common/2.0.0.yml b/swagger-apis/common/2.0.0.yml new file mode 100644 index 000000000..641439eac --- /dev/null +++ b/swagger-apis/common/2.0.0.yml @@ -0,0 +1,203 @@ +openapi: 3.0.0 +info: + title: APIs OpenData do Open Finance Brasil + description: As APIs descritas neste documento são referentes as APIs da fase OpenData do Open Finance Brasil. + version: 2.0.0 + contact: + url: 'https://servicedesk.openbankingbrasil.org.br/Login.jsp?navLanguage=pt-BR' +servers: + - url: 'http://api.banco.com.br/open-banking/discovery/v1' +tags: +- name: "Discovery" +paths: + /status: + get: + tags: + - Discovery + summary: a descrição referente ao código de status retornado pelas APIs + description: " descrição referente ao código de status retornado pelas APIs" + operationId: "getStatus" + parameters: + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/pageSize" + responses: + '200': + description: código de status retornado pelas APIs + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseDiscoveryStatusList' + /outages: + get: + tags: + - Discovery + summary: a descrição referente ao código de status retornado pelas APIs + description: "a descrição referente ao código de status retornado pelas APIs" + operationId: "getOutage" + parameters: + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/pageSize" + responses: + '200': + description: código de status retornado pelas APIs + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseDiscoveryOutageList' +components: + schemas: + ResponseDiscoveryStatusList: + type: object + required: + - data + - links + - meta + properties: + data: + type: object + required: + - status + properties: + status: + type: array + items: + $ref: '#/components/schemas/Status' + links: + $ref: '#/components/schemas/Links' + meta: + $ref: '#/components/schemas/Meta' + ResponseDiscoveryOutageList: + type: object + required: + - data + - links + - meta + properties: + data: + type: array + items: + required: + - outageTime + - duration + - isPartial + - explanation + properties: + outageTime: + type: string + description: Data e hora planejada do início da indisponibilidade + example: '2020-07-21T08:30:00Z' + duration: + type: string + description: Duração prevista da indisponibilidade + example: PT2H30M + isPartial: + type: boolean + description: Flag que indica se a indisponibilidade é parcial (atingindo apenas alguns end points) ou total (atingindo todos os end points) + example: false + explanation: + type: string + description: Explicação sobre os motivos da indisponibilidade. + example: Atualização do API Gateway + links: + $ref: '#/components/schemas/Links' + meta: + $ref: '#/components/schemas/Meta' + Links: + type: object + properties: + self: + type: string + description: URL da página atualmente requisitada + example: 'https://api.banco.com.br/open-banking/channels/v1/' + first: + type: string + description: URL da primeira página de registros + example: 'https://api.banco.com.br/open-banking/channels/v1/' + prev: + type: string + description: URL da página anterior de registros + next: + type: string + description: URL da próxima página de registros + last: + type: string + description: URL da última página de registros + example: 'https://api.banco.com.br/open-banking/channels/v1/' + Meta: + type: object + properties: + totalRecords: + type: integer + description: Total de registros encontrados + example: 1 + totalPages: + type: integer + description: Total de páginas para os registros encontrados + example: 1 + required: + - totalRecords + - totalPages + Status: + type: object + required: + - code + - explanation + properties: + code: + type: string + enum: + - OK + - PARTIAL_FAILURE + - UNAVAILABLE + - SCHEDULED_OUTAGE + description: > + Condição atual da API: + * `OK` - A implementação é totalmente funcional + * `PARTIAL_FAILURE` - Um ou mais endpoints estão indisponíveis + * `UNAVAILABLE` - A implementação completa está indisponível + * `SCHEDULED_OUTAGE` - Uma interrupção anunciada está em vigor + example: OK + explanation: + type: string + description: Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK + example: Retorno com Sucesso + detectionTime: + type: string + description: A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE + example: '2020-07-21T08:30:00Z' + expectedResolutionTime: + type: string + description: A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK + example: '2020-07-21T08:30:00Z' + updateTime: + type: string + description: A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados. + example: '2020-01-02T01:00:00Z' + unavailableEndpoints: + type: array + description: Endpoints com indisponibilidade + items: + type: string + example: + - 'https://api.banco.com.br/open-banking/channels/v1/electronic-channels' + parameters: + page: + name: page + in: query + description: Número da página que está sendo requisitada (o valor da primeira página é 1). + schema: + type: integer + default: 1 + minimum: 1 + maximum: 2147483647 + format: int32 + pageSize: + name: page-size + in: query + description: Quantidade total de registros por páginas. + schema: + type: integer + default: 25 + minimum: 1 + maximum: 1000 + format: int32 diff --git a/swagger-apis/common/index.html b/swagger-apis/common/index.html index e64168a9a..3ae765193 100644 --- a/swagger-apis/common/index.html +++ b/swagger-apis/common/index.html @@ -51,8 +51,9 @@ {"name": "1.0.0", "url": "./1.0.0.yml"}, {"name": "1.0.1-rc1.0", "url": "./1.0.1-rc1.0.yml"}, {"name": "1.0.1", "url": "./1.0.1.yml"}, - {"name": "1.0.2", "url": "./1.0.2.yml"}], - "urls.primaryName": "1.0.2", // default spec + {"name": "1.0.2", "url": "./1.0.2.yml"}, + {"name": "2.0.0", "url": "./2.0.0.yml"}], + "urls.primaryName": "2.0.0", // default spec dom_id: '#swagger-ui', deepLinking: true, supportedSubmitMethods:[], From b493a38eb2a0063235d45242c41747760cac59bd Mon Sep 17 00:00:00 2001 From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com> Date: Thu, 13 Jul 2023 17:42:54 +0000 Subject: [PATCH 2/6] feat(Common): ORB-2864 - PC115 - Definir maxLength --- dictionary/getStatus_v2.csv | 10 +++++----- swagger-apis/common/2.0.0.yml | 9 +++++++++ 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/dictionary/getStatus_v2.csv b/dictionary/getStatus_v2.csv index 9bcd3c81c..7a9503186 100644 --- a/dictionary/getStatus_v2.csv +++ b/dictionary/getStatus_v2.csv @@ -10,8 +10,8 @@ PARTIAL_FAILURE UNAVAILABLE SCHEDULED_OUTAGE";1;1;"";Não permitido;string;OK; -/data/status/explanation;explanation;Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;;Obrigatório;;;1;1;"";Não permitido;string;Retorno com Sucesso; -/data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; -/data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; -/data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;;Opcional;;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; -/data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;;Opcional;;;0;N;"";Não permitido;array;; +/data/status/explanation;explanation;Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;Retorno com Sucesso; +/data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; +/data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;2000;Opcional;;;0;N;"";Não permitido;array;; diff --git a/swagger-apis/common/2.0.0.yml b/swagger-apis/common/2.0.0.yml index 641439eac..f50297171 100644 --- a/swagger-apis/common/2.0.0.yml +++ b/swagger-apis/common/2.0.0.yml @@ -109,20 +109,24 @@ components: type: string description: URL da página atualmente requisitada example: 'https://api.banco.com.br/open-banking/channels/v1/' + maxLength: 2000 first: type: string description: URL da primeira página de registros example: 'https://api.banco.com.br/open-banking/channels/v1/' + maxLength: 2000 prev: type: string description: URL da página anterior de registros next: type: string description: URL da próxima página de registros + maxLength: 2000 last: type: string description: URL da última página de registros example: 'https://api.banco.com.br/open-banking/channels/v1/' + maxLength: 2000 Meta: type: object properties: @@ -161,23 +165,28 @@ components: type: string description: Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK example: Retorno com Sucesso + maxLength: 2000 detectionTime: type: string description: A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE example: '2020-07-21T08:30:00Z' + maxLength: 20 expectedResolutionTime: type: string description: A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK example: '2020-07-21T08:30:00Z' + maxLength: 20 updateTime: type: string description: A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados. example: '2020-01-02T01:00:00Z' + maxLength: 20 unavailableEndpoints: type: array description: Endpoints com indisponibilidade items: type: string + maxLength: 2000 example: - 'https://api.banco.com.br/open-banking/channels/v1/electronic-channels' parameters: From 5c90474f0146b7aa263fb62277eafb4f20f75e71 Mon Sep 17 00:00:00 2001 From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com> Date: Thu, 13 Jul 2023 19:47:02 +0000 Subject: [PATCH 3/6] feat(Common): ORB-2866 - PC117- alterar maxItems --- dictionary/getStatus_v2.csv | 4 ++-- swagger-apis/common/2.0.0.yml | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/dictionary/getStatus_v2.csv b/dictionary/getStatus_v2.csv index 7a9503186..00d31ff19 100644 --- a/dictionary/getStatus_v2.csv +++ b/dictionary/getStatus_v2.csv @@ -1,6 +1,6 @@ Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo /data;data;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/status;status;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/status;status;;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/status/code;code;"Condição atual da API: * `OK` - A implementação é totalmente funcional * `PARTIAL_FAILURE` - Um ou mais endpoints estão indisponíveis @@ -14,4 +14,4 @@ SCHEDULED_OUTAGE";1;1;"";Não permitido;string;OK; /data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; /data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; /data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; -/data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;2000;Opcional;;;0;N;"";Não permitido;array;; +/data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;2000;Opcional;;;0;1;"";Não permitido;array;; diff --git a/swagger-apis/common/2.0.0.yml b/swagger-apis/common/2.0.0.yml index f50297171..86196308a 100644 --- a/swagger-apis/common/2.0.0.yml +++ b/swagger-apis/common/2.0.0.yml @@ -60,6 +60,7 @@ components: properties: status: type: array + maxItems: 1000 items: $ref: '#/components/schemas/Status' links: @@ -75,6 +76,7 @@ components: properties: data: type: array + maxItems: 1000 items: required: - outageTime @@ -184,6 +186,7 @@ components: unavailableEndpoints: type: array description: Endpoints com indisponibilidade + maxItems: 1000 items: type: string maxLength: 2000 From de528368fd2734f169629fa420f0a4f7e07d2739 Mon Sep 17 00:00:00 2001 From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com> Date: Thu, 13 Jul 2023 20:05:50 +0000 Subject: [PATCH 4/6] feat(Common): ORB-2867 - PC118 - Status code --- swagger-apis/common/2.0.0.yml | 179 ++++++++++++++++++++++++++++++++++ 1 file changed, 179 insertions(+) diff --git a/swagger-apis/common/2.0.0.yml b/swagger-apis/common/2.0.0.yml index 86196308a..d40e8e285 100644 --- a/swagger-apis/common/2.0.0.yml +++ b/swagger-apis/common/2.0.0.yml @@ -27,6 +27,22 @@ paths: application/json: schema: $ref: '#/components/schemas/ResponseDiscoveryStatusList' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '504': + $ref: '#/components/responses/GatewayTimeout' + '529': + $ref: '#/components/responses/SiteIsOverloaded' + default: + $ref: '#/components/responses/Default' /outages: get: tags: @@ -44,6 +60,22 @@ paths: application/json: schema: $ref: '#/components/schemas/ResponseDiscoveryOutageList' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '504': + $ref: '#/components/responses/GatewayTimeout' + '529': + $ref: '#/components/responses/SiteIsOverloaded' + default: + $ref: '#/components/responses/Default' components: schemas: ResponseDiscoveryStatusList: @@ -192,6 +224,104 @@ components: maxLength: 2000 example: - 'https://api.banco.com.br/open-banking/channels/v1/electronic-channels' + 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: + 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' + ResponseError: + 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: + 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: page: name: page @@ -213,3 +343,52 @@ components: minimum: 1 maximum: 1000 format: int32 + responses: + BadRequest: + 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/schemas/ResponseError' + NotFound: + description: O recurso solicitado não existe ou não foi implementado. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + MethodNotAllowed: + description: O consumidor tentou acessar o recurso com um método não suportado. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + 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/schemas/ResponseError' + InternalServerError: + description: Ocorreu um erro no gateway da API ou no microsserviço. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + 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/schemas/ResponseError' + 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/schemas/ResponseErrorMetaSingle' + Default: + description: '\-' + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' From fc4d5b59b642c0ae9947a1236c545c97e1fdeb08 Mon Sep 17 00:00:00 2001 From: FelipeBaumgartel Date: Tue, 18 Jul 2023 16:55:41 -0300 Subject: [PATCH 5/6] =?UTF-8?q?feat(Common):=20ORB-2865=20-=20PC116=20-=20?= =?UTF-8?q?Strings=20-=20Padroniza=C3=A7=C3=A3o=20de=20pattern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dictionary/getStatus_v2.csv | 8 ++++---- swagger-apis/common/2.0.0.yml | 24 +++++++++++++++++------- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/dictionary/getStatus_v2.csv b/dictionary/getStatus_v2.csv index 00d31ff19..50c06ec02 100644 --- a/dictionary/getStatus_v2.csv +++ b/dictionary/getStatus_v2.csv @@ -10,8 +10,8 @@ PARTIAL_FAILURE UNAVAILABLE SCHEDULED_OUTAGE";1;1;"";Não permitido;string;OK; -/data/status/explanation;explanation;Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;Retorno com Sucesso; -/data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; -/data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; -/data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;20;Opcional;;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; +/data/status/explanation;explanation;Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Retorno com Sucesso; +/data/status/detectionTime;detectionTime;A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE;Texto;20;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/expectedResolutionTime;expectedResolutionTime;A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK;Texto;20;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;0;1;"";Não permitido;string;2020-07-21T08:30:00Z; +/data/status/updateTime;updateTime;A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.;Texto;20;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;0;1;"";Não permitido;string;2020-01-02T01:00:00Z; /data/status/unavailableEndpoints;unavailableEndpoints;Endpoints com indisponibilidade;Lista;2000;Opcional;;;0;1;"";Não permitido;array;; diff --git a/swagger-apis/common/2.0.0.yml b/swagger-apis/common/2.0.0.yml index d40e8e285..3fa022230 100644 --- a/swagger-apis/common/2.0.0.yml +++ b/swagger-apis/common/2.0.0.yml @@ -142,25 +142,31 @@ components: self: type: string description: URL da página atualmente requisitada - example: 'https://api.banco.com.br/open-banking/channels/v1/' + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' maxLength: 2000 + example: 'https://api.banco.com.br/open-banking/channels/v1/resource' first: type: string description: URL da primeira página de registros - example: 'https://api.banco.com.br/open-banking/channels/v1/' + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' maxLength: 2000 + example: 'https://api.banco.com.br/open-banking/channels/v1/resource' prev: type: string description: URL da página anterior de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + maxLength: 2000 next: type: string description: URL da próxima página de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' maxLength: 2000 last: type: string description: URL da última página de registros - example: 'https://api.banco.com.br/open-banking/channels/v1/' + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' maxLength: 2000 + example: 'https://api.banco.com.br/open-banking/channels/v1/resource' Meta: type: object properties: @@ -198,23 +204,27 @@ components: explanation: type: string description: Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK - example: Retorno com Sucesso + pattern: '[\w\W\s]*' maxLength: 2000 + example: Retorno com Sucesso detectionTime: type: string description: A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE - example: '2020-07-21T08:30:00Z' + pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$' maxLength: 20 + example: '2020-07-21T08:30:00Z' expectedResolutionTime: type: string description: A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK - example: '2020-07-21T08:30:00Z' + pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$' maxLength: 20 + example: '2020-07-21T08:30:00Z' updateTime: type: string description: A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados. - example: '2020-01-02T01:00:00Z' + pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$' maxLength: 20 + example: '2020-01-02T01:00:00Z' unavailableEndpoints: type: array description: Endpoints com indisponibilidade From 1ff3a866f93d7870c9397a3dcbe91b1f5f1ae9e6 Mon Sep 17 00:00:00 2001 From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com> Date: Wed, 19 Jul 2023 16:14:44 +0000 Subject: [PATCH 6/6] fix(Common): adicionando dicionarios --- dictionary/getOutage_v2.csv | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 dictionary/getOutage_v2.csv diff --git a/dictionary/getOutage_v2.csv b/dictionary/getOutage_v2.csv new file mode 100644 index 000000000..5a89b5df4 --- /dev/null +++ b/dictionary/getOutage_v2.csv @@ -0,0 +1,2 @@ +Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo +/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;