Skip to content

docs: add route policies to OpenAPI spec - #5428

Closed
rkoster wants to merge 8 commits into
cloudfoundry:mainfrom
rkoster:issue-5427-route-policies-openapi
Closed

docs: add route policies to OpenAPI spec#5428
rkoster wants to merge 8 commits into
cloudfoundry:mainfrom
rkoster:issue-5427-route-policies-openapi

Conversation

@rkoster

@rkoster rkoster commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document the five /v3/route_policies operations in the latest modular OpenAPI specification.
  • Add route-policy schemas, request bodies, filters, relationships, includes, and standard responses.
  • Keep the contract aligned with the current CAPI runtime, including comma-delimited query encoding and lifecycle error responses.

Closes #5427

Test Plan

  • corepack yarn lint in docs/openapi
  • corepack yarn build in docs/openapi
  • Verified the bundled specification contains all route-policy paths, operations, filters, schemas, request bodies, and response statuses.

The existing lint warnings are unrelated to route policies.

@rkoster
rkoster force-pushed the issue-5427-route-policies-openapi branch from d764741 to 2b692b9 Compare September 8, 2026 06:11
@rkoster
rkoster marked this pull request as ready for review September 8, 2026 10:40
@sethboyles

Copy link
Copy Markdown
Member

Thanks @rkoster . Coincidentally, I have been working on a larger effort to get the OpenAPI docs up to date with the current v3 docs: #5432

I pulled out my two commits that added these properties, and then added some of the properties it lacked but your PR included. (also, I don't think we want the superpowers directory)

#5444
#5443

@sethboyles sethboyles closed this Sep 11, 2026
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.

Route policies not described in OpenAPI spec

2 participants