Difference between revisions of "Blueprint-os-api-docs"
(→Strategy) |
(→Summary) |
||
Line 21: | Line 21: | ||
! Document !! Change !! Purpose | ! Document !! Change !! Purpose | ||
|- | |- | ||
− | | OpenStack API References || Delete || Get rid of the existing API References (http://docs.openstack.org/api/api- | + | | OpenStack API References || Delete || Get rid of the existing API References (http://docs.openstack.org/api/api-ref-guides.html). |
Explains API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud. <br /> | Explains API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud. <br /> | ||
|- | |- |
Revision as of 21:02, 24 September 2013
- Launchpad Entry: Design for OpenStack API Docs
- Created: Diane Fleming
- Contributors:
- Related Blueprint: Blueprint-restructure-documentation
Contents
- 1 Strategy
- 2 Summary
- 3 Audience
- 4 BLUEPRINT: OpenStack API Guide (new)
- 4.1 CHAPTER 1: API Concepts
- 4.2 CHAPTER 2: Authentication
- 4.3 CHAPTER 3: Request/Response Types
- 4.4 CHAPTER 4: Links and References
- 4.5 CHAPTER 5: Paginated Collections
- 4.6 CHAPTER 6: Efficient Polling with the Changes-Since Parameter
- 4.7 CHAPTER 7: Limits
- 4.8 CHAPTER 8: Versions
- 4.9 CHAPTER 9: Extensions
- 4.10 CHAPTER 10: Faults
- 4.11 COMMON Glossary
- 5 BLUEPRINT: OpenStack project API Reference/s (delete)
- 6 BLUEPRINT: OpenStack API Complete Reference web pages (revised)
Strategy
- Eliminate the existing API References: http://docs.openstack.org/api/api-ref-guides.html.
- Add an API Guide that describes API concepts, general information, and ways to access the APIs.
- Move material currently in the API Reference/s into the WADL files to source the API Complete Reference pages. One web page for each OpenStack project. Source code samples from nova code base where possible.
End result: One API Reference page for each project and one API Guide.
Summary
Document | Change | Purpose |
---|---|---|
OpenStack API References | Delete | Get rid of the existing API References (http://docs.openstack.org/api/api-ref-guides.html).
Explains API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud. |
OpenStack API Guide | New | Introduces developers to API concepts, common tasks, and ways of interacting with the OpenStack APIs.
Explains API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud. |
OpenStack API Complete Reference web pages | Revised | Provides developers with searchable and comprehensive Web pages that list API methods and parameters, with examples for each. |
Audience
This blueprint describes a plan to create documentation for OpenStack application developers and contributors.
In addition to providing documentation to experienced developers, this documentation will also describe the next step for end users who know how to use the dashboard and client commands to interact with an OpenStack cloud and who want to progress to using the APIs directly or indirectly through cURL commands or open SDKs.
BLUEPRINT: OpenStack API Guide (new)
Purpose
- Introduces developers to API concepts, common tasks, and ways of interacting with the OpenStack APIs.
- Provides guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud.
Source material
- Python Developer Documentation
- Language Bindings Documentation
- Continuous Integration (CI) Developer Documentation
- Programming OpenStack Compute API with Shell and Python
- API Reference/s
Outline
CHAPTER 1: API Concepts
Cull material from existing API Reference/s. Also talk about how to access the APIs.
CHAPTER 2: Authentication
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 3: Request/Response Types
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 4: Links and References
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 5: Paginated Collections
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 6: Efficient Polling with the Changes-Since Parameter
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 7: Limits
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 8: Versions
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 9: Extensions
Cull material from existing API Reference/s. Provide working examples.
CHAPTER 10: Faults
Cull material from existing API Reference/s. Provide working examples.
COMMON Glossary
BLUEPRINT: OpenStack project API Reference/s (delete)
Strategy
Eliminate these books:
- Block Storage Service API v2 Reference
- Compute API v2 and Extensions Reference
- Identity Service API v2.0 Reference
- Networking API v2.0 Reference
- Image Service API v2 Reference
- Image Service API v1 Reference
- Object Storage API v1 Reference
- Programming Compute API with Shell and Python, 1st ed.
Move material from these books into the WADL files that source the API Complete Reference web pages.
BLUEPRINT: OpenStack API Complete Reference web pages (revised)
Purpose
- Provides developers with searchable and comprehensive Web pages that list API methods and parameters, with examples for each.
- Provides one reference page for each project: Compute, Image Service, Identity Service, Object Storage, Networking, Orchestration, and Block Storage Service. (already implemented)
- Sources reference information from WADL files.
- Pulls material from existing API Reference/s into WADL files so everything is single-sourced from WADL files.
- Review and improve the existing output so that it includes complete descriptions, request and response parameters, and tested code samples.
Source materials
- API Reference - sourced from WADL files
- API Reference/s - Pull material from existing API Reference/s into WADL files so everything is single-sourced from WADL files.