Convert API Reference to RST and host it in the Nova tree (partial)
The current API Reference website is based on a baroque publish toolchain using WADL and Maven, which is largely unmaintained. This makes it hard to have an up to date version of our API docs, or describe things like microversions in our docs.
There is a push to convert this to RST instead. We'll be doing that in the nova tree first to demonstrate this working, then export to other projects.
Blueprint information
- Status:
- Complete
- Approver:
- Matt Riedemann
- Priority:
- Medium
- Drafter:
- Sean Dague
- Direction:
- Approved
- Assignee:
- Sean Dague
- Definition:
- Approved
- Series goal:
- Accepted for newton
- Implementation:
-
Implemented
- Milestone target:
-
newton-3
- Started by
- Matt Riedemann
- Completed by
- Matt Riedemann
Related branches
Related bugs
| Bug #1571628: os-server-groups description is missing | Invalid |
| Bug #1572013: missing parameter explaination in "Servers" section of v2.1 compute api | Opinion |
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Add 'Show All' / 'Hide All' toggle
Addressed by: https:/
fix blockquote font size
Addressed by: https:/
Fix css references to the glyphicons font
Addressed by: https:/
use 'required' instead of 'optional' for parameters
Addressed by: https:/
move sphinx h3 to '-' instead of '^'
Addressed by: https:/
clean up versions.inc reference document
Gerrit topic: https:/
Addressed by: https:/
Collection of CSS fixes
Addressed by: https:/
Fix "Creates an agent build" parameters
Addressed by: https:/
Fix "Creates an aggregate" parameters
Addressed by: https:/
Update servers.inc to be as accurate as api-site
Addressed by: https:/
Fix "No field definition" warnings (1/2)
Addressed by: https:/
Fix "Delete a service " return value
Addressed by: https:/
Add 'binary' and 'disable-reason'
Addressed by: https:/
rename the response json simple-tenant-usage
Addressed by: https:/
Fix os-server-
Addressed by: https:/
fix samples references for 2 files
Addressed by: https:/
Update 'os-hypervisors
Addressed by: https:/
Fix api samples references in 3 more files
Addressed by: https:/
Fix hosts and az api samples
Addressed by: https:/
Remove 40X and 50X from Normal response codes
Addressed by: https:/
Specify normal status code on os-baremetal-nodes
Addressed by: https:/
Fix json response example heading in api ref
Addressed by: https:/
Fix server-
Addressed by: https:/
Add remaining image API ref
Addressed by: https:/
Fix api ref for ips, limits, metdata and agent
Addressed by: https:/
Fix diagnostics, extensions api ref
Addressed by: https:/
Fix os-virtual-
Addressed by: https:/
Fix flavor-access and flavor-extras api-ref
Addressed by: https:/
Fix wrong link of version and version_min
Addressed by: https:/
Fix the parameters for os-agents API
Addressed by: https:/
Fix api ref for os-cells, os-cloudpipe and server-
Addressed by: https:/
Fix api ref for os-hosts, os-quota-sets and os-fping
Addressed by: https:/
fix samples references in os-services
Addressed by: https:/
fix samples references in security group files
Addressed by: https:/
Change adminPass for several server actions
Addressed by: https:/
Fix sample path for aggregate, certificate, console
Addressed by: https:/
Fix sample file path for fixed, floating ips API
Addressed by: https:/
Fix sample file path for os-i* API
Addressed by: https:/
Fix content and sample file for keypair, migration, networks
Addressed by: https:/
Fix sample file path for 4 files
Addressed by: https:/
Fix all remaining sample file path
Addressed by: https:/
Remove duplicate api ref for os-networks/actions
Addressed by: https:/
change host to host_migration
Addressed by: https:/
modify duplicate // to / in doc
Addressed by: https:/
Fix remaining json reference warnings
Addressed by: https:/
Final warnings removals for api-ref
Addressed by: https:/
add tags to files for the content verification phase
Addressed by: https:/
Add api sample test for non-existed endpoint request
Addressed by: https:/
Fix the versions API for api-ref
Addressed by: https:/
Complet Method Verification of server diag
Addressed by: https:/
Complet Method Verification of limits
Addressed by: https:/
Add links to API guide to describe links
Addressed by: https:/
Complet Method Verification of server group
Addressed by: https:/
Complet Method Verification of os-services
Addressed by: https:/
Complet Method Verification of simple tenant usage
Addressed by: https:/
Complet Method Verification of availability-zone
Addressed by: https:/
Complet Method Verification of keypair
Addressed by: https:/
Complet Method Verification of flavor
Addressed by: https:/
Complet Method Verification of flavor-access
Addressed by: https:/
Complete Verification of os-flavor-
Addressed by: https:/
Complet Method Verification of os-instance-actions
Addressed by: https:/
Complete Verification of os-virtual-
Addressed by: https:/
Complete Method Verification of os-interface
Addressed by: https:/
Complete Verification of os-floating-
Addressed by: https:/
Complete Verification of os-floating-ips
Addressed by: https:/
Complete Verification of os-hosts
Addressed by: https:/
Complete Verification of os-server-password
Addressed by: https:/
Complete Verification of server-metadata
Addressed by: https:/
Complete Verification of server admin action
Addressed by: https:/
Complete method Verification of os-hypervisors
Addressed by: https:/
Complete method Verification of consoles
Addressed by: https:/
Complete Method Verification of ips
Addressed by: https:/
complete Method Verification of aggregates
Addressed by: https:/
api-ref: method verification and fixes for servers.inc
Addressed by: https:/
WIP: api-ref: working on parameters validation for servers
Addressed by: https:/
Complete method verification of os-fixed-ips
Addressed by: https:/
Complete method verification of os-agents
Addressed by: https:/
Add api-sample test for showing quota detail
Addressed by: https:/
Complete method verification of os-quotes
Addressed by: https:/
Complete method verification of os-shevle
Addressed by: https:/
Compelete method verification of os-servers-admin
Addressed by: https:/
api-ref: complete verification for diagnostics.inc
Addressed by: https:/
api-ref: complete verification for extensions resource
Addressed by: https:/
WIP: api-ref: flavors
Addressed by: https:/
Complete method verification of os-tenant-networks
Addressed by: https:/
[WIP] Complete method verification of os-networks
Addressed by: https:/
[WIP] Complete method verification of os-security-groups
Addressed by: https:/
Complete method verification of os-security-
Addressed by: https:/
[WIP] api-ref: Update method validation on images
Addressed by: https:/
api-ref: add url parameter to expand all sections
Addressed by: https:/
api-ref: perform all 4 phases of verification for action console output
Addressed by: https:/
Complete method verification of os-fping
Addressed by: https:/
WIP: api-ref: Verify methods for metadata.inc
Addressed by: https:/
Complete method verification of os-migrations
Addressed by: https:/
api-ref: ips.inc parameter verification
Addressed by: https:/
api-ref: os-volumes.inc method verification
Addressed by: https:/
WIP: api-ref: ips.inc example verification
Addressed by: https:/
Remove 404 for list and details action servers
Addressed by: https:/
WIP: api-ref keypair update
Addressed by: https:/
Denormalize extensions for clarity
Addressed by: https:/
api-ref: complete verification of servers-
Addressed by: https:/
Denormalize personality extension
Addressed by: https:/
method verification for servers-
Addressed by: https:/
[WIP] api-ref, evacuate action
Addressed by: https:/
Complete method verification of os-cloudpipe.inc
Addressed by: https:/
api-ref: Method verification for os-floating-ips
Addressed by: https:/
api-ref: os-certificates.inc method verification
Addressed by: https:/
api-ref: Method verification for floating-ip-pools
Addressed by: https:/
method verification of os-assisted-
Addressed by: https:/
api-ref: parameter and example verification for os-quota-sets
Addressed by: https:/
WIP: api-ref host verification (os-hosts.inc)
Addressed by: https:/
method verification for server-
Addressed by: https:/
api-ref: parameter validation for os-security-
Addressed by: https:/
[WIP] Complete method verification of os-baremetal-
Addressed by: https:/
Method verification for server deferred delete
Addressed by: https:/
method verification of os-instance-
Addressed by: https:/
method verification of os-server-
Addressed by: https:/
Method verification of os-floating-
Addressed by: https:/
api-ref: finish validation for os-server-
Addressed by: https:/
WIP: api-ref: limits.inc validate parameters
Addressed by: https:/
api-ref: Method verification for servers-actions
Addressed by: https:/
WIP: api-ref: ips.inc example verification
Addressed by: https:/
Method verification of os-security-
Addressed by: https:/
[WIP]api-ref: os-floating-
Addressed by: https:/
api-ref: Method verification for os-volume_
Addressed by: https:/
api-ref: Parameter verification for os-interface.inc
Addressed by: https:/
api-ref: parameter verification for os-server-groups
Addressed by: https:/
WIP api-ref: parameter verification for os-aggregates
Addressed by: https:/
report info if parameters are out of order
Addressed by: https:/
api-ref: reorder parameters.yaml
Addressed by: https:/
WIP: limits.inc example verification
Addressed by: https:/
api-ref: Parameter verification for os-volume_
Addressed by: https:/
api-ref: Example verification for os-volume_
Addressed by: https:/
api-ref: Example verification for os-interface.inc
Addressed by: https:/
api-ref: parameter verification for os-hypervisors
Addressed by: https:/
WIP: api-ref: complete verification for os-flavor-access
Addressed by: https:/
Trivial: remove os-security-groups needs:method_
Gerrit topic: https:/
Addressed by: https:/
api-ref: os-consoles.inc
Addressed by: https:/
api-ref: Fix parameters in servers-
Addressed by: https:/
api-ref: Example verification for servers-
Addressed by: https:/
api-ref: Add fault parameter details
Addressed by: https:/
api-ref verify servers-
Addressed by: https:/
verify api-ref os-server-
Addressed by: https:/
verify api-ref os-instance-
Addressed by: https:/
verify api-ref os-migrations.inc
Addressed by: https:/
api-ref: complete verification of baremetal api
Addressed by: https:/
verify api-ref metadata.inc
Addressed by: https:/
api-ref, os-fping.inc
Addressed by: https:/
WIP: api-ref method verification for os-cells
Addressed by: https:/
[WIP] api-ref, os-availability
Addressed by: https:/
api-ref: Add a sample test for os-interface
Addressed by: https:/
api-ref: verify os-server-
Addressed by: https:/
api-ref: verify os-certificates
Addressed by: https:/
api-ref: verify keypairs
Addressed by: https:/
api-ref: add version 2.3 parameters to servers
Addressed by: https:/
api-ref: body verification of ips.inc
Addressed by: https:/
api-ref: verfiy limits body
Addressed by: https:/
api-ref: parameter verification os-fixed-ips
Addressed by: https:/
api-ref: verify images.inc
Addressed by: https:/
api-ref: verify assisted-
Gerrit topic: https:/
Addressed by: https:/
api-ref: added docs for microversion 2.26
Addressed by: https:/
api-ref: Fix parameters in os-instance-
Addressed by: https:/
api-ref: parameter verification os-agents
Addressed by: https:/
api-ref: parameter verification os-security-groups
Addressed by: https:/
api-ref example verification for os-floating-ips
Addressed by: https:/
api-ref: os-volumes.inc
Gerrit topic: https:/
Addressed by: https:/
api-ref: docs for microversion v2.28
Addressed by: https:/
api-ref: Improve os-instance_
Addressed by: https:/
api-ref, os-services.inc
Addressed by: https:/
Complete verification for os-floating-
Addressed by: https:/
Verify os-aggregates.inc on sample files
Addressed by: https:/
Add multiple create in document
Addressed by: https:/
api-ref: merge multiple create to servers.inc
Addressed by: https:/
api-ref: add not about os-certificates API
Addressed by: https:/
Complete verification for api-ref os-flavor-
Addressed by: https:/
api-ref: Parameter verification for os-simple-
Gerrit topic: https:/
Addressed by: https:/
WIP api-ref: Checking the parameters of servers-actions.inc
Addressed by: https:/
api-ref: correct the order of APIs in server-tags
Addressed by: https:/
api-ref: Example verification for os-agents.inc
Addressed by: https:/
api-ref: os-certificates.inc
Addressed by: https:/
Example verification for os-fixed-ips.inc
Addressed by: https:/
Complete verification for os-virtual-
Addressed by: https:/
Body Verification of api-ref os-volume-
Gerrit topic: https:/
Addressed by: https:/
api-ref: docs for microversion v2.34
Addressed by: https:/
api-ref: Example verification for os-simple-
Addressed by: https:/
Parameter verification of os-instance-
Addressed by: https:/
api-ref: Parameter verification for servers-actions.inc
Addressed by: https:/
api-ref: Example verification for servers-actions.inc
Addressed by: https:/
api-ref: Body verification for servers-actions.inc
Addressed by: https:/
api-ref: Example verification for servers.inc
Addressed by: https:/
api-ref: Body verification for servers.inc
Addressed by: https:/
api-ref: Complete all the verifications of remote consoles
Addressed by: https:/
api-ref: Body verification for os-hypervisor.inc
Addressed by: https:/
api-ref: example verification for os-hypervisors.inc
Addressed by: https:/
Body verification of os-interface.inc
Addressed by: https:/
api-ref: Parameter verification for servers-actions.inc Part 1
Addressed by: https:/
Example and body verification of os-quota-sets.inc
Addressed by: https:/
Complete verification of servers-
Addressed by: https:/
api-ref: unify the delete response infomation
Addressed by: https:/
api-ref: body verification of os-agents
Addressed by: https:/
Complete verification of os-instance-
Addressed by: https:/
Parameter verification of os-floating-
Addressed by: https:/
api-ref: fix wrong description about response example in os-hypervisor
Addressed by: https:/
api-ref: add sample file link for different microversion in hypervisors
Addressed by: https:/
Verify os-floating-
Addressed by: https:/
api-ref: Body verification for os-simple-
Addressed by: https:/
api-ref: unify the no response output in delete operation
Addressed by: https:/
[WIP] Complete verification of os-aggregates.inc
Addressed by: https:/
Change hypervisor_type to actual value
Addressed by: https:/
Change api-site to v2.1 format
Addressed by: https:/
Body Verification of os-aggregates.inc
Addressed by: https:/
Example & Parameter verification of os-security-
Addressed by: https:/
Fix server group name on api-ref
Addressed by: https:/
Fix the name of DNS entry on api-ref
Addressed by: https:/
Fix server name on api-ref
Addressed by: https:/
Rename 'name' to 'secgroup_name' in api-ref
Addressed by: https:/
Correct sort_key and sort_dir parameter for flavor
Addressed by: https:/
Correct image.inc for heading and ordering
Addressed by: https:/
Correct address parameter for server IP API
Addressed by: https:/
Fix order of Create and Show method in os-aggregates.inc
Addressed by: https:/
Complete verification for os-cloudpipe.inc
Addressed by: https:/
Add hypervisor_links into hypervisor
Addressed by: https:/
Trivial fix remove not used var in parameters
Addressed by: https:/
Add keypairs_links into resp
Addressed by: https:/
fix broken link in api-ref
Let's consider this closed for newton. I've created a follow up blueprint for ocata here:
https:/
-- mriedem 20160915
Gerrit topic: https:/
Addressed by: https:/
api-ref: Body verification for os-simple-
Addressed by: https:/
api-ref: Fix examples for add/removeFixedIp action
Work Items
Dependency tree
* Blueprints in grey have been implemented.
