department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
97 stars 69 forks source link

Swagger documentation for facilities-api v2 #18815

Open jilladams opened 1 month ago

jilladams commented 1 month ago

IN https://github.com/department-of-veterans-affairs/va.gov-cms/issues/18314 we identified that after deprecating facilities-api V1 (correlated with Lighthouse V0), Swagger docs may need attention:

https://department-of-veterans-affairs.github.io/va-digital-services-platform-docs/api-reference/#/facilities

Which means our v2 endpoints for the facilities-api that we use aren't findable in swagger.

Related but not in scope

v1/facilities/va is still present in Swagger docs. This is the Legacy Facilities API Client and ownership is getting sorted via #18351 . Work on this situation isn't in scope in this ticket.

Acceptance criteria

jilladams commented 1 month ago

Corrections:

Assuming that mobile team migrates onto our facilities-api:

This can sit just in the backlog til ownership / migration of the legacy API client is decided.