Magnum

Document the Magnum API

Bug #1460161 reported by Adrian Otto on 2015-05-29

This bug affects 2 people

Affects		Status	Importance	Assigned to	Milestone
	Magnum	Fix Committed	Wishlist	Lars Butler	Magnum newton-2

Bug Description

In accordance with requirements from SEMVER (http://docs.openstack.org/developer/pbr/semver.html) Magnum needs a documented API. Our API source code may be found here:

http://git.openstack.org/cgit/openstack/magnum/tree/magnum/conductor/api.py
http://git.openstack.org/cgit/openstack/magnum/tree/magnum/api/controllers/v1

Please resolve this task by documenting the Magnum API in a style consistent with other OpenStack services.

Example:
http://developer.openstack.org/api-ref-orchestration-v1.html

Tags:

Steven Dake (sdake) on 2015-06-30

Changed in magnum:
milestone:	liberty-1 → liberty-2

Michael Sambol (sambol) on 2015-07-15

Changed in magnum:
assignee:	nobody → Michael Sambol (sambol)

Revision history for this message

Anne Gentle (annegentle) wrote on 2015-10-05:

We have a Swagger document going here: https://github.com/jamiehannaford/swagger-magnum

Michael, please feel free to reach out to me on IRC to talk about our plans for WADL to Swagger conversions. Since Magnum never had a WADL, it made sense to go straight to swagger.

Changed in openstack-api-site:
status:	New → Confirmed
importance:	Undecided → High

Akihiro Motoki (amotoki) on 2015-12-26

tags:

added: magnum

Revision history for this message

Lars Butler (lars-butler) wrote on 2016-04-05:

I'd like to assign this bug to myself, since there hasn't been any activity on it in a number of months. Please let know if there are any objections.

Changed in magnum:
assignee:	Michael Sambol (sambol) → Lars Butler (lars-butler)
Changed in openstack-api-site:
assignee:	nobody → Lars Butler (lars-butler)

Revision history for this message

Lars Butler (lars-butler) wrote on 2016-04-20:

I've taken a first stab at this, but I'm blocked on some build changes, which are still under review: https://review.openstack.org/#/c/286659/.

Anne Gentle (annegentle) on 2016-05-11

no longer affects:

openstack-api-site

Revision history for this message

Anne Gentle (annegentle) wrote on 2016-05-12:

Lars, the files won't be built from api-site any longer, so the review you point to is going to be abandoned.

Instead, the source files need to be in the magnum repository. Let me know if you need any further direction on this. See docs.openstack.org/contributor-guide/api-guides.html and http://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html.

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2016-05-17: Fix proposed to magnum (master)

Fix proposed to branch: master
Review: https://review.openstack.org/317368

Changed in magnum:
status:	Triaged → In Progress

Revision history for this message

Lars Butler (lars-butler) wrote on 2016-08-15:

I've submitted a new patch to the magnum repo: https://review.openstack.org/#/c/317368. It's been through several rounds of code reviews, but it still needs a +2.