Skip to content

Repository files navigation

Unofficial OpenAPI specification for the Redmine API

CI

An OpenAPI 3.0.3 specification for the Redmine API, built from the official docs and source code, and tested against a running Redmine instance.

Tested against: Redmine 7.0.0

Documentation

Browse the rendered API reference at https://d-yoshi.github.io/redmine-openapi/

Download

Latest release:

https://github.com/d-yoshi/redmine-openapi/releases/latest/download/openapi.yaml

Specific version:

https://github.com/d-yoshi/redmine-openapi/releases/download/<tag>/openapi.yaml

Release tags are <redmine-version>-r<N> (e.g. 6.1.3-r2): the Redmine version the release was verified against, plus the revision number of the spec for that Redmine version (-r1 is the first release). If you run an older Redmine, pick the release whose tag matches your version — for older tags in retired formats (2.0.1+redmine.6.1.3 and earlier), the notes of each release state the verified Redmine version. Revisions may contain breaking corrections; each release's notes flag breaking changes and include a machine-generated changelog.

Tags are not SemVer — a SemVer parser reads -rN as a pre-release. Pin exact tags, and avoid reusing the spec's info.version as a package version for generated clients.

You can also check out a release tag with git, or fetch openapi.yaml from a tag via a raw URL.

Note

openapi.yaml on the main branch may contain unreleased changes beyond its declared info.version. Use a release for a stable reference.

Reference

About

Unofficial OpenAPI specification for the Redmine API

Topics

Resources

Stars

19 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages