3c0b9d36d4
OPS-284: add prometheus endpoint Closes OPS-284 See merge request redactmanager/persistence-service!928
Description
TODO
Table of Contents
Installation
TODO
Usage
TODO
License
This application is covered by the proprietary knecon license.
Tests
TODO
API
Files
The OpenAPI specifications for RedactManager and Documine are located here:
./persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api
The Redocly configuration file redocly.yaml is located in the root directory of the project. It contains the settings for linting the specifications and generating the API documentation. If you run the redocly commands from there, you do not need to specify the path to the configuration file.
The Redocly files are located in the redocly directory:
- The
templatesdirectory contains the Handlebars templates for RedactManager and Documine, respectively. - The
builddirectory is the default output directory for the generated API documentation.
Redocly Installation
Execute the following command to install the Redocly CLI.
npm install -g @redocly/cli@latest
Redocly Linting
Execute the following commands in the root directory of the project to lint the OpenAPI specifications.
Please refer to the Redocly documentation for detailed information on the linting rules.
redocly lint redactmanager
redocly lint documine
Redocly Docs Generation
Execute the following commands in the root directory of the project to generate the API documentation.
redocly build-docs redactmanager --output ./redocly/build/redactmanager.html
redocly build-docs documine --output ./redocly/build/documine.html