Skip to content

Commit 383a4cf

Browse files
Zuulopenstack-gerrit
authored andcommitted
Merge "Update api-ref location"
2 parents 524f029 + dbe6321 commit 383a4cf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+95
-95
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ API
2121

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

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

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

api-guide/source/faults.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ There is an API for end users to list the outcome of Server Actions,
7171
referencing the requested action by request id.
7272

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

7676
Logs
7777
----

api-guide/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ compute resources might be Virtual Machines, Physical Machines or Containers.
2424

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

2929
We welcome feedback, comments, and bug reports at
3030
`bugs.launchpad.net/nova <https://bugs.launchpad.net/nova>`__.

api-guide/source/limits.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ operators and may differ from one deployment of the OpenStack Compute service
99
to another. Please contact your provider to determine the limits that
1010
apply to your account. Your provider may be able to adjust your
1111
account's limits if they are too low. Also see the API Reference for
12-
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
12+
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.
1313

1414
Absolute limits
1515
~~~~~~~~~~~~~~~
@@ -49,4 +49,4 @@ Determine limits programmatically
4949

5050
Applications can programmatically determine current account limits. For
5151
information, see
52-
`Limits <https://developer.openstack.org/api-ref/compute/#limits-limits>`__.
52+
`Limits <https://docs.openstack.org/api-ref/compute/#limits-limits>`__.

api-guide/source/server_concepts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -708,7 +708,7 @@ For more information, refer to `Block Device Mapping
708708

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

713713
**Example for block_device_mapping_v2**
714714

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

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

773773
Server Consoles

api-guide/source/versions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ server might respond with a 302 redirection request.
105105

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

110110
The detailed version response contains pointers to both a human-readable
111111
and a machine-processable description of the API service.

api-ref/source/images.inc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
The image metadata APIs will fail with a 404 starting from
1414
microversion 2.39.
1515
See: `Relevant Image APIs
16-
<https://developer.openstack.org/api-ref/image/v2/index.html>`__.
16+
<https://docs.openstack.org/api-ref/image/v2/index.html>`__.
1717

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

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

2626
By default, the ``policy.json`` file authorizes all users to view the
2727
image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.

api-ref/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

1111
.. rest_expand_all::
1212

api-ref/source/os-baremetal-nodes.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Nova has deprecated all the proxy APIs and users should use the native
1212
APIs instead. These will fail with a 404 starting from microversion 2.36.
1313
See: `Relevant Bare metal APIs
14-
<http://developer.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
14+
<https://docs.openstack.org/api-ref/baremetal/index.html#nodes-nodes>`__.
1515

1616
Bare metal nodes.
1717

api-ref/source/os-floating-ips.inc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
deprecated all the proxy APIs and users should use the native APIs
1111
instead. These will fail with a 404 starting from microversion 2.36.
1212
See: `Relevant Network APIs
13-
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
13+
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
1414

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

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

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

api-ref/source/os-hypervisors.inc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ the ``policy.json`` file.
154154
the totals and the usages. A more accurate representation of state can be
155155
obtained using `placement`__.
156156

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

159159
Normal response codes: 200
160160

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

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

207207
Normal response codes: 200
208208

api-ref/source/os-networks.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
using ``neutron`` directly. These will fail with a 404
1515
starting from microversion 2.36.
1616
See: `Relevant Network APIs
17-
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
17+
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
1818

1919

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

api-ref/source/os-security-group-rules.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
deprecated all the proxy APIs and users should use the native APIs
1111
instead. These will fail with a 404 starting from microversion 2.36.
1212
See: `Relevant Network APIs
13-
<https://developer.openstack.org/api-ref/networking/v2/#security-group-rules-security-group-rules>`__.
13+
<https://docs.openstack.org/api-ref/network/v2/#security-group-rules-security-group-rules>`__.
1414

1515
Creates and deletes security group rules.
1616

api-ref/source/os-security-groups.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
deprecated all the proxy APIs and users should use the native APIs
1313
instead. These will fail with a 404 starting from microversion 2.36.
1414
See: `Relevant Network APIs
15-
<https://developer.openstack.org/api-ref/networking/v2/#security-groups-security-groups>`__.
15+
<https://docs.openstack.org/api-ref/network/v2/#security-groups-security-groups>`__.
1616

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

api-ref/source/os-services.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Provides details why any services were disabled.
2525
due to a transient condition in the deployment like infrastructure failure,
2626
the response body for those unavailable compute services in the down cells
2727
will be missing keys. See `handling down cells
28-
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
28+
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
2929
section of the Compute API guide for more information on the keys that
3030
would be returned in the partial constructs.
3131

api-ref/source/os-tenant-network.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
deprecated all the proxy APIs and users should use the native APIs
1313
instead. These will fail with a 404 starting from microversion 2.36.
1414
See: `Relevant Network APIs
15-
<https://developer.openstack.org/api-ref/networking/v2/#networks>`__.
15+
<https://docs.openstack.org/api-ref/network/v2/#networks>`__.
1616

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

api-ref/source/os-volumes.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
deprecated all the proxy APIs and users should use the native APIs
1111
instead. These will fail with a 404 starting from microversion 2.36.
1212
See: `Relevant Volume APIs
13-
<https://developer.openstack.org/api-ref/block-storage/v3/index.html>`__.
13+
<https://docs.openstack.org/api-ref/block-storage/v3/index.html>`__.
1414

1515
Manages volumes and snapshots for use with the Compute API.
1616
Lists, shows details, creates, and deletes volumes and snapshots.

api-ref/source/parameters.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2348,7 +2348,7 @@ device_volume_type:
23482348
The device ``volume_type``. This can be used to specify the type of volume
23492349
which the compute service will create and attach to the server.
23502350
If not specified, the block storage service will provide a default volume
2351-
type. See the `block storage volume types API <https://developer.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
2351+
type. See the `block storage volume types API <https://docs.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
23522352
for more details.
23532353
There are some restrictions on ``volume_type``:
23542354
@@ -2980,7 +2980,7 @@ flavor_links_2_46:
29802980
description: |
29812981
Links to the flavor resource. See `API Guide / Links and
29822982
References
2983-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
2983+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
29842984
for more info.
29852985
in: body
29862986
required: true
@@ -3611,7 +3611,7 @@ hypervisor_links:
36113611
description: |
36123612
Links to the hypervisors resource. See `API Guide / Links and
36133613
References
3614-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
3614+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
36153615
for more info.
36163616
in: body
36173617
type: array
@@ -3926,7 +3926,7 @@ instance_actions_next_links:
39263926
Links pertaining to the instance action.
39273927
This parameter is returned when paging and more data is available.
39283928
See `API Guide / Links and References
3929-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
3929+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
39303930
for more info.
39313931
in: body
39323932
required: false
@@ -4177,7 +4177,7 @@ keypair_links:
41774177
description: |
41784178
Links pertaining to keypair. See `API Guide / Links and
41794179
References
4180-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
4180+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
41814181
for more info.
41824182
in: body
41834183
type: array
@@ -4294,7 +4294,7 @@ links:
42944294
description: |
42954295
Links to the resources in question. See `API Guide / Links and
42964296
References
4297-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
4297+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
42984298
for more info.
42994299
in: body
43004300
required: true
@@ -4617,7 +4617,7 @@ migration_links_2_23:
46174617
This parameter is returned if the migration type is ``live-migration`` and
46184618
the migration status is one of ``queued``, ``preparing``, ``running``
46194619
and ``post-migrating``. See `API Guide / Links and References
4620-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
4620+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
46214621
for more info.
46224622
in: body
46234623
required: false
@@ -4640,7 +4640,7 @@ migration_next_links_2_59:
46404640
Links pertaining to the migration.
46414641
This parameter is returned when paging and more data is available.
46424642
See `API Guide / Links and References
4643-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
4643+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
46444644
for more info.
46454645
in: body
46464646
required: false
@@ -6016,7 +6016,7 @@ server_links:
60166016
description: |
60176017
Links pertaining to the server. See `API Guide / Links and
60186018
References
6019-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
6019+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
60206020
for more info.
60216021
in: body
60226022
type: array
@@ -6159,7 +6159,7 @@ servers_links:
61596159
Links to the next server. It is available when the number of servers exceeds
61606160
``limit`` parameter or ``[api]/max_limit`` in the configuration file.
61616161
See `API Guide / Links and References
6162-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
6162+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
61636163
for more info.
61646164
in: body
61656165
type: array
@@ -6707,7 +6707,7 @@ usage_links:
67076707
description: |
67086708
Links pertaining to usage. See `API Guide / Links and
67096709
References
6710-
<http://developer.openstack.org/api-guide/compute/links_and_references.html>`_
6710+
<https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
67116711
for more info.
67126712
in: body
67136713
type: array

api-ref/source/request-ids.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Users can specify the global request ID in the request header.
88
Users can receive the local request ID in the response header.
99

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

1313
**Request**
1414

api-ref/source/servers-actions.inc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A pool of floating IP addresses, configured by the cloud administrator,
3838
is available in OpenStack Compute. The project quota defines the maximum
3939
number of floating IP addresses that you can allocate to the project.
4040
After you `create (allocate) a floating IPaddress
41-
<http://developer.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
41+
<https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address>`__
4242
for a project, you can associate that address with the server. Specify
4343
the ``addFloatingIp`` action in the request body.
4444

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

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

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

401401
Policy defaults enable only users with the administrative role or
402402
the owner of the server to perform this operation. Cloud providers

api-ref/source/servers.inc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ whitelist will be silently ignored.
183183
due to a transient condition in the deployment like infrastructure failure,
184184
the response body for those unavailable servers will be missing keys. See
185185
`handling down cells
186-
<https://developer.openstack.org/api-guide/compute/down_cells.html>`__
186+
<https://docs.openstack.org/api-guide/compute/down_cells.html>`__
187187
section of the Compute API guide for more information on the keys that
188188
would be returned in the partial constructs.
189189

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

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

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

api-ref/source/versions.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ supports versioning. There are two kinds of versions in Nova.
1414

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

1919
.. note:: The maximum microversion supported by each release varies.
2020
Please reference:

0 commit comments

Comments
 (0)