Skip to content

Commit

Permalink
Update api-ref location
Browse files Browse the repository at this point in the history
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 Neutron publishes to api-ref/network, not networking anymore.

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: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
  • Loading branch information
ajaeger committed Jul 22, 2019
1 parent 063ef48 commit dbe6321
Show file tree
Hide file tree
Showing 45 changed files with 95 additions and 95 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ API

To learn how to use Nova's API, consult the documentation available online at:

- `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`__
- `Compute API Reference <https://developer.openstack.org/api-ref/compute/>`__
- `Compute API Guide <https://docs.openstack.org/api-guide/compute/>`__
- `Compute API Reference <https://docs.openstack.org/api-ref/compute/>`__

For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

Expand Down
2 changes: 1 addition & 1 deletion api-guide/source/faults.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ There is an API for end users to list the outcome of Server Actions,
referencing the requested action by request id.

For more details, please see:
https://developer.openstack.org/api-ref/compute/#servers-run-an-action-servers-action
https://docs.openstack.org/api-ref/compute/#servers-run-an-action-servers-action

Logs
----
Expand Down
2 changes: 1 addition & 1 deletion api-guide/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ compute resources might be Virtual Machines, Physical Machines or Containers.

This guide covers the concepts in the OpenStack Compute API.
For a full reference listing, please see:
`Compute API Reference <https://developer.openstack.org/api-ref/compute/#compute-api>`__.
`Compute API Reference <https://docs.openstack.org/api-ref/compute/#compute-api>`__.

We welcome feedback, comments, and bug reports at
`bugs.launchpad.net/nova <https://bugs.launchpad.net/nova>`__.
Expand Down
4 changes: 2 additions & 2 deletions api-guide/source/limits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ operators and may differ from one deployment of the OpenStack Compute service
to another. Please contact your provider to determine the limits that
apply to your account. Your provider may be able to adjust your
account's limits if they are too low. Also see the API Reference for
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.

Absolute limits
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -49,4 +49,4 @@ Determine limits programmatically

Applications can programmatically determine current account limits. For
information, see
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.
4 changes: 2 additions & 2 deletions api-guide/source/server_concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ For more information, refer to `Block Device Mapping

For the full list of ``block_device_mapping_v2`` parameters available when
creating a server, see the `API reference
<https://developer.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server>`_.
<https://docs.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server>`_.

**Example for block_device_mapping_v2**

Expand Down Expand Up @@ -767,7 +767,7 @@ For more information on how scheduler hints are different from flavor extra
specs, refer to `this document`_.

.. _cloud's configuration: https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html
.. _the create-server-detail Request section: https://developer.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server
.. _the create-server-detail Request section: https://docs.openstack.org/api-ref/compute/?expanded=create-server-detail#create-server
.. _this document: https://docs.openstack.org/nova/latest/reference/scheduler-hints-vs-flavor-extra-specs.html#scheduler-hints

Server Consoles
Expand Down
2 changes: 1 addition & 1 deletion api-guide/source/versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ server might respond with a 302 redirection request.

For examples of the list versions and get version details requests and
responses, see `API versions
<https://developer.openstack.org/api-ref/compute/#api-versions>`__.
<https://docs.openstack.org/api-ref/compute/#api-versions>`__.

The detailed version response contains pointers to both a human-readable
and a machine-processable description of the API service.
4 changes: 2 additions & 2 deletions api-ref/source/images.inc
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
The image metadata APIs will fail with a 404 starting from
microversion 2.39.
See: `Relevant Image APIs
<https://developer.openstack.org/api-ref/image/v2/index.html>`__.
<https://docs.openstack.org/api-ref/image/v2/index.html>`__.

Lists, shows details and deletes images.
Also sets, lists, shows details, create, update and deletes image metadata.

An image is a collection of files that you use to create and rebuild a
server. By default, operators provide pre-built operating system images.
You can also create custom images. See: `Create Image Action
<https://developer.openstack.org/api-ref/compute/#create-image-createimage-action>`__.
<https://docs.openstack.org/api-ref/compute/#create-image-createimage-action>`__.

By default, the ``policy.json`` file authorizes all users to view the
image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.
Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This is a reference for the OpenStack Compute API which is provided by the Nova
project. To learn more about the OpenStack Compute API concepts, please refer to
the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
the `API guide <https://docs.openstack.org/api-guide/compute/index.html>`_.

.. rest_expand_all::

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-baremetal-nodes.inc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Nova has deprecated all the proxy APIs and users should use the native
APIs instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Bare metal APIs
<http://developer.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
<https://docs.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.

Bare metal nodes.

Expand Down
8 changes: 4 additions & 4 deletions api-ref/source/os-floating-ips.inc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.

Lists floating IP addresses for a project. Also, creates (allocates) a
floating IP address for a project, shows floating IP address details,
Expand All @@ -20,17 +20,17 @@ The cloud administrator configures a pool of floating IP addresses in
OpenStack Compute. The project quota defines the maximum number of
floating IP addresses that you can allocate to the project. After you
`allocate a floating IP
address <https://developer.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
address <https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
for a project, you can:

- `Add (associate) the floating IP
address <https://developer.openstack.org/api-ref/compute/#add-associate-floating-ip-
address <https://docs.openstack.org/api-ref/compute/#add-associate-floating-ip-
addfloatingip-action-deprecated>`__
with an instance in the project. You can associate only one floating
IP address with an instance at a time.

- `Remove (disassociate) the floating IP
address <https://developer.openstack.org/api-ref/compute/#remove-disassociate-
address <https://docs.openstack.org/api-ref/compute/#remove-disassociate-
floating-ip-removefloatingip-action-deprecated>`__
from an instance in the project.

Expand Down
4 changes: 2 additions & 2 deletions api-ref/source/os-hypervisors.inc
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ the ``policy.json`` file.
the totals and the usages. A more accurate representation of state can be
obtained using `placement`__.

__ https://developer.openstack.org/api-ref/placement/#list-resource-provider-usages
__ https://docs.openstack.org/api-ref/placement/#list-resource-provider-usages

Normal response codes: 200

Expand Down Expand Up @@ -202,7 +202,7 @@ the ``policy.json`` file.
the totals and the usages. A more accurate representation of state can be
obtained using `placement`__.

__ https://developer.openstack.org/api-ref/placement/#show-resource-provider-usages
__ https://docs.openstack.org/api-ref/placement/#show-resource-provider-usages

Normal response codes: 200

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-networks.inc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
using ``neutron`` directly. These will fail with a 404
starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.


Creates, lists, shows information for, and deletes networks.
Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-security-group-rules.inc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#security-group-rules-security-group-rules>`__.
<https://docs.openstack.org/api-ref/network/v2/#security-group-rules-security-group-rules>`__.

Creates and deletes security group rules.

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-security-groups.inc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#security-groups-security-groups>`__.
<https://docs.openstack.org/api-ref/network/v2/#security-groups-security-groups>`__.

Lists, shows information for, creates, updates and deletes security groups.

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-services.inc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Provides details why any services were disabled.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable compute services in the down cells
will be missing keys. See `handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-tenant-network.inc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Network APIs
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.

Creates, lists, shows information for, and deletes project networks.

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/os-volumes.inc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
deprecated all the proxy APIs and users should use the native APIs
instead. These will fail with a 404 starting from microversion 2.36.
See: `Relevant Volume APIs
<https://developer.openstack.org/api-ref/block-storage/v3/index.html>`__.
<https://docs.openstack.org/api-ref/block-storage/v3/index.html>`__.

Manages volumes and snapshots for use with the Compute API.
Lists, shows details, creates, and deletes volumes and snapshots.
Expand Down
22 changes: 11 additions & 11 deletions api-ref/source/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2348,7 +2348,7 @@ device_volume_type:
The device ``volume_type``. This can be used to specify the type of volume
which the compute service will create and attach to the server.
If not specified, the block storage service will provide a default volume
type. See the `block storage volume types API <https://developer.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
type. See the `block storage volume types API <https://docs.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
for more details.
There are some restrictions on ``volume_type``:
Expand Down Expand Up @@ -2980,7 +2980,7 @@ flavor_links_2_46:
description: |
Links to the flavor resource. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: true
Expand Down Expand Up @@ -3611,7 +3611,7 @@ hypervisor_links:
description: |
Links to the hypervisors resource. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
Expand Down Expand Up @@ -3926,7 +3926,7 @@ instance_actions_next_links:
Links pertaining to the instance action.
This parameter is returned when paging and more data is available.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
Expand Down Expand Up @@ -4177,7 +4177,7 @@ keypair_links:
description: |
Links pertaining to keypair. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
Expand Down Expand Up @@ -4294,7 +4294,7 @@ links:
description: |
Links to the resources in question. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: true
Expand Down Expand Up @@ -4617,7 +4617,7 @@ migration_links_2_23:
This parameter is returned if the migration type is ``live-migration`` and
the migration status is one of ``queued``, ``preparing``, ``running``
and ``post-migrating``. See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
Expand All @@ -4640,7 +4640,7 @@ migration_next_links_2_59:
Links pertaining to the migration.
This parameter is returned when paging and more data is available.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
required: false
Expand Down Expand Up @@ -6016,7 +6016,7 @@ server_links:
description: |
Links pertaining to the server. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
Expand Down Expand Up @@ -6159,7 +6159,7 @@ servers_links:
Links to the next server. It is available when the number of servers exceeds
``limit`` parameter or ``[api]/max_limit`` in the configuration file.
See `API Guide / Links and References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
Expand Down Expand Up @@ -6707,7 +6707,7 @@ usage_links:
description: |
Links pertaining to usage. See `API Guide / Links and
References
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
for more info.
in: body
type: array
Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/request-ids.inc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Users can specify the global request ID in the request header.
Users can receive the local request ID in the response header.

For more details about Request IDs, please reference: `Faults
<https://developer.openstack.org/api-guide/compute/faults.html>`_
<https://docs.openstack.org/api-guide/compute/faults.html>`_

**Request**

Expand Down
10 changes: 5 additions & 5 deletions api-ref/source/servers-actions.inc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ A pool of floating IP addresses, configured by the cloud administrator,
is available in OpenStack Compute. The project quota defines the maximum
number of floating IP addresses that you can allocate to the project.
After you `create (allocate) a floating IPaddress
<http://developer.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
<https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
for a project, you can associate that address with the server. Specify
the ``addFloatingIp`` action in the request body.

Expand Down Expand Up @@ -380,23 +380,23 @@ Specify the ``lock`` action in the request body.
Most actions by non-admin users are not allowed to the server
after this operation is successful and the server is locked.
See the "Lock, Unlock" item in `Server actions
<https://developer.openstack.org/api-guide/compute/server_concepts.html#server-actions>`_
<https://docs.openstack.org/api-guide/compute/server_concepts.html#server-actions>`_
for the restricted actions.
But administrators can perform actions on the server
even though the server is locked. Note that from microversion 2.73 it is
possible to specify a reason when locking the server.

The `unlock action
<https://developer.openstack.org/api-ref/compute/#unlock-server-unlock-action>`_
<https://docs.openstack.org/api-ref/compute/#unlock-server-unlock-action>`_
will unlock a server in locked state so additional actions can
be performed on the server by non-admin users.

You can know whether a server is locked or not and the ``locked_reason``
(if specified, from the 2.73 microversion) by the `List Servers Detailed API
<https://developer.openstack.org/api-ref/compute/#list-servers-detailed>`_
<https://docs.openstack.org/api-ref/compute/#list-servers-detailed>`_
or
the `Show Server Details API
<https://developer.openstack.org/api-ref/compute/#show-server-details>`_.
<https://docs.openstack.org/api-ref/compute/#show-server-details>`_.

Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
Expand Down
8 changes: 4 additions & 4 deletions api-ref/source/servers.inc
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ whitelist will be silently ignored.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable servers will be missing keys. See
`handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

Expand Down Expand Up @@ -301,7 +301,7 @@ request body to boot a server from a volume.
Include the ``key_name`` parameter in the create request body to add a
keypair to the server when you create it. To create a keypair, make a
`create keypair
<http://developer.openstack.org/api-ref/compute/#create-or-import-keypair>`__
<https://docs.openstack.org/api-ref/compute/#create-or-import-keypair>`__
request.

.. note:: Starting with microversion 2.37 the ``networks`` field is required.
Expand Down Expand Up @@ -530,7 +530,7 @@ HostId is unique per account and is not globally unique.
due to a transient condition in the deployment like infrastructure failure,
the response body for those unavailable servers will be missing keys. See
`handling down cells
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

Expand Down Expand Up @@ -699,7 +699,7 @@ The server must exist.
due to a transient condition in the deployment like infrastructure failure,
the response body for the unavailable server will be missing keys. See
`handling down cells
<http://developer.openstack.org/api-guide/compute/down_cells.html>`__
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
section of the Compute API guide for more information on the keys that
would be returned in the partial constructs.

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/versions.inc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ supports versioning. There are two kinds of versions in Nova.

For more details about Microversions, please reference:
`Microversions
<https://developer.openstack.org/api-guide/compute/microversions.html>`_
<https://docs.openstack.org/api-guide/compute/microversions.html>`_

.. note:: The maximum microversion supported by each release varies.
Please reference:
Expand Down
Loading

0 comments on commit dbe6321

Please sign in to comment.