This patch, as a first step, fixes inaccuracies/bugs in api-ref
documentation for stacks. The major changes in this patch include:
- Added missing 'location' and 'X-OpenStack-Request-Id' parameters
which both appear in some response headers.
- Deleted some descriptions about parameters that are never
referenced in any APIs.
- Added missing 'deletion_time' parameter.
- Added missing 'environment_files' parameter.
- Added missing sample JSON file for stack-create-response.json.
- Fixed errors in stack-preview-response.json.
- Added tabular description of response codes.
- Added a status.yaml file for response code description (shared).
Change-Id: I826ed899f925812df9b44144469700453789e087
This patch splits the stacks.inc file into three files so that we can
patch them separately. The original file contains API calls about
stacks, stack snapshots and stack outputs, however, the latter two
have every right to be documented separately.
Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
The current api documentation for software deployment is a mess. This
patch is an attempt to fix it.
Change-Id: I41da79865c2836e6750314497e910982bc5462a9
This patch adds the missing list operation on software configs. It also
reorders the operations on configs/deployments so that finding API docs
will be a little bit easier.
Change-Id: I26e4b34000b71c61f9d9de327c7754ff9031d6b4
We support to get the deleted stacks by filter in stack-list
api, support to show the deleted stack by stack-id,
so to show the 'deletion_time' info of stacks.
Change-Id: I8c55fe7f6a899ca66aa3fef15c93195c03c5aa11
Closes-Bug: #1587214
api-ref resource list is updated to detail
on the filtering supported.
As part of this change, event list related
filtering parameters updated to leverage them
in resource filtering.
Change-Id: I61fc302219cc875e23ee1f2d57394196f64c8e63
api-ref is updated for template validate REST API
to provide details on the ignore_errors query
parameter.
Change-Id: I9e2911c7fbe708913b6f143c6d4e408b148ce672
In Id3a71841f5b9a9ea7bb5803afd967ab4feadfe10 the in tree copy of
os-api-ref was migrated to the upstream version. The html_static_path
setting in conf.py was forgotten in the patch, which caused a warning
when building the API reference.
This patch comments out the setting from conf.py to prevent the
warning.
TrivialFix
Change-Id: I267b3f671fdfa2033c24d9407c7bed7e8527e9a2
This removes the in tree copy of os-api-ref and migrates to the
upstream released version. It will fix the issues with the style
because the static files weren't in the right place in tree.
Change-Id: Id3a71841f5b9a9ea7bb5803afd967ab4feadfe10
This patch fixes errors with the include directives generated by the
api-site team for the migration. This patch fixes the errors by bringing
our api-ref docs in line with the existing docs; verifying that the
previous docs are still valid will be a separate initiative.
Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
This patch added two parameter: software_config and
software_deployments.
"software_config" add into "Create configuration" and
"Show configuration details".
"software_deployments" parameter add into "Show deployment details",
"Update deployment" and "Create deployment".
Change-Id: Iee5cb9affb5dd88cf8769bea20ff3934fcd43b07
Closes-Bug: #1567193
For more information, see:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
This is the initial port from api-site. The includes in
source/v1/index.rst are alphabetized, but we may want to revisit that
and reorder them according to importance.
Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048
Implements: blueprint api-doc-migration
