diff --git a/dictionary/getMetrics_v2.csv b/dictionary/getMetrics_v2.csv new file mode 100644 index 000000000..de8efd021 --- /dev/null +++ b/dictionary/getMetrics_v2.csv @@ -0,0 +1,53 @@ +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/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/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/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/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;; +/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/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/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/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/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/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/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/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/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/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/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/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;; diff --git a/swagger-apis/admin/2.0.0.yml b/swagger-apis/admin/2.0.0.yml new file mode 100644 index 000000000..695f67af3 --- /dev/null +++ b/swagger-apis/admin/2.0.0.yml @@ -0,0 +1,390 @@ +openapi: 3.0.0 +info: + title: APIs Admin do Open Finance Brasil + description: As API's administrativas são recursos que podem ser consumidos apenas pelo diretório para avaliação e controle da qualidade dos serviços fornecidos pelas instituições financeiras + 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/admin/v1' +tags: +- name: "Metrics" +paths: + /metrics: + get: + tags: + - Metrics + summary: Obtém as métricas de disponibilidade das APIs + description: "Obtém as métricas de disponibilidade das APIs" + operationId: "getMetrics" + parameters: + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/pageSize" + - in: query + name: period + schema: + type: string + enum: + - CURRENT + - ALL + required: false + description: | + Período a ser consultado + * `CURRENT` - Métricas do dia atual. + * `ALL` - Métricas de todo o período disponível. + responses: + '200': + description: Dados das métricas + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseMetricsList' +components: + schemas: + ResponseMetricsList: + type: object + required: + - data + - links + properties: + data: + type: object + required: + - requestTime + - availability + - invocations + - averageResponse + - averageTps + - peakTps + - errors + - rejections + properties: + requestTime: + type: string + description: Data e hora que as métricas foram requisitadas. + format: date-time + availability: + $ref: '#/components/schemas/AvailabilityMetrics' + invocations: + $ref: '#/components/schemas/InvocationMetrics' + averageResponse: + $ref: '#/components/schemas/AverageMetrics' + averageTps: + $ref: '#/components/schemas/AverageTPSMetrics' + peakTps: + $ref: '#/components/schemas/PeakTPSMetrics' + errors: + $ref: '#/components/schemas/ErrorMetrics' + rejections: + $ref: '#/components/schemas/RejectionMetrics' + links: + $ref: '#/components/schemas/Links' + meta: + $ref: '#/components/schemas/Meta' + AvailabilityMetrics: + type: object + required: + - uptime + - downtime + properties: + uptime: + type: object + required: + - generalUptimeRate + - endpoints + properties: + generalUptimeRate: + type: string + description: Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo). + endpoints: + $ref: '#/components/schemas/EndpointUptime' + downtime: + type: object + required: + - generalDowntime + - scheduledOutage + - endpoints + properties: + generalDowntime: + type: integer + description: Quantidade de segundos de downtime (considerando qualquer api em downtime). + scheduledOutage: + type: integer + description: Quantidade de segundos de indisponibilidade agendada. + endpoints: + $ref: '#/components/schemas/EndpointDowntime' + EndpointUptime: + type: object + description: Tempos de uptime por endpoint. + required: + - url + - uptimeRate + properties: + url: + type: string + description: URL do endpoint + uptimeRate: + type: string + description: Taxa de disponibilidade do endpoint. + EndpointDowntime: + type: object + description: Tempos de downtime por endpoint. + required: + - url + - partialDowntime + properties: + url: + type: string + description: URL do endpoint + partialDowntime: + type: integer + description: Quantidade de segundos de indisponibilidade do endpoint. + InvocationMetrics: + type: object + required: + - unauthenticated + - highPriority + - mediumPriority + - unattended + properties: + unauthenticated: + type: object + description: Número de chamadas não autenticadas. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número de chamadas não autenticadas no dia atual. + previousDays: + type: array + 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 + highPriority: + type: object + description: Número de chamadas para o nível de alta prioridade. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número de chamadas no dia atual para o nível de alta prioridade. + previousDays: + type: array + 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 + mediumPriority: + type: object + description: Número de chamadas para o nível de média prioridade. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número de chamadas no dia atual para o nível de média prioridade. + previousDays: + type: array + 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 + unattended: + type: object + description: Número de chamadas para o nível não acompanhado. + required: + - currentDay + - previousDays + properties: + currentDay: + description: Número de chamadas no dia atual para o nível não acompanhado. + type: integer + previousDays: + type: array + 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 + AverageMetrics: + type: object + required: + - unauthenticated + - highPriority + - mediumPriority + - unattended + properties: + unauthenticated: + type: object + description: Tempo médio de resposta para chamadas não autenticadas. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Tempo médio de resposta em milissegundos para chamadas no dia atual. + previousDays: + type: array + 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 + highPriority: + type: object + description: Tempo médio de resposta de chamadas para o nível de alta prioridade. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Tempo médio de resposta em milissegundos para chamadas no dia atual. + previousDays: + type: array + 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 + mediumPriority: + type: object + description: Tempo médio de resposta para chamadas para o nível de média prioridade. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Tempo médio de resposta em milissegundos para chamadas no dia atual. + previousDays: + type: array + 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 + unattended: + type: object + description: Tempo médio de resposta para chamadas para o nível não acompanhado. + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Tempo médio de resposta em milissegundos para chamadas no dia atual. + previousDays: + type: array + 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 + AverageTPSMetrics: + type: object + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número médio de chamadas por segundo no dia. + previousDays: + type: array + 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 + PeakTPSMetrics: + type: object + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Pico de chamadas por segundo no dia. + previousDays: + type: array + 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 + ErrorMetrics: + type: object + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número de chamadas com erro no dia atual. + previousDays: + type: array + 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 + RejectionMetrics: + type: object + required: + - currentDay + - previousDays + properties: + currentDay: + type: integer + description: Número de chamadas rejeitadas no dia atual. + previousDays: + type: array + 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 + Links: + type: object + properties: + self: + type: string + description: URL da página atualmente requisitada + example: 'https://api.banco.com.br/open-banking/admin/v1/' + first: + type: string + description: URL da primeira página de registros + example: 'https://api.banco.com.br/open-banking/admin/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/admin/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 + 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 + format: int32​ + default: 1 + minimum: 1 + maximum: 2147483647 + pageSize: + name: page-size + in: query + description: Quantidade total de registros por páginas. + schema: + type: integer + format: int32​ + default: 25 + minimum: 1 + maximum: 1000 + \ No newline at end of file diff --git a/swagger-apis/admin/index.html b/swagger-apis/admin/index.html index e64168a9a..f82439a74 100644 --- a/swagger-apis/admin/index.html +++ b/swagger-apis/admin/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:[],