raml: update to raml 1.0

AMWA-TV · Oct 29, 2018 · e1eb00d · e1eb00d
1 parent 19f8937
commit e1eb00d
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 95 deletions.
diff --git a/APIs/NodeAPI.raml b/APIs/NodeAPI.raml
@@ -1,4 +1,4 @@
-#%RAML 0.8
+#%RAML 1.0
 
 # AMWA NMOS Discovery and Registration Specification: Node API
 # (c) AMWA 2016
@@ -7,21 +7,21 @@ title: Node
 baseUri: http://example.api.com/x-nmos/node/{version}
 version: v1.0
 mediaType: application/json
-schemas:
-  - Node: !include schemas/node.json
-    Nodes: !include schemas/nodes.json
-    Device: !include schemas/device.json
-    Devices: !include schemas/devices.json
-    Source: !include schemas/source.json
-    Sources: !include schemas/sources.json
-    Flow: !include schemas/flow.json
-    Flows: !include schemas/flows.json
-    Sender: !include schemas/sender.json
-    Senders: !include schemas/senders.json
-    SenderTarget: !include schemas/sender-target.json
-    Receiver: !include schemas/receiver.json
-    Receivers: !include schemas/receivers.json
-    ErrorSchema: !include schemas/error.json
+types:
+  Node: !include schemas/node.json
+  Nodes: !include schemas/nodes.json
+  Device: !include schemas/device.json
+  Devices: !include schemas/devices.json
+  Source: !include schemas/source.json
+  Sources: !include schemas/sources.json
+  Flow: !include schemas/flow.json
+  Flows: !include schemas/flows.json
+  Sender: !include schemas/sender.json
+  Senders: !include schemas/senders.json
+  SenderTarget: !include schemas/sender-target.json
+  Receiver: !include schemas/receiver.json
+  Receivers: !include schemas/receivers.json
+  ErrorSchema: !include schemas/error.json
 documentation:
   - title: Overview
     content: |
@@ -63,7 +63,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-base-get-200.json
-          schema: !include schemas/nodeapi-base.json
+          type: !include schemas/nodeapi-base.json
 /self:
   displayName: Self
   get:
@@ -72,7 +72,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-self-get-200.json
-          schema: Node
+          type: Node
 /sources:
   displayName: Sources
   get:
@@ -81,7 +81,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-sources-get-200.json
-          schema: Sources
+          type: Sources
   /{sourceId}:
     uriParameters:
       sourceId:
@@ -93,11 +93,11 @@ documentation:
         200:
           body:
             example: !include ../examples/nodeapi-v1.0-sourceid-get-200.json
-            schema: Source
+            type: Source
         404:
           description: Returned when the requested Source ID does not exist
           body:
-            schema: ErrorSchema
+            type: ErrorSchema
 /flows:
   displayName: Flows
   get:
@@ -106,7 +106,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-flows-get-200.json
-          schema: Flows
+          type: Flows
   /{flowId}:
     uriParameters:
       flowId:
@@ -118,11 +118,11 @@ documentation:
         200:
           body:
             example: !include ../examples/nodeapi-v1.0-flowid-get-200.json
-            schema: Flow
+            type: Flow
         404:
           description: Returned when the requested Flow ID does not exist
           body:
-            schema: ErrorSchema
+            type: ErrorSchema
 /devices:
   displayName: Devices
   get:
@@ -131,7 +131,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-devices-get-200.json
-          schema: Devices
+          type: Devices
   /{deviceId}:
     uriParameters:
       deviceId:
@@ -143,11 +143,11 @@ documentation:
         200:
           body:
             example: !include ../examples/nodeapi-v1.0-deviceid-get-200.json
-            schema: Device
+            type: Device
         404:
           description: Returned when the requested Device ID does not exist
           body:
-            schema: ErrorSchema
+            type: ErrorSchema
 /senders:
   displayName: Senders
   get:
@@ -156,7 +156,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-senders-get-200.json
-          schema: Senders
+          type: Senders
   /{senderId}:
     uriParameters:
       senderId:
@@ -168,11 +168,11 @@ documentation:
         200:
           body:
             example: !include ../examples/nodeapi-v1.0-senderid-get-200.json
-            schema: Sender
+            type: Sender
         404:
           description: Returned when the requested Sender ID does not exist
           body:
-            schema: ErrorSchema
+            type: ErrorSchema
 /receivers:
   displayName: Receivers
   get:
@@ -181,7 +181,7 @@ documentation:
       200:
         body:
           example: !include ../examples/nodeapi-v1.0-receivers-get-200.json
-          schema: Receivers
+          type: Receivers
   /{receiverId}:
     uriParameters:
       receiverId:
@@ -193,27 +193,27 @@ documentation:
         200:
           body:
             example: !include ../examples/nodeapi-v1.0-receiverid-get-200.json
-            schema: Receiver
+            type: Receiver
         404:
           description: Returned when the requested Receiver ID does not exist
           body:
-            schema: ErrorSchema
+            type: ErrorSchema
     /target:
       put:
         description: Request a change to a Receiver's subscription
         body:
           example: !include ../examples/nodeapi-v1.0-receivertarget-put-request.json
-          schema: !include schemas/nodeapi-receiver-target.json
+          type: !include schemas/nodeapi-receiver-target.json
         responses:
           202:
             body:
               example: !include ../examples/nodeapi-v1.0-receivertarget-put-200.json
-              schema: SenderTarget
+              type: SenderTarget
           400:
             description: Returned when the PUT request is incorrectly formatted or missing mandatory attributes
             body:
-              schema: ErrorSchema
+              type: ErrorSchema
           404:
             description: Returned when the requested Receiver ID does not exist
             body:
-              schema: ErrorSchema
+              type: ErrorSchema