CVEProject/cve-services

Add response headers to swagger docs

jdaigneau5 opened this issue · 2 comments

Summary

Cve-Services endpoint response headers are not documented in the Swagger docs. These should be added to each endpoint's docs for clarity. For example, RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset are included in the response headers for GET /cve-id/{id} and is useful information for a user or client.

Definition of Done

  • Response headers added to each endpoints documentation

Request for more information. While there are headers, like the ones listed above, that would be useful to have documentation for as it pertains to a client's usage of the service. However, there are more than 20 headers returned on every endpoint. In addition, they would have to be added for each HTTP return code. Do we really want to do document all of these when a vast majority are protocol headers that the average client does not need to be aware of?

I think that we should limit it to "custom" headers, in example the rate limiting, along with any other headers of note.

Resolved by #1153