Skip to content
RESTful API for CaG Events
Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
manage
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
openapi.yaml

README.md

Release Travis CI

CaG Events API

RESTful API specification for CaG Events in OpenAPI 3 format.

Tools

  • openapi-list: VS Code plugin for linting OpenAPI 3.0.
  • Swagger Editor (local): A Swagger 2 and OpenAPI 3 online web editor with auto complete and preview.

Scripts

  • manage/editor.sh: Start Swagger/OpenAPI editor web server (using Swagger Editor). The spec file must be imported and exported manually.
  • manage/validate-yaml.sh: Validate the YAML file formatting/linting (using yamllint in Python 3 virtualenv).
  • manage/gen-docs.sh: Generate web docs locally (using Swagger Codegen).
  • manage/gen-json.sh: Generate JSON OpenAPI/Swagger file locally (using Swagger Codegen).
  • manage/clean.sh: Clean temporary dirs and files.

Guidelines

  • Generally, all minor and patch versions should be backwards compatible.
  • All changes must be specified in the CHANGELOG.md.
  • When ready to release, bump the version in openapi.yaml and CHANGELOG.md and add a new empty section in CHANGELOG.md.
  • Release a new version using GitHub Releases with "CaG Events API vX.Y.Z" as the title and the relevant changelog section as the description.

License

This project is licensed under GPLv3, see LICENSE for the full license text.

You can’t perform that action at this time.