chore(docs): update params and response types of ocs endpoints

[grnd-alt]

• AI used

[Copilot]

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

Review effort: Lite
Findings: 4 · 2

Open (6)

• The OCS base path is documented as /ocs/v2.php/apps/deck/api/v1.0/, but the tables list routes… · New
• The OCS base path is documented as /ocs/v2.php/apps/deck/api/v1.0/, but the tables list routes… · New
• For PUT /cards/{cardId}, the parameter list uses id: int but the route placeholder is… · New
• There is already a ## Comments section introduced earlier in this diff (around line ~1222). This… · New
• Grammar: 'Decks data models' should be possessive ('Deck's data models'). · New
• Fix typo: 'otherwhise' should be 'otherwise'. · New

What changed in this PR

Updates the Deck REST API documentation to clarify that OCS is the preferred API surface and to document OCS endpoint parameters/response types more explicitly.

Changes:

• Added “API selection” guidance and clarified preferred (OCS) vs legacy base URLs.
• Reworked the OCS API section to describe the standard OCS response envelope and summarize key endpoint groups (boards/stacks/cards/attachments/config/etc.) in tables.
• Updated config endpoint documentation to reflect the newer route shape and key conventions.

File	Description
docs/​API.md	Expands and restructures API docs to emphasize OCS usage and document endpoint parameters/response types.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[blizzz]

assisted-by-trailer applicable?