Skip to content
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.

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

[epic] web OpenAPI discoverability #1568

Open
grokspawn opened this issue Dec 4, 2024 · 0 comments
Open

[epic] web OpenAPI discoverability #1568

grokspawn opened this issue Dec 4, 2024 · 0 comments
Labels
epic v1.x Issues related to OLMv1 features that come after 1.0

Comments

@grokspawn
Copy link
Contributor

operator-framework/catalogd#426 established rigor for the existing FBC web interface which provided the entire catalog FBC to a client, and #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 grokspawn added epic v1.x Issues related to OLMv1 features that come after 1.0 labels Dec 4, 2024
@grokspawn grokspawn changed the title [epic] web api discoverability [epic] web OpenAPI discoverability Dec 4, 2024
@camilamacedo86 camilamacedo86 transferred this issue from operator-framework/catalogd Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic v1.x Issues related to OLMv1 features that come after 1.0
Projects
Status: No status
Development

No branches or pull requests

1 participant