From f09f1bab49db41a8b49f651894637a40d4fb8e1a Mon Sep 17 00:00:00 2001 From: "Jonathan Thorpe (Sony)" Date: Mon, 5 Feb 2024 17:18:54 +0000 Subject: [PATCH] Add documentation and copyright comment --- APIs/ConfigurationAPI.raml | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/APIs/ConfigurationAPI.raml b/APIs/ConfigurationAPI.raml index 05e78f4..797d71a 100644 --- a/APIs/ConfigurationAPI.raml +++ b/APIs/ConfigurationAPI.raml @@ -1,14 +1,20 @@ #%RAML 1.0 -title: NMOS Configuration API -baseUri: http://api.example.com/x-nmos/configuration/{version} -version: 1.0 -uses: - assets: assets.lib.raml +# AMWA NMOS Device Connection Management Specification: Connection API +# (c) AMWA 2024 + +title: Configuration +baseUri: http://api.example.com/x-nmos/configuration/{version} +version: v1.0 +mediaType: application/json -annotationTypes: - monitoringInterval: - type: integer +documentation: + - title: Overview + content: | + The Configuration API is... + - title: API Structure + content: | + The API presents... /: displayName: Base get: @@ -21,12 +27,12 @@ annotationTypes: /rolePaths: displayName: Role Paths get: - responses: + description: Returns the name of the root block of the Device Model + responses: 200: body: example: !include ../examples/rolePaths-base-get-200.json type: !include schemas/rolePaths-base.json - description: List rolePaths /{rolePath}: uriParameters: rolePath: