aboutsummaryrefslogtreecommitdiffstats
path: root/docs/rest
Commit message (Collapse)AuthorAgeFilesLines
* REST: Introduce discovery endpointdaniel2024-09-202-4/+88
| | | | | | | | The discovery endpoint provides basic information about accessing the wiki's APIs, as well as a directory of available modules. Bug: T365753 Change-Id: I161aa68566da91867b650e13c8aadc87cd0c428c
* REST: validate JSON in testsdaniel2024-09-201-9/+10
| | | | | | | | | | | | | | | | | | This applies JSON Schema validation in phpunit tests where appropriate: 1) In ModuleSpecHandlerTest, the generated OpenApi specs are validated against the OpenAPI 3 schema. 2) In RestStructureTest, module definition files are validated against the mwapi schema. This patch introduces a new trait to make it easy for phpunit test cases to perform validation. This patch also fixes some issues with the docs/rest/mwapi-1.0.json schema and the includes/Rest/content.v1.json module definition. Change-Id: I966cddb337c9373ed3a369496548a8d8c538ae84
* REST: Make module definition files more like OpenAPI specsdaniel2024-06-241-0/+123
This splits RouteFileModule into two classes, ExtraRoutesModule and SpecBasedModule. ExtraRoutesModule has no module prefix and supports only "flat" route definition files and additional routes from extension.json. SpecBasedModule represents a single module defined in a definition file similar to an OpenAPI spec. The idea is that a full OpenAPI spec can be generated by filling in any missing information based on information provided by the Handler implementation. In particular, the definition of parameters and request body schemas will be generated. A JSON schema for the new file format is added under docs/rest/. Support for the intermediate format introduced in Iebcde4645d4 is removed. It was not included in a release and was not being used outside core tests. Bug: T366837 Change-Id: I4ce306b0997f80b78a3d901e38bbfa8445bed604