Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API doc for supported series #429

Open
wants to merge 3 commits into
base: v5-unstable
Choose a base branch
from

Conversation

wallyworld
Copy link
Member

We introduce a new supported-series endpoint.

@jujugui
Copy link
Contributor

jujugui commented Sep 15, 2015

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
http://ci.jujugui.org:8080//job/charmstore/1139/
Test PASSed.

@@ -1353,6 +1360,22 @@ type StatsCount struct {

If the refresh boolean parameter is non-zero, the latest stats will be returned without caching.

#### GET *id*/meta/supported-series

The `supported-series` path returns the OS series that are defined by the entity as
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/entity/charm/ ?

I think I'd call this endpoint charm-supported-series, as it's charm-specific,
and like other charm-specific endpoints, it'll return a metadata-not-found error when invoked on bundles.

Also, we should be clear about the behaviour when the charm metadata does not support multiple series.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've renamed to charm-supported-series and added an extra example to show how an empty list is returned if no supported series are declared in the metadata.

@jujugui
Copy link
Contributor

jujugui commented Sep 18, 2015

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
http://ci.jujugui.org:8080//job/charmstore/1145/
Test PASSed.

@jujugui
Copy link
Contributor

jujugui commented Sep 28, 2015

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
http://ci.jujugui.org:8080//job/charmstore/1154/
Test PASSed.

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

Successfully merging this pull request may close these issues.

4 participants