Origami

Web service description format

All Origami web services are required to expose /{version}/__about endpoints to describe each version of the service. The response given at this URL must be a JSON document conforming to the following format.

Format

Property Type Description
{
  name string* The repo name of the web service
  apiVersion number* Integer version number of the API described by this document (ie. the version exposed in the URL path)
  appVersion string* Code version number (ie the version tag on the revision of the code that is checked out into this running instance)
  dateCreated string* ISO8601-format date when the app was first created
  support string* Copied from the matching property in the component's origami.json file. For services that support all API versions in a single code version, it may be necessary to consult prior versions' origami.json files in order to find the appropriate value.
  supportStatus string* Copied from the matching property in the component's origami.json file. For services that support all API versions in a single code version, it may be necessary to consult prior versions' origami.json files in order to find the appropriate value.
}

Example

{
  "name": "tweet-service",
  "apiVersion": 1,
  "appVersion": "1.3.1",
  "dateCreated": "2013-09-25T09:32:12+0200"
  "support": "origamisupport-service-tweet@ft.com",
  "supportStatus": "active",
}
“Ship it”