Skip to content

Commit

Permalink
Add documentation and copyright comment
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-r-thorpe committed Feb 5, 2024
1 parent cc2be62 commit f09f1ba
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions APIs/ConfigurationAPI.raml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit f09f1ba

Please sign in to comment.