get-capability-metadata

Specification Version

This endpoint is not versioned as it returns the version that all other endpoints must conform to. Any changes to this endpoint will be backwards compatible.

Context and rules

Must be implemented for all AireGlu data sources regardless of capability support. As per the schema below you must implement the Capabilities property, and may implement additional properties.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-capability-metadata
• Verb: GET
• Authentication: Client credentials

Input

• Format: None

Response

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-capabilities-metadata-response",
	"type": "object",
	"properties": {
		"Capabilities": {
			"type": "array",
			"items": {
				"type": "string",
				"enum": ["SubjectRead", "StructuredData"],
				"uniqueItems": true
			},
			"minItems": 1
		},
		"Version": {
			"type": "string"
		},
		"CacheStructuredData": {
			"type": "boolean"
		}
	},
	"required": [
		"Capabilities"
	]
}

• Example

{
    "Capabilities": ["SubjectRead", "StructuredData"],
	"Version": "2",
	"CacheStructuredData": true
}

• Explanation of properties

Capabilities: Describes which capabilities this AireGlu data source provides, so that it is made available in the appropriate areas within AireFrame.The current available capabilities which you may choose to implement are StructuredData and SubjectRead.

Version: Describes which version of the endpoint specifications you are implementing so that the return data can be appropriately deserialized in the event of changes within AireFrame. If the Version property is not provided the value will be read as "1".

CacheStructuredData: Indicates whether you would like structured data to be cached. If the CacheStructuredData property is not provided and you have implemented the StructuredData capability the value will be read as true. Where structured data is cached, you will need to use the available methods of refreshing the cache.