Example API documentation version v1.0

http://api.example.com/x-nmos/example/{version}

  • version: required(v1.0)

Overview

This is an example API so the template works

Base

get

get

List of paths available from this API

List of paths available from this API

HTTP status code 200

Body

Media type: application/json

Type:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes the Example API base resource",
  "title": "Example API base resource",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "$ref": "id-uuid.json" 
    }
  }
}

Example:

{
    "id": "67194c23-4f7d-4246-b440-8184394c2a80"
}