search

CDCgov / prime-reportstream

ReportStream is a public intermediary tool for delivery of data between different parts of the healthcare ecosystem.
https://reportstream.cdc.gov
Creative Commons Zero v1.0 Universal
70 stars 39 forks source link

Automate refresh of public API documentation #5381

Open RakshindaAslam opened 2 years ago

RakshindaAslam commented 2 years ago

Problem statement

As a potential sender, I want to see the API documentation for the current version of API in production.

As an Operations team member, I want to ensure that the latest API documentation is always available to the user without the time spent of manual updates as done today.

Acceptance criteria

HeatherRienks commented 1 year ago

@kevinhaube - do you have any info on this?

cc: @chris-kuryak

hannasage commented 1 year ago

@HeatherRienks @chris-kuryak This was something we'd considered for the API Programmers Guide to webpages initiative way back. The idea is using the Yaml documentation files maintained by the API team to auto generate some of the resources for the documentation on our website.

It may be a good idea, though there isn't a clear way in which we'd translate these Yaml files to usable front end resources. This may get considered as part of engineering what our design team comes up with, but it's hard to say for sure without an idea of what their designs look like.

I'd say "stale, but a good idea!" Haha

chris-kuryak commented 1 year ago

@kevinhaube @stephenkao As I noted in the epic this falls under ( #5284 ), it seems that this should be reconsidered when we begin scoping the Design and Build of the API Documentation migration to Website (epic #5814 ). So I am going to put it over there (while still keeping it under this epic #5284 ) for now and we'll determine if it is in scope at that time.