web-service-index.md

layout	title	section	permalink	site_section
default	Web service index	Syntax	/docs/syntax/web-service-index/	about-origami

Web service index format

All Origami web services are required to expose an /__about endpoint to list the available versions 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
versions [	array*	A list of versions
"..."	string*	URL of a version of the web service. Repeat for additional versions. May be specified as a full URL, or just the path component of the URL, in which case the full URL can be determined by using the same scheme and hostname as the URL that served the web service index document.
]
}

Example

{
  "name": "tweet-service",
  "versions": [
    "http://tweet.webservices.ft.com/v1",
    "http://tweet.webservices.ft.com/v2"
  ]
}