Browse Source

Update api-ref location

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.

This does not relationship URIs since "these links do not resolve to
anything valid, but exist to show a relationship."

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

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

Change-Id: I6efdf375bc8e1e5ca2b113337002d6178180a1e1
changes/96/672096/3
Andreas Jaeger 2 years ago
parent
commit
23b0011535
  1. 2
      README.rst
  2. 2
      doc/source/admin/endpoint-filtering.rst
  3. 4
      doc/source/admin/endpoint-policy.rst
  4. 16
      doc/source/admin/federation/configure_federation.rst
  5. 4
      doc/source/admin/oauth1.rst
  6. 4
      doc/source/admin/security-compliance.rst
  7. 4
      doc/source/contributor/http-api.rst
  8. 10
      doc/source/contributor/programming-exercises.rst
  9. 2
      doc/source/index.rst
  10. 2
      doc/source/user/application_credentials.rst
  11. 2
      doc/source/user/index.rst

2
README.rst

@ -23,7 +23,7 @@ published at:
The API reference and documentation are available at:
https://developer.openstack.org/api-ref/identity
https://docs.openstack.org/api-ref/identity
The canonical client library is available at:

2
doc/source/admin/endpoint-filtering.rst

@ -21,5 +21,5 @@ For example:
[endpoint_filter]
return_all_endpoints_if_no_filter = False
See `API Specification for Endpoint Filtering <https://developer.openstack.org/
See `API Specification for Endpoint Filtering <https://docs.openstack.org/
api-ref/identity/v3-ext/#os-ep-filter-api>`_ for the details of API definition.

4
doc/source/admin/endpoint-policy.rst

@ -13,6 +13,6 @@ section. For example:
[endpoint_policy]
driver = sql
See `API Specification for Endpoint Policy <https://developer.openstack.org/
See `API Specification for Endpoint Policy <https://docs.openstack.org/
api-ref/identity/v3-ext/index.html#os-endpoint-policy-api>`_
for the details of API definition.
for the details of API definition.

16
doc/source/admin/federation/configure_federation.rst

@ -91,7 +91,7 @@ Provider to keystone and align remote user attributes with keystone objects:
See also the `keystone federation API reference`_.
.. _keystone federation API reference: https://developer.openstack.org/api-ref/identity/v3-ext/#os-federation-api
.. _keystone federation API reference: https://docs.openstack.org/api-ref/identity/v3-ext/#os-federation-api
Create an Identity Provider
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -131,7 +131,7 @@ be used by the mapping and protocol, and later for authentication.
See also the `API reference on identity providers`_.
.. _API reference on identity providers: https://developer.openstack.org/api-ref/identity/v3-ext/#identity-providers
.. _API reference on identity providers: https://docs.openstack.org/api-ref/identity/v3-ext/#identity-providers
Create a Mapping
~~~~~~~~~~~~~~~~
@ -209,7 +209,7 @@ Mappings can be quite complex. A detailed guide can be found on the
See also the `API reference on mapping rules`_.
.. _API reference on mapping rules: https://developer.openstack.org/api-ref/identity/v3-ext/#mappings
.. _API reference on mapping rules: https://docs.openstack.org/api-ref/identity/v3-ext/#mappings
Create a Protocol
~~~~~~~~~~~~~~~~~
@ -229,7 +229,7 @@ arbitrary, it must be a valid auth method.
See also the `API reference for federation protocols`_.
.. _API reference for federation protocols: https://developer.openstack.org/api-ref/identity/v3-ext/#protocols
.. _API reference for federation protocols: https://docs.openstack.org/api-ref/identity/v3-ext/#protocols
Configuring an HTTPD auth module
--------------------------------
@ -496,8 +496,8 @@ Remember to restart the web server when finished configuring horizon:
# systemctl restart apache2
.. _WebSSO API without an Identity Provider: https://developer.openstack.org/api-ref/identity/v3-ext/index.html#web-single-sign-on-authentication-new-in-version-1-2
.. _WebSSO API specific to the given Identity Provider: https://developer.openstack.org/api-ref/identity/v3-ext/index.html#web-single-sign-on-authentication-new-in-version-1-3
.. _WebSSO API without an Identity Provider: https://docs.openstack.org/api-ref/identity/v3-ext/index.html#web-single-sign-on-authentication-new-in-version-1-2
.. _WebSSO API specific to the given Identity Provider: https://docs.openstack.org/api-ref/identity/v3-ext/index.html#web-single-sign-on-authentication-new-in-version-1-3
Authenticating
--------------
@ -630,7 +630,7 @@ configured in the ``[saml]`` section (not to be confused with an optional
Attribute`_ while setting up keystone as Service Provider) of ``keystone.conf``
so that it can served by the `metadata API`_.
.. _metadata API: https://developer.openstack.org/api-ref/identity/v3-ext/index.html#retrieve-metadata-properties
.. _metadata API: https://docs.openstack.org/api-ref/identity/v3-ext/index.html#retrieve-metadata-properties
The two parameters that **must** be set in order for keystone to generate
metadata are ``idp_entity_id`` and ``idp_sso_endpoint``:
@ -721,7 +721,7 @@ metadata:
$ curl -s https://sp.keystone.example.org/Shibboleth.sso/Metadata | grep urn:oasis:names:tc:SAML:2.0:bindings:PAOS
<md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:PAOS" Location="https://sp.keystone.example.org/Shibboleth.sso/SAML2/ECP" index="4"/>
.. _federated auth endpoint: https://developer.openstack.org/api-ref/identity/v3-ext/index.html#request-an-unscoped-os-federation-token
.. _federated auth endpoint: https://docs.openstack.org/api-ref/identity/v3-ext/index.html#request-an-unscoped-os-federation-token
Authenticating
--------------

4
doc/source/admin/oauth1.rst

@ -31,6 +31,6 @@ To enable OAuth1:
WSGIPassAuthorization On
See `API Specification for OAuth 1.0a <https://developer.openstack.org/
See `API Specification for OAuth 1.0a <https://docs.openstack.org/
api-ref/identity/v3-ext/index.html#os-oauth1-api>`_ for the details of
API definition.
API definition.

4
doc/source/admin/security-compliance.rst

@ -89,7 +89,7 @@ password upon first use by setting ``change_password_upon_first_use``:
[security_compliance]
change_password_upon_first_use = True
.. _`user API`: http://developer.openstack.org/api-ref/identity/v3/index.html#users
.. _`user API`: https://docs.openstack.org/api-ref/identity/v3/index.html#users
Configuring password expiration
-------------------------------
@ -200,4 +200,4 @@ keystone.
.. _Security Hardening PCI-DSS: https://specs.openstack.org/openstack/keystone-specs/specs/keystone/newton/pci-dss.html
.. _v3: https://developer.openstack.org/api-ref/identity/v3/index.html#update-user
.. _v3: https://docs.openstack.org/api-ref/identity/v3/index.html#update-user

4
doc/source/contributor/http-api.rst

@ -26,7 +26,7 @@ Identity API v3 is a superset of all the functionality available in the
Identity API v2.0 and several of its extensions, and provides a much more
consistent developer experience.
.. _`Identity API v3`: https://developer.openstack.org/api-ref/identity/v3/
.. _`Identity API v3`: https://docs.openstack.org/api-ref/identity/v3/
History
=======
@ -112,7 +112,7 @@ I have a non-Python client
You'll likely need to heavily reference our `API documentation`_ to port your
application to Identity API v3.
.. _`API documentation`: https://developer.openstack.org/api-ref/identity/v3/
.. _`API documentation`: https://docs.openstack.org/api-ref/identity/v3/
The most common operation would be password-based authentication including a
tenant name (i.e. project name) to specify an authorization scope. In Identity

10
doc/source/contributor/programming-exercises.rst

@ -72,11 +72,11 @@ steps:
#. Document the new parameter in the `api-ref`_
.. _POST /v3/projects: https://developer.openstack.org/api-ref/identity/v3/#create-project
.. _PATCH /v3/projects/{project_id}: https://developer.openstack.org/api-ref/identity/v3/#update-project
.. _GET /v3/projects/{project_id}: https://developer.openstack.org/api-ref/identity/v3/#show-project-details
.. _POST /v3/projects: https://docs.openstack.org/api-ref/identity/v3/#create-project
.. _PATCH /v3/projects/{project_id}: https://docs.openstack.org/api-ref/identity/v3/#update-project
.. _GET /v3/projects/{project_id}: https://docs.openstack.org/api-ref/identity/v3/#show-project-details
.. _API Change tutorial: :doc:`api_change_tutorial`
.. _api-ref: https://developer.openstack.org/api-ref/identity/
.. _api-ref: https://docs.openstack.org/api-ref/identity/
Write an External Driver
========================
@ -115,6 +115,6 @@ add the plugin to `keystoneauth`_ so that Python clients can also use this auth
method.
.. _unscoped token: :doc:`../admin/tokens`
.. _POST /v3/auth/tokens: https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
.. _POST /v3/auth/tokens: https://docs.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
.. _Authentication Plugins: :doc:`auth-plugins`
.. _keystoneauth: https://docs.openstack.org/keystoneauth/latest/

2
doc/source/index.rst

@ -30,7 +30,7 @@ This documentation is generated by the Sphinx toolkit and lives in the `source
tree`_. Also see the :doc:`getting-started/community` page for other ways to interact with the
community.
.. _`OpenStack's Identity API`: https://developer.openstack.org/api-ref/identity/index.html
.. _`OpenStack's Identity API`: https://docs.openstack.org/api-ref/identity/index.html
.. _`source tree`: https://opendev.org/openstack/keystone/src/branch/master/doc/source
Related Projects

2
doc/source/user/application_credentials.rst

@ -31,7 +31,7 @@ single-signon system.
See the `Identity API reference`_ for more information on authenticating with
and managing application credentials.
.. _`Identity API reference`: https://developer.openstack.org/api-ref/identity/v3/index.html#application-credentials
.. _`Identity API reference`: https://docs.openstack.org/api-ref/identity/v3/index.html#application-credentials
Managing Application Credentials
================================

2
doc/source/user/index.rst

@ -20,7 +20,7 @@ User Documentation
An end user can find the specific API documentation here, `OpenStack's Identity API`_.
.. _`OpenStack's Identity API`: https://developer.openstack.org/api-ref/identity/v3
.. _`OpenStack's Identity API`: https://docs.openstack.org/api-ref/identity/v3
.. toctree::
:maxdepth: 1

Loading…
Cancel
Save