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

API spec inconsistency #12

Open
jshimko opened this issue Sep 18, 2017 · 1 comment
Open

API spec inconsistency #12

jshimko opened this issue Sep 18, 2017 · 1 comment
Assignees
Labels

Comments

@jshimko
Copy link

jshimko commented Sep 18, 2017

The API spec has several inconsistently formatted inputs in the request bodies. There are underscores, camelCase, no separation (as with namespaceid for listing applications), etc. In several cases, there are a mix of these syntaxes within the same object.

Also, every resource endpoint other than clusters is a plural noun (clusters is /v1/projects/${projectId}/cluster). It also looks like you can't list clusters because that endpoint doesn't exist. Every other resource type can be listed.

@sostheim
Copy link
Owner

Thanks for pointing these inconsistencies!

The last item you mention is intentional however. There is a restriction that node pools to namespace be 1 to 1. Therefore the cluster endpoint is a single object and not a collection, thus the singular name. So, as you pointed out, there is no list operation on a clusters collection.
The only way to GET a cluster is from the endpoing /v1/projects/{projectid}/cluster/{resource_id}.

Projects to namespaces is 1 to many and namespaces to applications is also 1 to many. Thus the plural naming.

@sostheim sostheim self-assigned this Sep 19, 2017
@sostheim sostheim added the bug label Sep 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants