Difference between revisions of "Blueprint-os-api-docs"
(Created page with "new page") |
|||
| Line 1: | Line 1: | ||
| − | new page | + | == Deliverables - Application Developers and OpenStack Contributors == |
| + | |||
| + | '''Audience:''' People who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.<br /> | ||
| + | |||
| + | '''Release info:''' API v''n''<br /> | ||
| + | |||
| + | '''Include common glossary?''' Yes<br /> | ||
| + | |||
| + | '''Strategy:''' | ||
| + | * Provide 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 that source the API Complete Reference pages. | ||
| + | * Get rid of the API Reference/s. | ||
| + | * Source code samples from nova code base where possible. | ||
| + | * End result: One API Reference page for each project and one API Guide. | ||
| + | <br /> | ||
| + | |||
| + | |||
| + | '''Blueprint:''' [[Blueprint-os-api-docs|Blueprint - OpenStack API Documentation]] | ||
| + | |||
| + | === OpenStack API Guide (new) === | ||
| + | |||
| + | '''Purpose''' | ||
| + | |||
| + | * Explain API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud.<br /><br /> | ||
| + | |||
| + | '''Source material''' | ||
| + | |||
| + | * Python Developer Documentation | ||
| + | * Language Bindings Documentation | ||
| + | * Continuous Integration (CI) Developer Documentation | ||
| + | * Programming OpenStack Compute API with Shell and Python | ||
| + | * API Reference/s | ||
| + | |||
| + | === OpenStack ''project'' API Reference/s (delete) === | ||
| + | |||
| + | '''Strategy''' | ||
| + | * Eliminate these books. | ||
| + | * Move material from these books into the WADL files that source the API Complete Reference web pages. | ||
| + | |||
| + | === OpenStack API Complete Reference (web pages) === | ||
| + | |||
| + | '''Purpose''' | ||
| + | |||
| + | * Provide one reference page for each project: Compute, Image Service, Identity Service, Object Storage, Networking, Orchestration, and Block Storage Service. (already implemented) | ||
| + | * Source reference information from WADL files. | ||
| + | * Pull material from existing API Reference/s into WADL files so everything is single-sourced from WADL files. | ||
| + | * Provide ''developers'' with searchable and comprehensive Web pages that list API methods and parameters, with examples for each. | ||
| + | * Exclude guidance information (this goes in the ''OpenStack API Guide''), installation instructions, or feature descriptions that are longer than one sentence.<br /><br /> | ||
| + | |||
| + | '''Source material''' | ||
| + | * API Reference - sourced from WADL files | ||
Revision as of 15:13, 22 September 2013
Contents
Deliverables - Application Developers and OpenStack Contributors
Audience: People who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.
Release info: API vn
Include common glossary? Yes
Strategy:
- Provide 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 that source the API Complete Reference pages.
- Get rid of the API Reference/s.
- Source code samples from nova code base where possible.
- End result: One API Reference page for each project and one API Guide.
Blueprint: Blueprint - OpenStack API Documentation
OpenStack API Guide (new)
Purpose
- Explain API concepts and provide 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
OpenStack project API Reference/s (delete)
Strategy
- Eliminate these books.
- Move material from these books into the WADL files that source the API Complete Reference web pages.
OpenStack API Complete Reference (web pages)
Purpose
- Provide one reference page for each project: Compute, Image Service, Identity Service, Object Storage, Networking, Orchestration, and Block Storage Service. (already implemented)
- Source reference information from WADL files.
- Pull material from existing API Reference/s into WADL files so everything is single-sourced from WADL files.
- Provide developers with searchable and comprehensive Web pages that list API methods and parameters, with examples for each.
- Exclude guidance information (this goes in the OpenStack API Guide), installation instructions, or feature descriptions that are longer than one sentence.
Source material
- API Reference - sourced from WADL files
