Merge pull request #15 from trcox/RAML-Reference

Update and cleanup RAML Specification

Author: jpwhitemn

src/test/resources/raml/export-client.raml

@@ -16,7 +16,7 @@ schemas:
             required: true
             repeat: false
     delete: 
-        description: Delete a client export registration by database id. Return NotFoundException (HTTP 404) if the existing export registration cannot be found by id. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Delete a client export registration by database id. Return NotFoundException (HTTP 404) if the existing export registration cannot be found by id. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: delete an ExportRegistration by database generated id
         responses: 
             "200": 
@@ -36,7 +36,7 @@ schemas:
             required: true
             repeat: false
     delete: 
-        description: Delete a client export registration by name.  Return NotFoundException (HTTP 404) if the existing export registration cannot be found by name. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Delete a client export registration by name.  Return NotFoundException (HTTP 404) if the existing export registration cannot be found by name. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: delete an ExportRegistration by unique name
         responses: 
             "200": 
@@ -46,15 +46,15 @@ schemas:
             "503": 
                 description: or unknown or unanticipated issues
     get: 
-        description: Fetch a client export registration by unique name. Response will be null if no export registration matches on name. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Fetch a client export registration by unique name. Response will be null if no export registration matches on name. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: get an ExportRegistration by unique name
         responses: 
             "200": 
                 description: the export registration matching the identifier provided
                 body: 
                     application/json: 
                         schema: ExportRegistration
-                        example: '{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"tcp://m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
+                        example: '{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
             "503": 
                 description: for unknown or unanticipated issues
 /registration/{id}: 
@@ -68,34 +68,34 @@ schemas:
             required: false
             repeat: false
     get: 
-        description: Fetch a client export registration by id. Response will be null if no export registration matches on id. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Fetch a client export registration by id. Response will be null if no export registration matches on id. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: get an ExportRegistration by database id
         responses: 
             "200": 
                 description: the export registration matching the identifier provided
                 body: 
                     application/json: 
                         schema: ExportRegistration
-                        example: '{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"tcp://m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
+                        example: '{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
             "503": 
                 description: for unknown or unanticipated issues
 /registration: 
     displayName: Export Registration Resource
     description: "example - http://localhost:48071/api/v1/registration"
     post: 
-        description: Add a new client export registration. Name must be unique across the database. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Add a new client export registration. Name must be unique across the database. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: add a new client ExportRegistration
         body: 
             application/json: 
                 schema: ExportRegistration
-                example: '{"origin":1471806386919,"name":"OSIClient","addressable":{"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"tcp://m10.cloudmqtt.com","port":15421,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat", "hallwaythermostat"],"valueDescriptorIdentifiers":["temperature", "humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
+                example: '{"origin":1471806386919,"name":"OSIClient","addressable":{"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"m10.cloudmqtt.com","port":15421,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat", "hallwaythermostat"],"valueDescriptorIdentifiers":["temperature", "humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}'
         responses: 
             "200": 
                 description: the database generated id for the new export registration.
             "503": 
                 description: for unknown or unanticipated issues.
     put: 
-        description: Update a client export registration. Name & id are not updated as they are identifiers. Return NotFoundException (HTTP 404) if the existing export registration cannot be found by id or name. Return ServcieException (HTTP 503) for unknown or unanticipated issues.
+        description: Update a client export registration. Name & id are not updated as they are identifiers. Return NotFoundException (HTTP 404) if the existing export registration cannot be found by id or name. Return ServiceException (HTTP 503) for unknown or unanticipated issues.
         displayName: update an ExportRegistration
         body: 
             application/json: 
@@ -109,17 +109,38 @@ schemas:
             "503": 
                 description: for unknown or unanticipated issues
     get: 
-        description: Fetch all client export registrations. Return ServcieException (HTTP 503) for unknown or unanticipated issues. No limits are exercised on this query at this time. May need to add this in the future if the number of clients is huge.
+        description: Fetch all client export registrations. Return ServiceException (HTTP 503) for unknown or unanticipated issues. No limits are exercised on this query at this time. May need to add this in the future if the number of clients is huge.
         displayName: get all ExportRegistrations
         responses: 
             "200": 
                 description: a list of all client export registrations
                 body: 
                     application/json: 
                         schema: ExportRegistration
-                        example: '[{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"tcp://m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}]'
+                        example: '[{"id":"57db5bd2add4d779d38ff066","created":1473993682339,"modified":1473993682339,"origin":1471806386919,"name":"OSIClient","addressable":{"id":null,"created":0,"modified":0,"origin":1471806386919,"name":"OSIMQTTBroker","protocol":"TCP","address":"m10.cloudmqtt.com","port":15421,"path":null,"publisher":"EdgeXExportPublisher","user":"hukfgtoh","password":"uP6hJLYW6Ji4","topic":"EdgeXDataTopic"},"format":"JSON","filter":{"deviceIdentifiers":["livingroomthermosat","hallwaythermostat"],"valueDescriptorIdentifiers":["temperature","humidity"]},"encryption":{"encryptionAlgorithm":"AES","encryptionKey":"123","initializingVector":"123"},"compression":"GZIP","enable":true}]'
             "503": 
                 description: for unknown or unanticipated issues
+/registration/reference/{type}:
+    displayName: Export Registration Reference Options Resource
+    description: "example - http://localhost:48071/api/v1/registration/reference/compressions"
+    uriParameters: 
+        type: 
+            displayName: type
+            description: Export Client registration property type. Valid types are: "algorithms", "compressions", "formats", and "destinations".
+            type: string
+            required: true
+            repeat: false
+    get: 
+        description: Fetch all supported values for the specified Export Client registration property type. Types are algorithms, compressions, formats, and destinations. Return ServiceException (HTTP 503) for unknown type specifications.
+        displayName: get all supported values for the specified type
+        responses: 
+            "200": 
+                description: a list of all supported values for the specified client export registration property type
+                body: 
+                    application/json: 
+                        example: '["NONE","GZIP","ZIP"]'
+            "503": 
+                description: for unknown types or unanticipated issues
 /ping: 
     displayName: Ping Resource
     description: "example - http://localhost:48071/api/v1/ping"