Repository navigation
docs: introduce REST API project pages - #1752
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
🟡 Changes recommended
Active findings include a critical TypeScript argument-count error that prevents compilation, along with a moderate contract-validation defect and documentation issues.
4 open issues
What changed in this PR
Introduces hierarchical REST API project pages and generated OpenAPI reference documentation for the User REST API.
Changes:
- Adds nested REST API and User Endpoints project metadata and documentation pages.
- Adds the User REST API OpenAPI specification and Docusaurus reference configuration.
- Extends schemas, sidebar generation, build scripts, and project summary handling for nested projects and API collections.
| File | Description |
|---|---|
| static/schema/projects.json | Adds schema support for nested child projects and OpenAPI collections. |
| static/projects/restapi/users/openapi.json | Defines the User REST API OpenAPI contract. |
| src/components/ProjectSummary/index.tsx | Allows project summaries to reference nested project names. |
| src/components/Project/index.ts | Adds nested project metadata lookup support. |
| sidebars/general.js | Generates sidebar entries for nested projects and OpenAPI documentation. |
| package.json | Adds separate OpenAPI generation commands for Marketplace and REST API specifications. |
| general/projects/restapi/users.md | Adds the User Endpoints project landing page. |
| general/projects/restapi/index.md | Adds the REST API project overview page. |
| docusaurus.config.js | Registers the User REST API OpenAPI documentation plugin. |
| data/projects.json | Registers the REST API project and User Endpoints child project. |
| .gitignore | Excludes generated REST API OpenAPI documentation files. |
Review effort: Lite
5918da9 to
9033354
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Critical issues remain: the User Endpoints link targets a nonexistent document, the new component has incompatible project-map typing, and the OpenAPI schema permits invalid password fields for non-password authentication methods.
4 open issues
4 resolved since last review
Review effort: Lite
ebc7ab9 to
9a2a3a1
Compare
traviswindsormoodle
left a comment
There was a problem hiding this comment.
I've made a couple of comments for you to consider and if we change it, they can be subsequent updates. Not worth blocking for.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
9a2a3a1 to
9a4472c
Compare



No description provided.