Corrigir texto de documentação da API

gestaogovbr / api-pgd

API integradora dos sistemas do Programa de Gestão.

https://www.gov.br/servidor/pt-br/assuntos/programa-de-gestao

GNU Affero General Public License v3.0

11 stars 6 forks source link

Corrigir texto de documentação da API #91

Closed augusto-herrmann closed 8 months ago

augusto-herrmann commented 8 months ago

A documentação mostrada na Swagger UI tem os seguintes problemas:

[x] "três endpoints principais", mas seguem listados 4 endpoints
[ ] link para "schemas" não funciona, abre outra aba e não direciona para a seção

Encontrado por @washolive

augusto-herrmann commented 8 months ago

O link para "Schemas" não é possível corrigir, pois a Swagger UI não suporta links para seções na página. Há até uma issue antiga aberta, sem solução até o momento: swagger-api/swagger-ui#1369

A alternativa encontrada foi simplesmente retirar o link da descrição da API.

augusto-herrmann commented 8 months ago

Devido a um bug na Swagger UI, nenhum tipo de link interno da página (após o caractere #) funciona. Por isso, todos os links internos serão removidos.