Project

General

Profile

Actions

Feature #16866

open

Support OpenAPI

Added by Peter Amstutz about 4 years ago. Updated 9 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
API
Target version:
Story points:
-
Release:
Release relationship:
Auto

Description

We should start publishing the API using OpenAPI. To start, we will continue to publish the Discovery doc side-by-side with the OpenAPI doc. The "schema" controller gets a new method & there's a new route that returns OpenAPI, which will be generated from the same Rails internal API description.

Here are some tools that do the mapping (we won't want to use them directly but they might be helpful):

https://github.com/APIs-guru/google-discovery-to-swagger

https://github.com/LucyBot-Inc/api-spec-converter


Related issues

Related to Arvados - Bug #16374: [Documentation] Improve golang docs + OpenApi v3 commentsRejectedNico César08/26/2020Actions
Actions

Also available in: Atom PDF