Swagger support for api service
End user want to know what parameters are supported in magnum api, for example bay-types, volume-
Swagger can provide such informations via rest api.
We already discuss about this.
* https:/
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:/
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
- Started by
- Completed by
- Spyros Trigazis
Related branches
Related bugs
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:/
Addressed by: https:/
[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.