Skip to content

docs: introduce REST API project pages - #1752

Merged
andrewnicols merged 1 commit into
moodle:mainfrom
andrewnicols:MDL-90300
Nov 16, 2026
Merged

andrewnicols merged 1 commit into
moodle:mainfrom
andrewnicols:MDL-90300

Conversation

@andrewnicols

Copy link
Copy Markdown
Member

No description provided.

Copilot AI lite review requested due to automatic review settings November 15, 2026 08:00
@netlify

netlify Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit 9a4472c
🔍 Latest deploy log https://app.netlify.com/projects/moodledevdocs/deploys/6afafe4c4729a7028f178349
😎 Deploy Preview https://deploy-preview-1752--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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

Comment thread src/components/Project/index.ts Resolved
Comment thread general/projects/restapi/index.md Resolved
Comment thread general/projects/restapi/index.md Resolved

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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

Comment thread sidebars/general.js Resolved
Comment thread src/components/Project/index.ts Resolved
Comment thread src/components/Project/index.ts Resolved
@andrewnicols
andrewnicols force-pushed the MDL-90300 branch 2 times, most recently from ebc7ab9 to 9a2a3a1 Compare November 15, 2026 23:32

@traviswindsormoodle traviswindsormoodle left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

Comment thread general/projects/restapi/index.md Resolved
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@andrewnicols
andrewnicols added this pull request to the merge queue Nov 16, 2026
Merged via the queue into moodle:main with commit e1db262 Nov 16, 2026
5 of 6 checks passed
@andrewnicols
andrewnicols deleted the MDL-90300 branch November 16, 2026 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants