From b4d0b9a11c9677ac8f0fe0095b783e86e1097e22 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Mon, 1 Aug 2016 14:59:53 +0900 Subject: [PATCH] Mention proxy API deprecation microversion in api-ref Proxy APIs are deprecated in microversion 2.36 which means all proxy APIs will return 404 after 2.35 version. It will be nice to mention that explicitly in api-ref too. Partially implements blueprint deprecate-api-proxies Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82 --- api-ref/source/images.inc | 2 +- api-ref/source/os-baremetal-nodes.inc | 2 +- api-ref/source/os-fixed-ips.inc | 2 +- api-ref/source/os-floating-ip-dns.inc | 2 +- api-ref/source/os-floating-ip-pools.inc | 2 +- api-ref/source/os-floating-ips-bulk.inc | 2 +- api-ref/source/os-floating-ips.inc | 2 +- api-ref/source/os-fping.inc | 1 + api-ref/source/os-networks.inc | 3 ++- api-ref/source/os-security-group-default-rules.inc | 1 + api-ref/source/os-security-group-rules.inc | 2 +- api-ref/source/os-security-groups.inc | 2 +- api-ref/source/os-tenant-network.inc | 2 +- api-ref/source/os-volumes.inc | 2 +- 14 files changed, 15 insertions(+), 12 deletions(-) diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index 3ad0878107..ec4c80bc8c 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -8,7 +8,7 @@ These APIs are proxy calls to the Image service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Image APIs `__. diff --git a/api-ref/source/os-baremetal-nodes.inc b/api-ref/source/os-baremetal-nodes.inc index 46316634eb..125e96be9f 100644 --- a/api-ref/source/os-baremetal-nodes.inc +++ b/api-ref/source/os-baremetal-nodes.inc @@ -9,7 +9,7 @@ These APIs are proxy calls to the Ironic service. They exist for legacy compatibility, but no new applications should use them. Nova has deprecated all the proxy APIs and users should use the native - APIs instead. + APIs instead. These will fail with a 404 after microversion 2.35. See: `Relevant Bare metal APIs `__. diff --git a/api-ref/source/os-fixed-ips.inc b/api-ref/source/os-fixed-ips.inc index 249f882337..cbe1f4cdf8 100644 --- a/api-ref/source/os-fixed-ips.inc +++ b/api-ref/source/os-fixed-ips.inc @@ -8,7 +8,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. Shows data for a fixed IP, such as host name, CIDR, and address. Also, reserves and releases a fixed IP address. diff --git a/api-ref/source/os-floating-ip-dns.inc b/api-ref/source/os-floating-ip-dns.inc index 969cd625bc..e173327413 100644 --- a/api-ref/source/os-floating-ip-dns.inc +++ b/api-ref/source/os-floating-ip-dns.inc @@ -11,7 +11,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc index e5f5b3eff7..0653dd4562 100644 --- a/api-ref/source/os-floating-ip-pools.inc +++ b/api-ref/source/os-floating-ip-pools.inc @@ -8,7 +8,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc index f9974bf683..10aafe1570 100644 --- a/api-ref/source/os-floating-ips-bulk.inc +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -8,7 +8,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc index baeefa0330..1637ec9b2e 100644 --- a/api-ref/source/os-floating-ips.inc +++ b/api-ref/source/os-floating-ips.inc @@ -11,7 +11,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-fping.inc b/api-ref/source/os-fping.inc index 69ba4a68e0..428f2e5e33 100644 --- a/api-ref/source/os-fping.inc +++ b/api-ref/source/os-fping.inc @@ -8,6 +8,7 @@ This API only works with ``nova-network`` which is deprecated. It should be avoided in any new applications. + These will fail with a 404 after microversion 2.35. Pings instances and reports which instances are alive. diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc index 8fb8706e14..08680a29ce 100644 --- a/api-ref/source/os-networks.inc +++ b/api-ref/source/os-networks.inc @@ -15,7 +15,8 @@ ``neutron`` when appropriate, but as with all translation proxies, this is far from perfect compatibility. These APIs should be avoided in new applications in favor of - using ``neutron`` directly. + using ``neutron`` directly. These will fail with a 404 + after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-security-group-default-rules.inc b/api-ref/source/os-security-group-default-rules.inc index 596b2056b8..4fa3943d3a 100644 --- a/api-ref/source/os-security-group-default-rules.inc +++ b/api-ref/source/os-security-group-default-rules.inc @@ -11,6 +11,7 @@ This API only available with ``nova-network`` which is deprecated. It should be avoided in any new applications. + These will fail with a 404 after microversion 2.35. Lists, shows information for, and creates default security group rules. diff --git a/api-ref/source/os-security-group-rules.inc b/api-ref/source/os-security-group-rules.inc index f6c042d9e2..a7f20af93a 100644 --- a/api-ref/source/os-security-group-rules.inc +++ b/api-ref/source/os-security-group-rules.inc @@ -10,7 +10,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-security-groups.inc b/api-ref/source/os-security-groups.inc index 56c35cead0..0d49d92c98 100644 --- a/api-ref/source/os-security-groups.inc +++ b/api-ref/source/os-security-groups.inc @@ -11,7 +11,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-tenant-network.inc b/api-ref/source/os-tenant-network.inc index fd5e989d7c..9e5b53c74e 100644 --- a/api-ref/source/os-tenant-network.inc +++ b/api-ref/source/os-tenant-network.inc @@ -11,7 +11,7 @@ These APIs are proxy calls to the Network service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Network APIs `__. diff --git a/api-ref/source/os-volumes.inc b/api-ref/source/os-volumes.inc index 3360d1c191..3ac1cea106 100644 --- a/api-ref/source/os-volumes.inc +++ b/api-ref/source/os-volumes.inc @@ -8,7 +8,7 @@ These APIs are proxy calls to the Volume service. Nova has deprecated all the proxy APIs and users should use the native APIs - instead. + instead. These will fail with a 404 after microversion 2.35. See: `Relevant Volume APIs `__.