diff --git a/apis/cf/latest/components/schemas/IndexLink.yaml b/apis/cf/latest/components/schemas/IndexLink.yaml new file mode 100644 index 0000000..bb19381 --- /dev/null +++ b/apis/cf/latest/components/schemas/IndexLink.yaml @@ -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. diff --git a/apis/cf/latest/paths/Root.yaml b/apis/cf/latest/paths/Root.yaml index 0410b8f..43d47b2 100644 --- a/apis/cf/latest/paths/Root.yaml +++ b/apis/cf/latest/paths/Root.yaml @@ -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'