[docs] Initial draft of the REST style guide

[andrewnicols]

This is the initial draft of the REST style guide for RFC.

[netlify]

✅ Deploy Preview for moodledevdocs ready!

Name	Link
🔨 Latest commit	7ed2fe4
🔍 Latest deploy log	https://app.netlify.com/projects/moodledevdocs/deploys/6abe70d8e9ea6c00084719c4
😎 Deploy Preview	https://deploy-preview-1649--moodledevdocs.netlify.app
📱 Preview on mobile	Toggle 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]

Pull request overview

Adds a new REST documentation section to the Moodle DevDocs site, including an initial (but intended-to-be-normative) REST API style guide to standardize URI structure, naming, payload conventions, and HTTP semantics across Moodle components.

Changes:

• Introduces a comprehensive REST API style guide covering resource design, URI conventions, JSON conventions, pagination, errors, and idempotency.
• Adds a REST guide index page under docs/guides/rest/.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File	Description
docs/guides/rest/style.md	Adds the initial REST style guide content and examples.
docs/guides/rest/index.md	Adds the REST guides section index frontmatter (and should include navigational content).

Comments suppressed due to low confidence (2)

docs/guides/rest/style.md:998

• This TODO note also uses broken Markdown emphasis ("-*TO DO:**"). Formatting it consistently will improve readability of the draft.

-*TO DO:** this section is under revision; most of it is being removed as incorrect, so its rationale will be drafted once the replacement content is agreed.

docs/guides/rest/index.md:7

• docs/guides/rest/index.md currently contains only frontmatter, so the rendered page will be empty. Adding a short introduction and links (e.g. to the style guide) will make the section navigable.

---

[jtse]

Thanks for writing this! A general point: Consider having fewer SHOULDs, either upgrading them to MUST or removing them. SHOULD in specs tend to make things more complicated.

[jtse]

Looking forward to seeing how this evolves and prototype implementations.

[traviswindsormoodle]

Good to go