-
Notifications
You must be signed in to change notification settings - Fork 6
Home
NOTE: To locate all documentation regarding the plugin, please refer to the docs folder which can be found in the code repository.
Here you can find specification on all the endpoints provided by the API:
- docs/specification.yaml (OpenAPI v3.0.2 format)
You can also view the specification in SwaggerUI, which you may find easier to read than the specification file itself.
The API plugin allows for substantial configuration, such as enabling/disabling endpoints and methods, toggling authentication, response filtering, etc.
Please refer to the docs/CONFIGURATION.md file for specific information on how to set up the plugin on your Grav installation.
Some endpoints require authorisation in order to be used. There is currently a Basic
authentication type implemented.
Please refer to the docs/AUTHENTICATION.md file for more information regarding available roles
, configuring user accounts, and how to authorise API requests.
If you wish to contribute to the development of the API plugin, please consult the docs/DEVELOPMENT.md file to learn more about the development environment setup and procedures.
You can refer to the project board to see which issues are prioritised for development.