18 Commits

Author SHA1 Message Date
Vishakha Agarwal
311184c394 Fix api-ref for list endpoints
According to the [1], list endpoints filter also have
``region_id`` parameter which is missing from api-ref.
This patch updates the same in api-ref.

[1]https://github.com/openstack/keystone/blob/master/keystone/api/endpoints.py#L78

Change-Id: I3982c98506f945b47c056ed1c9e5eee673a3662a
2020-07-28 17:40:54 +00:00
Victor Coutellier
e74a61f091 Add service name filter to service list api-ref
Filter services by name is possible[1] but not documented in the
Keystone api-ref[2]. This commit add the filter in the doc.

[1] https://github.com/openstack/keystone/blob/master/keystone/api/services.py#L37
[2] https://docs.openstack.org/api-ref/identity/v3/?expanded=list-services-detail#list-services

Change-Id: I91dea69a4c30fe37a23f3697cb8511fed0bfcec7
Closes-Bug: #1877851
2020-05-15 12:02:22 +00:00
Vishakha Agarwal
c7331ccd24 Fix wrong interface description
In [1] it response parameters, it is written interface body  string
(Deprecated in v3.2) The geographic location of the service endpoint.
This patch fixes the wrong documentation.

[1] https://docs.openstack.org/api-ref/identity/v3/?expanded=list-endpoints-detail,show-endpoint-details-detail#service-catalog-and-endpoints

Change-Id: I09063dfec1afcd823f5fa190626e8719a202fc28
2019-10-09 15:36:07 +05:30
Suramya Shah
ba6c5afbfd Reorganize api-ref: v3 service-catalog
Reorganize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup

Change-Id: I1a0e8d2606096f26258e4d15efb550ce63df317a
2017-12-28 13:19:40 +05:30
Samuel Pilla
c90db0375e Renaming of api parameters
Some parameters of similar name would follow the convention
such as `region_id` and `region_id_1` which gave no good
information as to the differences.

This patch changes these names to help give such information.

Change-Id: I2dec61ed06042990ff54e86c02dc3fca9d566366
2017-02-03 15:23:40 -06:00
Jenkins
9bb57c1eb7 Merge "Update endpoint api for optional region_id" 2017-02-03 18:12:29 +00:00
Samuel Pilla
49632aee6d Update endpoint api for optional region_id
As per the bug, 'name' and 'nme' are not part of the 'endpoint'
table and were being assigned to the 'extras' column. This is
why they are not being validated.

The endpoint docs also show that `region_id` is not optional, even
though it is. This updates the docs to reflect optional `region_id`.

Closes-Bug: #1579014
Change-Id: I085b75c59767eb96b3bdfe3b887e5e2639122a34
2017-01-31 09:27:57 -06:00
Eric Brown
30d9095d28 Use https for docs.openstack.org references
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.

Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 16:05:08 -08:00
tengqm
4d4faabf14 Tweak api-ref doc for services/endpoints
This patch reorders the sections about services and endpoints which were
previously interleaved randomly. After the reordering, all services APIs
appear before all endpoint APIs so browsing through the APIs would be
much easier. This patch aslo changes the representations of status codes
using the new stanza in os-api-ref.

Change-Id: I89aabd3d9a336f5f6f65aaca51353f2d23b4cb2a
2016-09-12 21:14:11 -04:00
tengqm
fbe462f031 Fix problems in service api doc
This patch fixes the following problems found in the api doc:

- The 'service_id' field should not appear in a service create request;
- The 'enabled', 'description' fields should be optional when doing a
  service update.

Change-Id: Iac91a9f2d29a458f1e3eb93e64fea6a508b9980c
2016-09-05 09:14:25 -04:00
Anh Tran
43df6125f9 api-ref: Splitting status lines in API v3.
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.

Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
gage hugo
d36e555788 [api] add relationship links to v3
Nearly all the "relationship" links are missing in v3 APIs.

Added relationship links to v3 API pages.

Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8
Partial-Bug: #1609159
2016-08-11 15:17:59 -05:00
Anh Tran
6919253c8f api-ref: Correcting V3 Endpoints APIs
Correcting all parameters of Show/Create/List/Update/Delete APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html?#show-endpoint-details

Change-Id: Iea796c4cd475bd0bb2879f4810abf9a645ff58ea
Partial-Bug: #1610777
2016-08-09 14:17:00 +07:00
Anh Tran
9a520bcfa8 api-ref: Correcting V3 Services APIs
Correcting all parameters of services APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html?expanded=#list-services
Rename parameters for more easy to maintain.

Change-Id: I9819c19032c93bab9a613bf94b4b95dda722ced9
Partial-Bug: #1610777
2016-08-09 14:17:00 +07:00
Dave Chen
caa3a91b68 Remove name property from endpoint create/update API
`endpoint` doesn't need `name` property by default, remove
them from the doc, this change make it align with V3 API SPEC.

Change-Id: I61429b39086d15aed7d2315d7c3971727a9fa419
2016-07-15 18:44:25 +08:00
Lance Bragstad
efcbc622ad Correct normal response codes in service catalog doc
20X http status codes do not represent errors.

Change-Id: I447719742fd4b1bd640484d00b687b0340aed068
2016-07-13 19:50:17 +00:00
Steve Martinelli
ebccd23b78 Add missing preamble for v3 and v3-ext
The api-ref site had a short blurb about the resources listed
in the document, add that back.

Change-Id: I2bac40a250a5b73fb70320d598a12c34c359e3c2
2016-07-04 14:35:49 -07:00
Samuel de Medeiros Queiroz
9a5395f1b2 Migrate identity /v3 docs from api-ref repo
Docs at [1] have already been converted from WADL (SGML / XML) to RST
using fairy-slipper [2].

This commit polish the results from the conversion and migrate the docs
to our repository under 'api-ref/source' directory. In addition, it
added missing descriptions for access_token_id and consumer_id to
'parameters.yaml'.

Polishing the generated RST files include:
- Removing unnecessary blank lines;
- Removing empty references.

Polishing the generated RST files do not include:
- Modifying their content;
- Modifying file names;
- Wrapping lines at the maximum of 79 chars.

Updating the documentation will be done after this migration step.

This change also adds a tox environment to build the docs using sphinx
under 'api-ref/build', which in turn is added to '.gitignore'.

Lastly, 'os-api-ref' is added as a test requirement. It provides the
sphinx stanzas rest_method and rest_parameter, used to define OpenStack
APIs in RST docs.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-24 09:58:23 -03:00