RavimoShark API Client OpenAPI Specification

The main repository is hosted in gitlab.com/ravimosharksas but it is automatically mirrored to github.com/RavimoShark, github.com/singletonsd, github.com/patoperpetua, gitlab.com/singletonsd and to gitlab.com/patoperpetua, github.com/patoperpetua. If you are in the Github page it may occur that is not updated to the last version.

PROJECT INFORMATION

Swagger documentation of global API. See HTML documentation in
https://ravimosharksas.gitlab.io/apis/client/documentation

USAGE

Starts the development server: npm start
Bundles the spec and prepares web_deploy folder with static assets: npm run build
Validates the spec: npm test
Deploys docs to GitHub Pages: npm run gh-pages
Run swagger-repo scripts locally: npm run swagger-repo
Run create-openapi-repo scripts locally: npm run create-openapi-repo

DOCUMENTATION

You can create the following folders here:

schemas - reusable Schema Objects
responses - reusable Response Objects
parameters - reusable Parameter Objects
examples - reusable Example Objects
headers - reusable Header Objects
requestBodies - reusable Request Body Objects
links - reusable Link Objects
callbacks - reusable Callback Objects
securitySchemes - reusable Security Scheme Objects

CONTRIBUTING

Contributions to this repository are very welcome.

To contribute, please fork this repository on GitLab and send a pull request with a clear description of your changes. If appropriate, please ensure that the user documentation in this README is updated.

If you have submitted a PR and not received any feedback for a while, feel free to ping me on Twitter or find me on facebook

TODO

Config tool to generate models diagram.
[X] Config client libraries on commit.
[X] Upload html documentation to gitlab pages.
Upload html documentation to servers.
Use scripts from remote repository.
Gitlab ci-cd template from remote repository.
[X] Split swagger.yaml into multiple files.
[X] Use ReDoc documentation framework.