Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Report semantic version of OpenBEL API #91

Closed
abargnesi opened this issue Dec 16, 2015 · 1 comment
Closed

Report semantic version of OpenBEL API #91

abargnesi opened this issue Dec 16, 2015 · 1 comment
Milestone

Comments

@abargnesi
Copy link
Member

The OpenBEL API should report the API version. The API is not stable yet so this should reflect the 0.x.x series. Until 1.x.x we should expect breaking changes to be possible as it evolves.

The API version uses Semantic Versioning so it's reasonable to report both a version string and granular structure. Something like:

With Accept: text/plain or ?format=text

0.5.0

With Accept: application/json or ?format=json

{
    "version": {
        "string": "0.5.0",
        "major": "0",
        "minor": "5",
        "patch": "0"
    }
}
@abargnesi abargnesi added this to the 0.5.0 milestone Dec 16, 2015
abargnesi pushed a commit that referenced this issue Dec 17, 2015
@abargnesi
Copy link
Member Author

Added GET /api/version that reports the semantic version of the OpenBEL API. It supports JSON or TEXT depending on Accept header or ?format=json|text query parameter.

Added -v and --version options to openbel-api and openbel-config commands.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant