ProjectLibertyLabs / gateway

Gateway microservices for DSNP/Frequency
https://projectlibertylabs.github.io/gateway/
Apache License 2.0
4 stars 1 forks source link

fix: make all docs consistent with version prefix and grouping in sidebar #659

Closed JoeCap08055 closed 2 weeks ago

JoeCap08055 commented 2 weeks ago

Problem

Docs sidebar for different services/controllers was inconsistent; showing the version prefix path for some, and not others.

Solution

Utilize Redocly x-tagGroups extension to group controllers with different versions nested under the controller group. Only affects docs.

Steps to Verify:

  1. Run npm run generate:openapi
  2. Run npm run generate:swagger-ui
  3. Inspect docs for each service to see changes
  4. Run each service & browse to the live Swagger UI; should be no change from previous (Swagger UI doesn't support tag groups)

Screenshots (optional):

image

image

image

image

Closes #658