Skip to content

Bring domains and isolation segments to parity with the v3 reference … - #5443

Merged
sethboyles merged 1 commit into
mainfrom
update-routes-and-isosegs-openapi
Sep 11, 2026
Merged

Bring domains and isolation segments to parity with the v3 reference …#5443
sethboyles merged 1 commit into
mainfrom
update-routes-and-isosegs-openapi

Conversation

@sethboyles

Copy link
Copy Markdown
Member

…docs

Adds permitted roles to all 15 operations with their v3 qualifiers, the enforce_route_policies and route_policies_scope domain fields, explicit organization and shared_organizations relationships in place of an opaque Relationships ref, and the missing filters on the org-scoped domain list and the isolation segment organizations list.

Language derived from:
docs/v3/source/includes/resources/domains/
docs/v3/source/includes/resources/isolation_segments/
docs/v3/source/includes/api_resources/_domains.erb
docs/v3/source/includes/api_resources/_isolation_segments.erb

Also fixes:

  • The share-a-domain response schema had items mis-indented as a sibling of data, so the schema was malformed, and its request description was copy-pasted from isolation segments.
  • The isolation segment PATCH example contained literal ERB (name: <%= name %>).
  • page/per_page removed from the two relationship endpoints, which accept no query parameters and return an unpaginated relationship.
  • created_ats/updated_ats added to GET /v3/organizations/{guid}/domains: undocumented in v3, but the controller reuses DomainsListMessage.
  • PATCH /v3/domains/{guid} now references the orphaned DomainUpdateRequestBody.

ai-assisted=yes

Thanks for contributing to cloud_controller_ng. To speed up the process of reviewing your pull request please provide us with:

  • A short explanation of the proposed change:

  • An explanation of the use cases your change solves

  • Links to any other associated PRs

  • I have reviewed the contributing guide

  • I have viewed, signed, and submitted the Contributor License Agreement

  • I have made this pull request to the main branch

  • I have run all the unit tests using bundle exec rake

  • I have run CF Acceptance Tests

…docs

Adds permitted roles to all 15 operations with their v3 qualifiers, the
enforce_route_policies and route_policies_scope domain fields, explicit
organization and shared_organizations relationships in place of an opaque
Relationships ref, and the missing filters on the org-scoped domain list
and the isolation segment organizations list.

Language derived from:
  docs/v3/source/includes/resources/domains/
  docs/v3/source/includes/resources/isolation_segments/
  docs/v3/source/includes/api_resources/_domains.erb
  docs/v3/source/includes/api_resources/_isolation_segments.erb

Also fixes:
- The share-a-domain response schema had `items` mis-indented as a sibling
  of `data`, so the schema was malformed, and its request description was
  copy-pasted from isolation segments.
- The isolation segment PATCH example contained literal ERB
  (`name: <%= name %>`).
- page/per_page removed from the two relationship endpoints, which accept
  no query parameters and return an unpaginated relationship.
- created_ats/updated_ats added to GET /v3/organizations/{guid}/domains:
  undocumented in v3, but the controller reuses DomainsListMessage.
- PATCH /v3/domains/{guid} now references the orphaned
  DomainUpdateRequestBody.

ai-assisted=yes
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@sethboyles
sethboyles merged commit fb9042d into main Sep 11, 2026
7 of 8 checks passed
ari-wg-gitbot added a commit to cloudfoundry/capi-release that referenced this pull request Sep 11, 2026
Changes in cloud_controller_ng:

- Bring domains and isolation segments to parity with the v3 reference docs
    PR: cloudfoundry/cloud_controller_ng#5443
    Author: Seth Boyles <seth.boyles@broadcom.com>
    Author: Claude Sonnet 5 <noreply@anthropic.com>

- Add the Route Policies resource to the OpenAPI spec
    PR: cloudfoundry/cloud_controller_ng#5444
    Author: Seth Boyles <seth.boyles@broadcom.com>
    Author: Claude Sonnet 5 <noreply@anthropic.com>
@moleske
moleske deleted the update-routes-and-isosegs-openapi branch September 11, 2026 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants