isabella232 / puppetdb-openapi

OpenAPI spec for PuppetDB

PuppetDB OpenAPI Specification

Steps to finish

1. Enable Travis for your repository (note: you already have .travis.yml file)
2. Create GitHub access token; select public_repo on Select scopes section.
3. Use the token value as a value for Travis environment variable with the name GH_TOKEN
4. Make a test commit to trigger CI: git commit --allow-empty -m "Test Travis CI" && git push
5. Wait until Travis build is finished. You can check progress by clicking on the Build Status badge at the top
6. [Optional] You can setup custom domain (just create web/CNAME file)
7. [Optional] If your API is public consider adding it into APIs.guru directory using this form.
8. Delete this section ❌

Links

• Reference Documentation (ReDoc)
• SwaggerUI
• OpenAPI Raw Files: JSON YAML

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

1. Install Node JS
2. Clone repo and run npm install in the repo root

Usage

npm start

Starts the development server.

npm run build

Bundles the spec and prepares web_deploy folder with static assets.

npm test

Validates the spec.

npm run gh-pages

Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.