Cinder

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

Addressed by: https://review.opendev.org/c/openstack/cinder/+/861491
    Automate generation of backups api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/879225
    Automate generation of backups api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/878798
    Automate generation of snapshot transfer api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/884420
    Automate generation of attachments api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:create-attachments-branch

Gerrit topic: https://review.opendev.org/#/q/topic:test_list_backups_details

Addressed by: https://review.opendev.org/c/openstack/cinder/+/885765
    Automate generation of backups api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/885825
    Automate generation of volume transfer api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/885826
    Automate generation of volume transfer api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:volume_transfers

Gerrit topic: https://review.opendev.org/#/q/topic:volume_transfers_show_accept

Gerrit topic: https://review.opendev.org/#/q/topic:test_list_detail_backup

Addressed by: https://review.opendev.org/c/openstack/cinder/+/886818
    Automate generation of backups api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_failover_service

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890518
    Automate generation of services api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_messages

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890572
    Automate generation of services api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_resource_filter

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890577
    Automate generation of services api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_backend_storage_pools

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890194
    Automate generation of backend storage pool api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_hosts

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890243
    Automate generation of hosts api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_cleanup_workers

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890988
    Automate generation of workers api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_qos_completion

Addressed by: https://review.opendev.org/c/openstack/cinder/+/891039
    Automate generation of qos api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_services

Addressed by: https://review.opendev.org/c/openstack/cinder/+/889904
    Automate generation of services api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:test_services_microversion

Addressed by: https://review.opendev.org/c/openstack/cinder/+/890135
    Automate generation of services api-ref samples

Gerrit topic: https://review.opendev.org/#/q/topic:groups

Addressed by: https://review.opendev.org/c/openstack/cinder/+/891306
    Automate generation of group types api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/891307
    Automate generation of group types api-ref samples

Addressed by: https://review.opendev.org/c/openstack/cinder/+/891308
    Automate generation of group types api-ref samples

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.