-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Open
faessler
wants to merge
562
commits into
strapi:main
Choose a base branch
from
faessler:dev/documentation-plugin-openapi-json
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add openapi.json route documentation (#2143) #2159
faessler
wants to merge
562
commits into
strapi:main
from
faessler:dev/documentation-plugin-openapi-json
+11,307
−2,600
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 0a446e0.
Because I tested this example to replace the favicon, and I've got an error. ```bash yarn run v1.22.19 $ strapi build ⠋ Building build context [INFO] Including the following ENV variables as part of the JS bundle: - ADMIN_PATH - STRAPI_ADMIN_BACKEND_URL - STRAPI_TELEMETRY_DISABLED ✔ Building build context (73ms) ⠋ Building admin panel ⠴ Building admin panel[ERROR] Module not found: Error: Can't resolve './extensions/favicon.png' in '/var/www/strapi/src/admin' ✖ Building admin panel [ERROR] There seems to be an unexpected error, try again with --debug for more information error Command failed with exit code 1. ```
* Document Node version feature in deployment guide * Update advanced settings screenshots
* Rework TOC titles * Separate account/sessing into 2 pages * Start working the Projects section * Rework and complete Usage and Billing page * Rework Projects overview page * Fix links in Usage and Billing * Separate deployment and deploy history in 2 pages and rework content in both * Move deployment pages to a new Deployments section in the TOC * Review Overview and Settings pages * Review or write content for deploys docs and runtime logs * Delete custom plan from Billing & Usage page * Mention GitLab where it was forgotten * Improve Notifications page * Fix/improve all projects management pages * Fix/improve all deployments pages * Fix/improve Account settings page * Update all screenshots * Fix broken links * Fix header link * Remove useless link in Project settings Co-authored-by: Pierre Wizla <[email protected]> * Update one more screenshot + Delete useless comments * Add icons * Delete More.svg in static * Delete more.svg again * Add More.svg * Fix icon name in releases * Add Node version feature in Project settings + Update screenshot * Add forgotten word in deploy logs --------- Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Pierre Wizla <[email protected]>
* Update account billing page * Update screenshot
* Extend new/updated badges usage outside TOC * Fix "updated" badges usage in TOC * Add badges where appropriate
* feat(cli): strapi projects * Update docusaurus/docs/cloud/cli/cloud-cli.md --------- Co-authored-by: Gonzalo Andres Garcia <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
provide more information on setting the role of a newly created user.
This reverts commit 4fedfcd.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This was referenced Jul 29, 2024
pwizla
approved these changes
Jul 30, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pwizla
added
source: Dev Docs
PRs/issues targeting the Developer Docs
pr: updated content
PRs updating existing documentation content
labels
Jul 30, 2024
pwizla
requested review from
derrickmehaffy and
meganelacheny
as code owners
September 17, 2024 15:56
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
flag: merge pending release
Pending Strapi Release
pr: updated content
PRs updating existing documentation content
source: Dev Docs
PRs/issues targeting the Developer Docs
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does it do?
Adds documentation for new route
/documentation/<version>/openapi.json
provided by the documentation plugin.Preview:
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)