API: Autogenerate API sample files from API validation schemas

Registered by Ken'ichi Ohmichi on 2014-02-12

Nova v2.1 API is validated with API schemas which are defined with JSONSchema.
On the other hand, API sample files of v2.1 API are autogenerated from the template files
of v2.1 API under nova/tests/integrated/v3/api_samples.
The API schema files are similar to the template files, because both represent the API
parameter structures and each API name.

This blueprint is for generating API sample files from API schema instead of
template files. We would not need to write a template file of a request, and
would reduce the workload when writing/reviewing a new API.

Blueprint information

Status:
Not started
Approver:
John Garbutt
Priority:
Medium
Drafter:
Ken'ichi Ohmichi
Direction:
Needs approval
Assignee:
Ken'ichi Ohmichi
Definition:
Pending Approval
Series goal:
None
Implementation:
Not started
Milestone target:
milestone icon next

Related branches

Sprints

Whiteboard

the discussion on openstack-dev ml: http://lists.openstack.org/pipermail/openstack-dev/2014-February/026537.html

Gerrit topic: https://review.openstack.org/#q,topic:bp/generate-api-sample-from-api-schema,n,z
https://review.openstack.org/71465

Moved this to "next" since the blueprint approval deadline has already passed for Icehouse. --russellb
I got it, thanks. The patch has been abandoned for Juno release now. --oomichi

Removed from next, as next is now reserved for near misses from the last milestone --johnthetubaguythe discussion on openstack-dev ml: http://lists.openstack.org/pipermail/openstack-dev/2014-February/026537.html

Gerrit topic: https://review.openstack.org/#q,topic:bp/generate-api-sample-from-api-schema,n,z
https://review.openstack.org/71465

Moved this to "next" since the blueprint approval deadline has already passed for Icehouse. --russellb
I got it, thanks. The patch has been abandoned for Juno release now. --oomichi

Removed from next, as next is now reserved for near misses from the last milestone --johnthetubaguy

If you are still working on this, please re-submit via nova-specs. If not, please mark as obsolete, and add a quick comment to describe why. --johnthetubaguy (20th April 2014)

The JSONSchema work finished in Juno cycle, and we have enough API definitions on Nova v2.1 API.
So I'd like to restart this work for Kilo release. --oomichi (2014/09/24)

Hmm, I think given this is a refactoring of tests, then it doesn't really need a spec, lets approve this without a spec. --johnthetubaguy 17th October 2014

Working Items: https://etherpad.openstack.org/p/kilo-nova-generate-api-sample-from-api-schema

Bumping to k-2 -- mikal 9 Dec 2014

Bumping to liberty, we have now hit feature proposal freeze for kilo. But this is documentation, so we could bring it back during the freeze, but there doesn't seem to be any focus on this right now, so reflecting that in this status change. --johnthetubaguy 10th March 2015

This isn't happening for liberty now, bumping it :( --johnthetubaguy 27th August 2015

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.