Investigate using openAPI&Swagger to document v2 RESTful API

Description

API documentation often follows a docs-as-code workflow, where the tools to author and publish documentation align closely with the same tools developers use to write, manage, build, and deploy code.

Investigate using OpenAPI/Swagger for API documentation and code generation. Also, Swagger UI can be very useful for users to make restful calls directly while reading the document. 

Acceptance / Success Criteria

None

Lucidchart Diagrams

Activity

Fixed

Details

Assignee

Reporter

Sprint

Fix versions

Affects versions

Priority

PagerDuty

Created March 2, 2021 at 11:00 PM
Updated March 30, 2021 at 2:33 PM
Resolved March 29, 2021 at 11:23 PM

Flag notifications