operator-controller icon indicating copy to clipboard operation
operator-controller copied to clipboard

[epic] web OpenAPI discoverability

Open grokspawn opened this issue 1 year ago • 0 comments

operator-framework/catalogd#426 established rigor for the existing FBC web interface which provided the entire catalog FBC to a client, and operator-framework/operator-controller#1570 intends to expand that web API to make the network traffic more efficient by providing the capability of limited-scope FBC query/response exchanges.

Catalogd exposes API endpoints in status.urls and currently only supports [base](https://github.com/operator-framework/catalogd/blob/main/docs/fetching-catalog-contents.md#fetching-clustercatalog-contents-from-the-catalogd-http-server This epic is to focus on API discovery).

We would like to permit some kind of api discovery, similar to https://api.openshift.com/ or https://docs.docker.com/reference/api/hub/latest/ where one can programmatically interrogate the OpenAPI spec for the interface and exercise a selected API.

grokspawn avatar Dec 04 '24 15:12 grokspawn