Swagger support for api service

Registered by yuanying on 2016-02-02

End user want to know what parameters are supported in magnum api, for example bay-types, volume-driver-types, network-driver-types.
Swagger can provide such informations via rest api.

We already discuss about this.
* https://review.openstack.org/#/c/235620/

Motohiro/Yuanying Otsuka
    Just curious, creation panel can select bay_type, but this values are fixed. is it ok for us?

Shu Muto
    We want the API to get fixed value.

Ken'ichi Ohmichi
    How about using Swagger for getting available parameters' values from server side? We can avoid defining static values on client side.
    Swagger is defined as OpenStack standard way[1] on api-wg now.
    So it is great if magnum also implement it.
    [1]: https://github.com/openstack/api-wg/blob/master/guidelines/api-docs.rst#content

Blueprint information

Status:
Complete
Approver:
hongbin
Priority:
Medium
Drafter:
yuanying
Direction:
Approved
Assignee:
Shu Muto
Definition:
Obsolete
Series goal:
Accepted for newton
Implementation:
Unknown
Milestone target:
None
Completed by
Spyros Trigazis on 2018-03-20

Related branches

Sprints

Whiteboard

--
strigazi @ Tue Mar 20 09:24:36 UTC 2018
Obsolete, all projects have their api reference in api-ref in the root of their repository,
--
Gerrit topic: https://review.openstack.org/#q,topic:bp/magnum-api-swagger-support,n,z

Addressed by: https://review.openstack.org/303235
    [WIP][PoC] Add generator for Swagger spec

(?)

Work Items

Work items:
Generate OpenAPI spec json: INPROGRESS
Provide enum parameters for Client: TODO
Create parameter.yaml for api-ref: TODO

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.