...
for unknown attributes in the request, we will throw an error with a whole list of all of them
for all the response, we will add related HATEOAS link to each configuration responses, such as: return resource link in the response of create/list/get; add resource url for sub resources(region/indexes). more detail, please read "HATEOAS link" in Guidelines for Cluster Management service
http status code: 201 and 409 for create, 200 and 404 for delete, 200 and 404 for put to update
- camelCase is for all the key in the request and response body
HATEOAS link
for every relation between entities, will be shown as links in the output of response.
such as the followings, it is a links part of region and it shows that the related links of current entity(region):
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
"links": {
"indexes": "http://127.0.0.1:7070/management/experimental/regions/REGION6/indexes",
"self": "http://127.0.0.1:7070/management/experimental/regions/REGION6",
"list": "http://127.0.0.1:7070/management/experimental/regions"
} |
some guideline for links:
- all the related resources will be shown in "links" part
- every link includes whole address, begins from "http"/"https"
- there must be a "self" link in every "links", the "self" means current resource(entity)
- there must be a "list" link in every "links", it means the resources (list)
- the "links" part is sibling of "configuration" and "runtimeInfo"
- other link in "link" part must be plural(“-es”)
Long running request:
Rebalance
...