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.

Sign up for GitHub

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

Jump to bottom

[Proposal] Generate swagger format api. #8453

Closed
manonthegithub opened this issue Jun 10, 2020 · 1 comment
Closed

[Proposal] Generate swagger format api. #8453

manonthegithub opened this issue Jun 10, 2020 · 1 comment
Labels
need/triage Needs initial labeling and prioritization topic/rpc-api Issues related to Kubo RPC API at /api/v0

Comments

@manonthegithub
Copy link

Not sure if you already considered that or not, but would be nice to have the api described in a universal format from which one can automatically generate client stubs for any (almost any) language. Swagger may be an example of such a format.
@lidel lidel transferred this issue from ipfs-inactive/http-api-docs Sep 21, 2021
@lidel lidel added the need/triage Needs initial labeling and prioritization label Sep 21, 2021
@ipfs ipfs deleted a comment from welcome bot Sep 21, 2021
@ipfs ipfs deleted a comment from welcome bot Sep 21, 2021
@lidel lidel added the topic/rpc-api Issues related to Kubo RPC API at /api/v0 label Sep 21, 2021
@lidel
Copy link
Member

lidel commented Sep 21, 2021

I am afraid swagger won't be compatible with RPC-style API at /api/v0 – see ipfs-inactive/http-api-docs#3 (comment).
We can revisit this in the future, when we introduce v1

@lidel lidel closed this as completed Sep 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
need/triage Needs initial labeling and prioritization topic/rpc-api Issues related to Kubo RPC API at /api/v0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lidel @manonthegithub