Skip to content

Add IndexLink schema to handle index link's metadata field #1051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Samze merged 4 commits into from
May 26, 2026
Merged

Add IndexLink schema to handle index link's metadata field #1051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c5d2e2
Add IndexLink schema to handle index link's metadata field
PeteLevineA May 26, 2026
51259e4
Reduce Schema Drift and have IndexLink inherit from link
PeteLevineA May 26, 2026
5f189c4
V3 api root does not have the meta field
PeteLevineA May 26, 2026
88059ac
Reference to Link object
PeteLevineA May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions apis/cf/latest/components/schemas/IndexLink.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
allOf:
- $ref: ./Link.yaml
- type: object
properties:
meta:
type: object
description: Contains metadata about the link
properties:
version:
type: string
description: The version of the API
host_key_fingerprint:
type: string
description: The host key fingerprint of the link
oauth_client:
type: string
description: The oauth client for the link
description: |
Each link is keyed by its type and will include a href for the URL and an optional method for links that cannot be followed using GET. Can include a meta object with metadata about the link.
16 changes: 8 additions & 8 deletions apis/cf/latest/paths/Root.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,35 @@ get:
properties:
self:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the current endpoint
cloud_controller_v2:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Cloud Controller V2 API
cloud_controller_v3:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Cloud Controller V3 API
network_policy_v1:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Network Policy V1 API
uaa:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the UAA API
logging:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Logging API
log_cache:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Log Cache API
log_stream:
allOf:
- $ref: '../components/schemas/Link.yaml'
- $ref: '../components/schemas/IndexLink.yaml'
- description: Link to the Log Stream API
'404':
$ref: '../components/responses/NotFound.yaml'
Expand Down
Loading