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

Expose a .well-known URI #2573

Open
Gby56 opened this issue Aug 27, 2024 · 3 comments
Open

Expose a .well-known URI #2573

Gby56 opened this issue Aug 27, 2024 · 3 comments

Comments

@Gby56
Copy link

Gby56 commented Aug 27, 2024

Describe the problem to be solved
Automatic discovery of API documentation portals is not easy, even with great documentation websites, automatically downloading the up-to-date schemas is not an easy task.

Describe the solution you'd like
My first idea is to use https://en.wikipedia.org/wiki/Well-known_URI

Either a /.well-known/apis.json or /.well-known/redoc.json would be enough, to get a simple list of documented APIs on the portal you're browsing, and get the list of specification files there too, to simply download the specifications.

Otherwise another URL path would be ok, a simple exampleportal.com/redoc.json would be nice

Describe alternatives you've considered
None

@adamaltman
Copy link
Member

There is a proposed spec: https://apisjson.org/format/apisjson_0.17.txt

I haven't reviewed it in depth yet.

@jeremyfiel
Copy link

cc @kinlane

@kinlane
Copy link

kinlane commented Oct 23, 2024

Let me know where you need help @adamaltman -- 0.18 is latest and about to push 0.19. Thanks for nudge @jeremyfiel ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants