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

Open
wants to merge 562 commits into
base: main
Choose a base branch
from

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)

pwizla and others added 30 commits January 12, 2024 15:27
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
@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
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.