8 VERSION RESOURCE & REPRESENTATION
This resource allows a client to dynamically determine which version of the Restful Objects spec a particular implementation supports, the version of the implementation (code) itself, and which of the optional capabilities §A3 it provides.
The endpoint URL for this resource is:
/version
8.1 HTTP GET
Obtain a representation of the implementation’s version and optional capabilities.
8.1.2 GET Response
8.1.2.2 Headers
-
Content-Type
-
application/json;profile="…/version"
-
-
Caching headers:
-
NON_EXPIRING, see §A2.13
version and capabilities will not change between deployments
-
8.2 Representation
The links from the version representation to other resources are as shown in the diagram below:
The JSON representation is:
{
"links": [ {
"rel": "self",
"href": "http://~/version",
"type": "application/json;profile=\".../version\"",
"method": "GET"
}, {
"rel": "up",
"href": "http://~/",
"type": "application/json;profile=\".../homepage\"",
"method": "GET"
},
...
],
"specVersion": "1.0",
"implVersion": "xxx",
"optionalCapabilities": {
"blobsClobs": "attachments",
"deleteObjects": "no",
"domainModel": "formal",
"protoPersistentObjects": "yes",
"validateOnly": "no"
},
"extensions": { ...
}
}where:
| JSON-Property | Description |
|---|---|
links |
list of links to resources. |
links[rel=self] |
link to a resource that can generate this representation. |
links[rel=up] |
link to the home page resource, §B5. |
specVersion |
The "major.minor" parts of the version of the spec supported by this implementation, e.g. "1.0", see below. |
implVersion |
(optional) Version of the implementation itself (format is specific to the implementation). |
optionalCapabilities |
|
extensions |
additional metadata about the resource. |
"specVersion"
The "specVersion" json-property only specifies the major.minor parts of the spec. An trivial update to the spec (eg 1.0.0 to 1.0.1) will not require implementations issuing a corresponding update.
"optionalCapabilities"
The "optionalCapabilities" json-property holds a map of child properties describing the functionality supported by the implementation.
| Capability | Value type | String value | The implementation’s support for… |
|---|---|---|---|
blobsClobs |
boolean |
-- |
blobs/clobs see §A3.3. |
deleteObjects |
boolean |
-- |
|
domainModel |
string |
|
different domain metadata representations. A value of "selectable" means that the reserved x-domain-model query parameter is supported, see §A3.1 |
protoPersistentObjects |
boolean |
-- |
proto-persistent objects are supported, see §A3 |
validateOnly |
boolean |
-- |
the reserved x-ro-validate-only query parameter, see §A3.2 |