openstack/barbican
Code Issues Proposed changes

Update api-ref location

Browse Source 
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

Fix api-guide building: Use docs requirements.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I16af26b25e36ab1281f109cd5765db1ead9f3df6
This commit is contained in:
Andreas Jaeger 2019-07-22 18:48:12 +02:00
parent bf95c37b84
commit 6e193a308e
6 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-guide/source/acls.rst
View File

@ -342,7 +342,7 @@ returned on successful deletion.
Delete operation removes existing ACL on a secret or a container if there. It
can be treated as resetting a secret or a container to
`Default ACL <https://developer.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
`Default ACL <https://docs.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
setting. That's why invoking delete multiple times on this resource will not
result in error.

2
doc/source/admin/access_control.rst
View File

@ -82,4 +82,4 @@ access to only a single secret.
To address this limitations the Key Manager service includes an Access Control
List (ACL) API. For full details see the
`ACL API User Guide <http://developer.openstack.org/api-guide/key-manager/acls.html>`__
`ACL API User Guide <https://docs.openstack.org/api-guide/key-manager/acls.html>`__

2
doc/source/api/index.rst
View File

@ -6,7 +6,7 @@ User Guide
##########
API guide docs are built to:
https://developer.openstack.org/api-guide/key-manager/
https://docs.openstack.org/api-guide/key-manager/
API Reference
#############

4
doc/source/api/reference/acls.rst
View File

@ -27,7 +27,7 @@ GET /v1/secrets/{uuid}/acl
Retrieve the ACL settings for a given secret.
If no ACL is defined for that secret, then
`Default ACL <https://developer.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
`Default ACL <https://docs.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
is returned.
Request/Response (With ACL defined):
@ -327,7 +327,7 @@ GET /v1/containers/{uuid}/acl
Retrieve the ACL settings for a given container.
If no ACL is defined for that container, then
`Default ACL <https://developer.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
`Default ACL <https://docs.openstack.org/api-guide/key-manager/acls.html#default-acl>`__
is returned.
Request/Response (With ACL defined):

2
doc/source/index.rst
View File

@ -9,7 +9,7 @@ API Guide
==========
If you're trying to learn how to use barbican, you can start by reading about
`Secrets in the Barbican API Guide <https://developer.openstack.org/api-guide/key-manager/secrets.html>`__.
`Secrets in the Barbican API Guide <https://docs.openstack.org/api-guide/key-manager/secrets.html>`__.
Once you're comfortable working with secrets you can dig into the rest of the
API.

2
tox.ini
View File

@ -90,7 +90,7 @@ whitelist_externals = rm
[testenv:api-guide]
basepython = python3
# This environment is called from CI scripts to test and publish
# the API Guide to developer.openstack.org.
# the API Guide to docs.openstack.org.
deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -rf api-guide/build