Neutron in-tree API reference
We now maintain Networking API reference in neutron repositories. There are many things to clean up.
This blueprint is used to track the series of efforts of cleaning up the api-ref.
The detail instructions and guidelines are described in https:/
Blueprint information
- Status:
- Complete
- Approver:
- Armando Migliaccio
- Priority:
- Low
- Drafter:
- Akihiro Motoki
- Direction:
- Approved
- Assignee:
- Akihiro Motoki
- Definition:
- Approved
- Series goal:
- Accepted for queens
- Implementation:
-
Implemented
- Milestone target:
-
queens-3
- Started by
- Akihiro Motoki
- Completed by
- Akihiro Motoki
Related branches
Related bugs
Sprints
Whiteboard
Feb 28, I filed the following bugs on the remaining TODOs, so we can close this blueprint.
- Merge all API references in wiki, neutron-specs and neutron-lib into neutron-lib https:/
- Write a document on API reference guideline https:/
Feb 24, 2017 - All existing API reference have been cleanup.
The following points are remaining in my mind.
- Merge all descriptions which spread wiki, neutron-specs and neutron-lib into neutron-lib. -> bug 1752274
- Write a document on API reference guideline which we have on the etherpad page now -> bug 1752275
- Clean up unused definitions in parameters.yaml. -> DONE
Jan 23, 2017 - 5 of 6 remaining API => patches from amotoki under review, Anindita Das from Intel takes care of 1 of 6 (QoS).
Jan 17, 2017 - 18/24 have been completed. Regarding remaining 6, 3 are under review, 2 need assignee (I will pick them up) and 1 (LBaaS v1) needs to be clean up.
Dec-01-2016(armax): chipping away at the ref.
Gerrit topic: https:/
Addressed by: https:/
Merge v2 and v2-ext into one directory
Addressed by: https:/
Move sample JSON files under v2 directory
Addressed by: https:/
Rename file names for consistency
Addressed by: https:/
api-ref: Fix api-ref for routers
Addressed by: https:/
api-ref: correct show description of security_group_id paramater
Addressed by: https:/
Correting Floating IPs
Addressed by: https:/
api-ref: Adding request parameter for security-group-rule
Addressed by: https:/
[WIP]api-ref: Fix api-ref for subnets
Addressed by: https:/
api-ref: Fix api-ref for metering
Addressed by: https:/
api-ref: Fix api-ref for service-providers
Addressed by: https:/
Correcting Networking API v2.0 flavor extension
Addressed by: https:/
api-ref: Correcting Network v2.0 API extensions
Addressed by: https:/
api-ref: Add Networking v2.0 API versions response parameters
Addressed by: https:/
api-ref: Fix api-ref for vpnaas
Addressed by: https:/
[WIP]api-ref: Fix api-ref for lbaas-v2
Addressed by: https:/
[WIP]api-ref: Fix api-ref for lbaas-v1
Addressed by: https:/
[WIP] api-ref: Fix api-red for fwaas
Addressed by: https:/
[WIP] api-ref: Fix api-ref for port-binding
Addressed by: https:/
Add info about API method to get default quotas
Addressed by: https:/
api-ref: Refactoring parameters in Networks APIs
Addressed by: https:/
api-ref: Fix api-ref for subnetpools
Addressed by: https:/
api-ref: Refactoring parameters in Ports APIs
Addressed by: https:/
api-ref: project_id in req/resp body should be "body"
Addressed by: https:/
Improve floatingip api-ref
Addressed by: https:/
api-ref: Fix api-ref for ports
Gerrit topic: https:/
Addressed by: https:/
api-ref: Improve network IP availability extension
Addressed by: https:/
api-ref: Correct port binding extension
Addressed by: https:/
api-ref: Fix LBaaS v1 API reference
Gerrit topic: https:/
Addressed by: https:/
api-ref: Correcting QoS policies in API extension
