openstack/neutron-lib
Code Issues Proposed changes

Fix documentation for gateway_ip in subnet update

Browse Source 
The documentation re-used the string for the subnet creation, which has
a different behavior as seen in [1]: on creation, not providing
a gateway_ip lets neutron pick one for us, while for the update, this is
a no-op.

[1] https://github.com/k-orc/openstack-resource-controller/pull/403#discussion_r2139426464

Change-Id: Ied169c8369a1a0bc50d13f6b7ac69bfb8d1c3cee
This commit is contained in:
Martin André
2025-06-12 10:36:10 +02:00
parent 094d102b5f
commit fd011c955d
2 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/source/v2/parameters.yaml
View File

@@ -7046,6 +7046,13 @@ subnet-gateway_ip-request:
in: body in: body
required: false required: false
type: string type: string
subnet-gateway_ip-update-request:
description: |
Gateway IP of this subnet. If the value is ``null`` that implies no
gateway is associated with the subnet.
in: body
required: false
type: string
subnet-host_routes: subnet-host_routes:
description: | description: |
Additional routes for the subnet. A list of dictionaries with Additional routes for the subnet. A list of dictionaries with

2
api-ref/source/v2/subnets.inc
View File

@@ -463,7 +463,7 @@ Request
- dns_nameservers: subnet-dns_nameservers-request - dns_nameservers: subnet-dns_nameservers-request
- allocation_pools: subnet-allocation_pools-request - allocation_pools: subnet-allocation_pools-request
- host_routes: subnet-host_routes-request - host_routes: subnet-host_routes-request
- gateway_ip: subnet-gateway_ip-request - gateway_ip: subnet-gateway_ip-update-request
- description: description-request - description: description-request
- service_types: subnet-service_types-optional - service_types: subnet-service_types-optional
- segment_id: subnet-segment_id-request - segment_id: subnet-segment_id-request