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

Add openapi.json route documentation (#2143) #2159

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

faessler
Copy link

@faessler faessler commented Jul 29, 2024

What does it do?

Adds documentation for new route /documentation/<version>/openapi.json provided by the documentation plugin.

Preview:
image

Why is it needed?

This is needed to inform devs that there is a way to access the full_documentation.json via endpoint of the documentation plugin.

Related issue(s)/PR(s)

@faessler faessler requested a review from pwizla as a code owner July 29, 2024 19:50
Copy link

vercel bot commented Jul 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 29, 2024 7:51pm

@strapi-cla
Copy link

strapi-cla commented Jul 29, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thank you, @faessler!

I'll wait for the corresponding strapi/strapi PR (#20871) to be merged before merging this one 🙂

@pwizla pwizla added the flag: merge pending release Pending Strapi Release label Jul 30, 2024
@pwizla pwizla self-assigned this Jul 30, 2024
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs pr: updated content PRs updating existing documentation content labels Jul 30, 2024
@pwizla pwizla changed the base branch from main to v4 October 25, 2024 14:58
@pwizla
Copy link
Collaborator

pwizla commented Oct 25, 2024

HI @faessler!

You'd be happy to learn that your strapi/strapi PR has been merged today into the Strapi v4 codebase. So I'm merging this related docs PR too, but changed the target branch to v4. It will be live on v4 docs in a few minutes. Thank you again for your patience!

@pwizla pwizla added target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch). and removed flag: merge pending release Pending Strapi Release labels Oct 25, 2024
@pwizla pwizla merged commit 819f30d into strapi:v4 Oct 25, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants