#5155 OpenAPI Specification
Opened 2 years ago by kpostlet. Modified 2 years ago

Proposal

Pagure should adopt the OpenAPI specification. [0]

Benefits

The OpenAPI specification is a language agnostic API specification which defines the content of requests and responses. The specification is extremely popular and has tooling to automatically generate code stubs for API clients in different languages; [1] this will make generation and maintenance of clients simpler.

Maintenance

Changes to Pagure's API must also be made to the specification and developers will need to familiarize themselves with the specification if they are not familiar with it already.

Links

[0] https://swagger.io/specification/
[1] https://github.com/swagger-api/swagger-codegen


Metadata Update from @ngompa:
- Issue tagged with: RFE, wishful

2 years ago

Given that Pagure is made with Flask, there should be a plenty of generators for the spec out there.

While the idea of having machine readable API spec is great, I still haven't seen any solution to track API changes. Maintaining the spec manually is not a good solution to this problem.

Login to comment on this ticket.

Metadata