From 4303d6d6462b0d6f2327e9f3258cf14cc127f99c Mon Sep 17 00:00:00 2001 From: FelipeBaumgartel Date: Thu, 13 Jul 2023 15:37:36 -0300 Subject: [PATCH 1/2] feat(Admin): ORB-2858 - PC109 - maxLength - Definir --- dictionary/getMetrics_v2.csv | 10 +++++----- swagger-apis/admin/2.0.0.yml | 9 +++++++++ 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/dictionary/getMetrics_v2.csv b/dictionary/getMetrics_v2.csv index de8efd021..9fa70029c 100644 --- a/dictionary/getMetrics_v2.csv +++ b/dictionary/getMetrics_v2.csv @@ -1,17 +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/requestTime;requestTime;Data e hora que as métricas foram requisitadas.;Date Hora;;Obrigatório;;;1;1;"";Não permitido;string;; +/data/requestTime;requestTime;Data e hora que as métricas foram requisitadas.;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;; /data/availability;availability;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/availability/uptime;uptime;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/availability/uptime/generalUptimeRate;generalUptimeRate;Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo).;Texto;;Obrigatório;;;1;1;"";Não permitido;string;; +/data/availability/uptime/generalUptimeRate;generalUptimeRate;Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo).;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;; /data/availability/uptime/endpoints;endpoints;Tempos de uptime por endpoint.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/availability/uptime/endpoints/url;url;URL do endpoint;Texto;;Obrigatório;;;1;1;"";Não permitido;string;; -/data/availability/uptime/endpoints/uptimeRate;uptimeRate;Taxa de disponibilidade do endpoint.;Texto;;Obrigatório;;;1;1;"";Não permitido;string;; +/data/availability/uptime/endpoints/url;url;URL do endpoint;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;; +/data/availability/uptime/endpoints/uptimeRate;uptimeRate;Taxa de disponibilidade do endpoint.;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;; /data/availability/downtime;downtime;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/availability/downtime/generalDowntime;generalDowntime;Quantidade de segundos de downtime (considerando qualquer api em downtime).;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; /data/availability/downtime/scheduledOutage;scheduledOutage;Quantidade de segundos de indisponibilidade agendada.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; /data/availability/downtime/endpoints;endpoints;Tempos de downtime por endpoint.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/availability/downtime/endpoints/url;url;URL do endpoint;Texto;;Obrigatório;;;1;1;"";Não permitido;string;; +/data/availability/downtime/endpoints/url;url;URL do endpoint;Texto;2000;Obrigatório;;;1;1;"";Não permitido;string;; /data/availability/downtime/endpoints/partialDowntime;partialDowntime;Quantidade de segundos de indisponibilidade do endpoint.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; /data/invocations;invocations;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/unauthenticated;unauthenticated;Número de chamadas não autenticadas.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; diff --git a/swagger-apis/admin/2.0.0.yml b/swagger-apis/admin/2.0.0.yml index 695f67af3..cbcd90e57 100644 --- a/swagger-apis/admin/2.0.0.yml +++ b/swagger-apis/admin/2.0.0.yml @@ -61,6 +61,7 @@ components: properties: requestTime: type: string + maxLength: 20 description: Data e hora que as métricas foram requisitadas. format: date-time availability: @@ -95,6 +96,7 @@ components: properties: generalUptimeRate: type: string + maxLength: 2000 description: Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo). endpoints: $ref: '#/components/schemas/EndpointUptime' @@ -122,9 +124,11 @@ components: properties: url: type: string + maxLength: 2000 description: URL do endpoint uptimeRate: type: string + maxLength: 2000 description: Taxa de disponibilidade do endpoint. EndpointDowntime: type: object @@ -135,6 +139,7 @@ components: properties: url: type: string + maxLength: 2000 description: URL do endpoint partialDowntime: type: integer @@ -337,20 +342,24 @@ components: self: type: string description: URL da página atualmente requisitada + maxLength: 2000 example: 'https://api.banco.com.br/open-banking/admin/v1/' first: type: string description: URL da primeira página de registros + maxLength: 2000 example: 'https://api.banco.com.br/open-banking/admin/v1/' prev: type: string description: URL da página anterior de registros next: type: string + maxLength: 2000 description: URL da próxima página de registros last: type: string description: URL da última página de registros + maxLength: 2000 example: 'https://api.banco.com.br/open-banking/admin/v1/' Meta: type: object From 57fc1c1c2b4905b9521452f60a18ddbd0136e55c Mon Sep 17 00:00:00 2001 From: FelipeBaumgartel Date: Thu, 13 Jul 2023 15:44:18 -0300 Subject: [PATCH 2/2] feat(Admin): ORB-2860 - PC111 - maxItems em enum --- dictionary/getMetrics_v2.csv | 24 ++++++++++++------------ swagger-apis/admin/2.0.0.yml | 12 ++++++++++++ 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/dictionary/getMetrics_v2.csv b/dictionary/getMetrics_v2.csv index 9fa70029c..8a14321bf 100644 --- a/dictionary/getMetrics_v2.csv +++ b/dictionary/getMetrics_v2.csv @@ -16,38 +16,38 @@ /data/invocations;invocations;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/unauthenticated;unauthenticated;Número de chamadas não autenticadas.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/unauthenticated/currentDay;currentDay;Número de chamadas não autenticadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/invocations/unauthenticated/previousDays;previousDays;Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/invocations/unauthenticated/previousDays;previousDays;Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/invocations/highPriority;highPriority;Número de chamadas para o nível de alta prioridade.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/highPriority/currentDay;currentDay;Número de chamadas no dia atual para o nível de alta prioridade.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/invocations/highPriority/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/invocations/highPriority/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/invocations/mediumPriority;mediumPriority;Número de chamadas para o nível de média prioridade.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/mediumPriority/currentDay;currentDay;Número de chamadas no dia atual para o nível de média prioridade.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/invocations/mediumPriority/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/invocations/mediumPriority/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/invocations/unattended;unattended;Número de chamadas para o nível não acompanhado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/invocations/unattended/currentDay;currentDay;Número de chamadas no dia atual para o nível não acompanhado.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/invocations/unattended/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/invocations/unattended/previousDays;previousDays;Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/averageResponse;averageResponse;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageResponse/unauthenticated;unauthenticated;Tempo médio de resposta para chamadas não autenticadas.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageResponse/unauthenticated/currentDay;currentDay;Tempo médio de resposta em milissegundos para chamadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/averageResponse/unauthenticated/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/averageResponse/unauthenticated/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/averageResponse/highPriority;highPriority;Tempo médio de resposta de chamadas para o nível de alta prioridade.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageResponse/highPriority/currentDay;currentDay;Tempo médio de resposta em milissegundos para chamadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/averageResponse/highPriority/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/averageResponse/highPriority/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/averageResponse/mediumPriority;mediumPriority;Tempo médio de resposta para chamadas para o nível de média prioridade.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageResponse/mediumPriority/currentDay;currentDay;Tempo médio de resposta em milissegundos para chamadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/averageResponse/mediumPriority/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/averageResponse/mediumPriority/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/averageResponse/unattended;unattended;Tempo médio de resposta para chamadas para o nível não acompanhado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageResponse/unattended/currentDay;currentDay;Tempo médio de resposta em milissegundos para chamadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/averageResponse/unattended/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/averageResponse/unattended/previousDays;previousDays;Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/averageTps;averageTps;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/averageTps/currentDay;currentDay;Número médio de chamadas por segundo no dia.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/averageTps/previousDays;previousDays;Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/averageTps/previousDays;previousDays;Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/peakTps;peakTps;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/peakTps/currentDay;currentDay;Pico de chamadas por segundo no dia.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/peakTps/previousDays;previousDays;Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/peakTps/previousDays;previousDays;Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/errors;errors;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/errors/currentDay;currentDay;Número de chamadas com erro no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/errors/previousDays;previousDays;Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/errors/previousDays;previousDays;Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; /data/rejections;rejections;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/rejections/currentDay;currentDay;Número de chamadas rejeitadas no dia atual.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;; -/data/rejections/previousDays;previousDays;Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;N;"";Não permitido;array;; +/data/rejections/previousDays;previousDays;Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.;Lista;;Obrigatório;;;1;1;"";Não permitido;array;; diff --git a/swagger-apis/admin/2.0.0.yml b/swagger-apis/admin/2.0.0.yml index cbcd90e57..450c54cbd 100644 --- a/swagger-apis/admin/2.0.0.yml +++ b/swagger-apis/admin/2.0.0.yml @@ -164,6 +164,7 @@ components: description: Número de chamadas não autenticadas no dia atual. previousDays: type: array + maxItems: 7 description: Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -179,6 +180,7 @@ components: description: Número de chamadas no dia atual para o nível de alta prioridade. previousDays: type: array + maxItems: 7 description: Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -194,6 +196,7 @@ components: description: Número de chamadas no dia atual para o nível de média prioridade. previousDays: type: array + maxItems: 7 description: Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -209,6 +212,7 @@ components: type: integer previousDays: type: array + maxItems: 7 description: Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -232,6 +236,7 @@ components: description: Tempo médio de resposta em milissegundos para chamadas no dia atual. previousDays: type: array + maxItems: 7 description: Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -247,6 +252,7 @@ components: description: Tempo médio de resposta em milissegundos para chamadas no dia atual. previousDays: type: array + maxItems: 7 description: Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -262,6 +268,7 @@ components: description: Tempo médio de resposta em milissegundos para chamadas no dia atual. previousDays: type: array + maxItems: 7 description: Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -277,6 +284,7 @@ components: description: Tempo médio de resposta em milissegundos para chamadas no dia atual. previousDays: type: array + maxItems: 7 description: Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -291,6 +299,7 @@ components: description: Número médio de chamadas por segundo no dia. previousDays: type: array + maxItems: 7 description: Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -305,6 +314,7 @@ components: description: Pico de chamadas por segundo no dia. previousDays: type: array + maxItems: 7 description: Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -319,6 +329,7 @@ components: description: Número de chamadas com erro no dia atual. previousDays: type: array + maxItems: 7 description: Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer @@ -333,6 +344,7 @@ components: description: Número de chamadas rejeitadas no dia atual. previousDays: type: array + maxItems: 7 description: Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis. items: type: integer