Automating generation of sample files

Registered by Rajat Dhasmana

Cinder api-ref is constructed without any sample request or response parameters which makes it error prone.
Monitoring every change in the existing API request/response parameters is quite difficult and that causes the api-ref to contain old parameters.
Since nova has implemented the technique of generating sample files using functional tests which records API responses in sample api files, matches and updates if any mismatch occurs, which makes it quite easier to maintain the documentation.
This blueprint proposes implementing the same idea in cinder.

Nova Ref : https://docs.openstack.org/nova/latest/contributor/api.html#functional-tests-and-api-samples

Blueprint information

Status:
Not started
Approver:
None
Priority:
Undefined
Drafter:
Rajat Dhasmana
Direction:
Needs approval
Assignee:
None
Definition:
New
Series goal:
None
Implementation:
Unknown
Milestone target:
None

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/generating-sample-files,n,z

Addressed by: https://review.openstack.org/613949
    Automating generation of API doc sample files

Addressed by: https://review.openstack.org/619676
    Automating generation of sample files

Addressed by: https://review.openstack.org/620033
    Automating generation of sample files

Addressed by: https://review.openstack.org/621478
    Automating generation of volumes sample files

Addressed by: https://review.openstack.org/632986
    Automate generation of api-ref samples

Addressed by: https://review.openstack.org/642658
    Automate generation of snapshots api-ref samples

Addressed by: https://review.openstack.org/644818
    Automate generation of volume transfer api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:bp/generating-sample-files

Addressed by: https://review.opendev.org/685046
    Automate generation of volume transfer api-ref samples

Addressed by: https://review.opendev.org/685652
    Automate generation of quotas api-ref samples

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.