Feature #16866

Support OpenAPI

Added by Peter Amstutz 5 months ago. Updated 5 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
API
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

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 commentsRejected08/26/2020

History

#1 Updated by Peter Amstutz 5 months ago

  • Description updated (diff)

#2 Updated by Nico César 5 months ago

this is realted to #16374, here are my thoughts:

1) as you can see in note 15 there is no easy way to translate the current discovery document I used LucyBot and documented it. but I'm sure I tried several
2) the cannonical place should be the code and we generate the yaml file. My effort to make this by forking goas and using all the features that other people develop in other forks, see https://github.com/nicocesar/goas the motivation for this in particular was https://github.com/nicocesar/goas/commit/695d1232698d3573d99773f73e386d0988160376

#3 Updated by Nico César 5 months ago

  • Related to Bug #16374: [Documentation] Improve golang docs + OpenApi v3 comments added

Also available in: Atom PDF