Document API endpoints with OpenAPI - Githubissues

quipucords / yupana

Service app to process & upload data from quipucords and satellite to the host based inventory

GNU General Public License v3.0

4 stars 14 forks source link

Document API endpoints with OpenAPI #292

Closed abaiken closed 4 years ago

abaiken commented 4 years ago

Feature description:

Document status and metrics endpoint using OpenAPI.

Is your feature request related to a problem?

The IQE plugin is built to use an OpenAPI spec file and one for yupana does not exist. We should create one.

Describe the solution you'd like

Here is an example from RHSM: https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml

Acceptance Criteria:

[ ] Verify that an OpenAPI spec exists & can be used for IQE