Docs: Update REST documentation and mkdocs - #7158

Open

vdiezel wants to merge 31 commits into

nextcloud:mainfrom

vdiezel:docs-rest-api-update

Commits on Aug 6, 2025

docs: minimal updates required for latest mkdocs version
vdiezel
committed
271101b
docs: make sidebar entries readable
vdiezel
committed
e5b8aa5
docs: fixes a series of types and bad markdown formatting in API.md
vdiezel
committed
ba88f38
docs: separate URL and API title for better navigation entries
vdiezel
committed
49a4a55
docs: Further fixes of order, missing request parameter and unification of names
vdiezel
committed
bd95f3c
docs: add missing language tags to code blocks in API.md
vdiezel
committed
a15d347
docs: (opinionated) replace 'Naming' with 'Glossary' and change label description
vdiezel
committed
70f8eba
docs: Formatting and small text changes to the Prerequisites section
vdiezel
committed
6df9ca7
docs: add permalinks
vdiezel
committed
e8c9907
docs: add missing documenation for v1.1 atttachment endpoints
vdiezel
committed
2b4fd90
docs: Separate endpoint name and description for better navigation entries
vdiezel
committed
529a4dd
docs: (opinionated) removes 200 success heading from responses and adds a short description on the return value
vdiezel
committed
b10a46e
docs: (opinionated) removes the error responses from endpoints
vdiezel
committed
66cf760
docs: (opinionated) better visual separation between endpoints
vdiezel
committed
f14e47c
docs: (opinionated) style endpoint URL
vdiezel
committed
6b589c5
docs: fix wrong enum value for attachment type
vdiezel
committed
9dfdbcb

Commits on Aug 7, 2025

docs: minor fixes of request parameters
vdiezel
committed
8570f8d
docs: rename request paramaters to path parameters and introduce query string parameters
vdiezel
committed
9ddec3f
docs: more consistent heading structure for endpoints
vdiezel
committed
7c521c5
docs: fixes set config endpoint
vdiezel
committed
0972f4c
docs: styling changes to headings
vdiezel
committed
64e127d
docs: fixes path parameter description in restore board
vdiezel
committed
92a849a
docs: adds missing example heading to update card
vdiezel
committed
1845d8a
docs: fix Path heading for endpoints with different paths in v1.0 and v1.1
vdiezel
committed
4d22df2
docs: add docs for x-nc-deck-session
vdiezel
committed
33e29c3
docs: adds docs for the overview/upcoming endpoint
vdiezel
committed
1772578
docs: adds docs for the card/clone endpoint
vdiezel
committed
9f7a106
docs: adds docs for search cards endpoint
vdiezel
committed
c91a47b
docs: add hint to OCS card API
vdiezel
committed
732e2b4
docs: link methods in Etag section
vdiezel
committed
710b06d

Commits on Aug 15, 2025

Merge branch 'main' into docs-rest-api-update
vdiezel
authored
9043ebf