cs3org / OCM-API

OpenCloudMesh API
38 stars 11 forks source link

Advertise any other protocol in the discovery endpoint #93

Closed glpatcern closed 1 month ago

glpatcern commented 2 months ago

This is a proposal in order to standardize how to show additional protocols in the discovery endpoint.

I'm not sure it can be espressed in OpenAPI 2.0. One more reason to convert to OpenAPI 3.0?

Edit: I fixed the PR (still with OpenAPI 2.0) so to allow to specify <any name> : "<url>", similar to how Nextcloud advertises their talk protocol:

      "protocols": {
        "talk-v1": "/ocs/v2.php/apps/spreed/api/"
      }

And the included example is deliberately inspired to the above.

@ArtificialOwl this makes Nextcloud's discovery fully standard ;-)

MahdiBaghbani commented 2 months ago

But I'm not sure it can be espressed in OpenAPI 2.0. One more reason to convert to OpenAPI 3.0?

It is possible to do that.

glpatcern commented 2 months ago

For reference, this is the discovery endpoint of Nextcloud:

https://cloud.nextcloud.com/ocm-provider

MahdiBaghbani commented 2 months ago

https://github.com/cs3org/OCM-API/blob/3b419333998439ce4b58893f60c5c44083735026/spec.yaml#L438-L546