Skip to content
Merged
Changes from all commits
Commits
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
22 changes: 15 additions & 7 deletions spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,29 @@ info:
description: >
Open Cloud Mesh OpenAPI Specification.
The semantic of the Protocol Specification is detailed in the
[IETF-RFC.md](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md) document.
[IETF-RFC.md](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md)
document, published at the [IETF Datatracker](https://datatracker.ietf.org/doc/draft-ietf-ocm-open-cloud-mesh).
version: 1.3.0
x-logo:
url: logo.png
servers:
- url: https://{discovery_fqdn}
- url: https://{ocm_endpoint}
description: >
The root of the Open Cloud Mesh API, dynamically resolved by taking the `endpoint`
value returned by the Discovery endpoint.
variables:
discovery_fqdn:
default: cloud.example.org
ocm_endpoint:
default: cloud.example.org/ocm
paths:
/.well-known/ocm:
servers:
- url: https://cloud.example.org
description: The OCM Server's top-level FQDN.
get:
summary: Discovery endpoint
description: >
Following [RFC8615], this endpoint returns the properties and
capabilities offered by an OCM Server. This endpoint MUST be
served at the OCM Server's root FQDN, e.g. as in
`https://cloud.example.org/.well-known/ocm`. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery)
capabilities offered by an OCM Server. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery)
for more details.
responses:
"200":
Expand All @@ -32,6 +37,9 @@ paths:
schema:
$ref: "#/components/schemas/Discovery"
/ocm-provider:
servers:
- url: https://cloud.example.org
description: The OCM Server's root FQDN.
get:
summary: Legacy discovery endpoint
description: >
Expand Down
Loading