Skip to content

Commit 4827fa3

Browse files
JeroenDeDauwclaude
andauthored
Link the live OpenAPI spec (neowiki.dev) from the REST API reference (#964)
* Link the live OpenAPI spec on neowiki.dev from the REST API reference The Full specification section now leads with a no-install link to the demo wiki's generated OpenAPI 3.0 document, so someone evaluating NeoWiki can browse the complete contract without setting up a wiki first. The self-host instructions follow it. Addresses ProfessionalWiki/NeoWiki-Website#80 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Update OpenAPI description wording for clarity Clarified wording in the OpenAPI description section. --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent c5cd38a commit 4827fa3

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

docs/reference/rest-api.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,17 @@ A Layout defines how a Subject is displayed.
8787

8888
## Full specification
8989

90-
Every endpoint also publishes a complete OpenAPI 3.0 description — parameters, request bodies, and
91-
responses — generated from the live handlers. Enable it in `LocalSettings.php`:
90+
Every endpoint also publishes a complete OpenAPI 3.0 description: parameters, request bodies, and
91+
responses.
92+
93+
Browse it live on the demo wiki:
94+
[neowiki.dev/w/rest.php/specs/v0/module/-](https://neowiki.dev/w/rest.php/specs/v0/module/-).
95+
Paste that JSON into [editor.swagger.io](https://editor.swagger.io) or any OpenAPI viewer.
96+
97+
To expose it on your own wiki, register the spec routes in `LocalSettings.php`:
9298

9399
```php
94100
$wgRestAPIAdditionalRouteFiles[] = 'includes/Rest/specs.v0.json';
95101
```
96102

97-
Then fetch `/rest.php/specs/v0/module/-` and open it in [editor.swagger.io](https://editor.swagger.io)
98-
or any OpenAPI viewer.
103+
Then fetch `/rest.php/specs/v0/module/-` on your wiki.

0 commit comments

Comments
 (0)