Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@xadahiya

xadahiya/server_api_doc.py

Last active August 29, 2017 10:19
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xadahiya/9b8e27aab77c1d73a8be950e70abc3cb to your computer and use it in GitHub Desktop.
Save xadahiya/9b8e27aab77c1d73a8be950e70abc3cb to your computer and use it in GitHub Desktop.
Download ZIP
Raw
server_api_doc.py
"""
Generated API Documentation for Server API using server_doc_gen.py."""
doc = {
"@context": {
"ApiDocumentation": "hydra:ApiDocumentation",
"description": "hydra:description",
"domain": {
"@id": "rdfs:domain",
"@type": "@id"
},
"expects": {
"@id": "hydra:expects",
"@type": "@id"
},
"hydra": "http://www.w3.org/ns/hydra/core#",
"label": "rdfs:label",
"method": "hydra:method",
"possibleStatus": "hydra:possibleStatus",
"property": {
"@id": "hydra:property",
"@type": "@id"
},
"range": {
"@id": "rdfs:range",
"@type": "@id"
},
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
"readonly": "hydra:readonly",
"required": "hydra:required",
"returns": {
"@id": "hydra:returns",
"@type": "@id"
},
"statusCode": "hydra:statusCode",
"statusCodes": "hydra:statusCodes",
"subClassOf": {
"@id": "rdfs:subClassOf",
"@type": "@id"
},
"supportedClass": "hydra:supportedClass",
"supportedOperation": "hydra:supportedOperation",
"supportedProperty": "hydra:supportedProperty",
"title": "hydra:title",
"vocab": "http://localhost:8080/api/vocab#",
"writeonly": "hydra:writeonly"
},
"@id": "http://localhost:8080/api/vocab",
"@type": "ApiDocumentation",
"description": "API Documentation for the server side system",
"possibleStatus": [],
"supportedClass": [
{
"@id": "vocab:Datastream",
"@type": "hydra:Class",
"description": "Class for a datastream entry",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Data not found",
"statusCode": 404
},
{
"description": "Data returned",
"statusCode": 200
}
],
"returns": "vocab:Datastream",
"title": "ReadDatastream"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/QuantitativeValue",
"readonly": "false",
"required": "true",
"title": "Temperature",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/geo",
"readonly": "false",
"required": "true",
"title": "Position",
"writeonly": "false"
}
],
"title": "Datastream"
},
{
"@id": "vocab:HttpApiLog",
"@type": "hydra:Class",
"description": "Class for a http api log entry",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "HttpApiLog not found",
"statusCode": 404
},
{
"description": "HttpApiLog returned",
"statusCode": 200
}
],
"returns": "vocab:HttpApiLog",
"title": "ReadHttpApiLog"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "Subject",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/Action",
"readonly": "false",
"required": "true",
"title": "Predicate",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "Object",
"writeonly": "false"
}
],
"title": "HttpApiLog"
},
{
"@id": "vocab:State",
"@type": "hydra:Class",
"description": "Class for drone state objects",
"supportedOperation": [],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://auto.schema.org/speed",
"readonly": "false",
"required": "true",
"title": "Speed",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/geo",
"readonly": "false",
"required": "true",
"title": "Position",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/Property",
"readonly": "false",
"required": "true",
"title": "Direction",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/fuelCapacity",
"readonly": "false",
"required": "true",
"title": "Battery",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "https://schema.org/status",
"readonly": "false",
"required": "true",
"title": "Status",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
}
],
"title": "State"
},
{
"@id": "vocab:Command",
"@type": "hydra:Class",
"description": "Class for drone commands",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Command not found",
"statusCode": 404
},
{
"description": "Command Returned",
"statusCode": 200
}
],
"returns": "vocab:Command",
"title": "GetCommand"
},
{
"@type": "http://schema.org/AddAction",
"expects": "vocab:Command",
"method": "PUT",
"possibleStatus": [
{
"description": "Command added",
"statusCode": 201
}
],
"returns": "null",
"title": "AddCommand"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "vocab:State",
"readonly": "false",
"required": "true",
"title": "State",
"writeonly": "false"
}
],
"title": "Command"
},
{
"@id": "vocab:Location",
"@type": "hydra:Class",
"description": "Class for location of the central controller.",
"supportedOperation": [
{
"@type": "http://schema.org/UpdateAction",
"expects": "vocab:Location",
"method": "POST",
"possibleStatus": [
{
"description": "Controller location updated successfully.",
"statusCode": 200
}
],
"returns": "null",
"title": "UpdateLocation"
},
{
"@type": "http://schema.org/AddAction",
"expects": "vocab:Location",
"method": "PUT",
"possibleStatus": [
{
"description": "Controller location added successfully.",
"statusCode": 200
}
],
"returns": "null",
"title": "AddLocation"
},
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Location of Controller not found.",
"statusCode": 404
},
{
"description": "Location of controller returned.",
"statusCode": 200
}
],
"returns": "vocab:Location",
"title": "GetLocation"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/geo",
"readonly": "false",
"required": "true",
"title": "Location",
"writeonly": "false"
}
],
"title": "Location"
},
{
"@id": "vocab:Drone",
"@type": "hydra:Class",
"description": "Class for a drone",
"supportedOperation": [
{
"@type": "http://schema.org/UpdateAction",
"expects": "vocab:Drone",
"method": "POST",
"possibleStatus": [
{
"description": "Drone updated",
"statusCode": 200
}
],
"returns": "null",
"title": "SubmitDrone"
},
{
"@type": "http://schema.org/AddAction",
"expects": "vocab:Drone",
"method": "PUT",
"possibleStatus": [
{
"description": "Drone updated",
"statusCode": 200
}
],
"returns": "null",
"title": "UpdateDrone"
},
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Drone not found",
"statusCode": 404
},
{
"description": "Drone Returned",
"statusCode": 200
}
],
"returns": "vocab:Drone",
"title": "GetDrone"
},
{
"@type": "http://schema.org/DeleteAction",
"expects": "null",
"method": "DELETE",
"possibleStatus": [
{
"description": "Drone not found",
"statusCode": 404
},
{
"description": "Drone successfully deleted.",
"statusCode": 200
}
],
"returns": "null",
"title": "DeleteDrone"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "vocab:State",
"readonly": "false",
"required": "true",
"title": "State",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/name",
"readonly": "false",
"required": "true",
"title": "name",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/model",
"readonly": "false",
"required": "true",
"title": "model",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://auto.schema.org/speed",
"readonly": "false",
"required": "true",
"title": "MaxSpeed",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/device",
"readonly": "false",
"required": "true",
"title": "Sensor",
"writeonly": "false"
}
],
"title": "Drone"
},
{
"@id": "vocab:ControllerLog",
"@type": "hydra:Class",
"description": "Class for a controller log entry",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "ControllerLog not found",
"statusCode": 404
},
{
"description": "ControllerLog returned",
"statusCode": 200
}
],
"returns": "vocab:ControllerLog",
"title": "ReadControllerLog"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/Text",
"readonly": "false",
"required": "true",
"title": "LogString",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
}
],
"title": "ControllerLog"
},
{
"@id": "vocab:Anomaly",
"@type": "hydra:Class",
"description": "Class for Temperature anomalies that need to be confirmed",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Anomaly not found",
"statusCode": 404
},
{
"description": "Anomaly returned",
"statusCode": 200
}
],
"returns": "vocab:Anomaly",
"title": "GetAnomaly"
},
{
"@type": "http://schema.org/AddAction",
"expects": "vocab:Anomaly",
"method": "PUT",
"possibleStatus": [
{
"description": "Anomaly added successfully.",
"statusCode": 200
}
],
"returns": "null",
"title": "AddAnomaly"
},
{
"@type": "http://schema.org/UpdateAction",
"expects": "vocab:Anomaly",
"method": "POST",
"possibleStatus": [
{
"description": "Anomaly updated successfully.",
"statusCode": 201
}
],
"returns": "null",
"title": "UpdateAnomaly"
},
{
"@type": "http://schema.org/DeleteAction",
"expects": "null",
"method": "DELETE",
"possibleStatus": [
{
"description": "Anomaly not found",
"statusCode": 404
},
{
"description": "Anomaly successfully deleted.",
"statusCode": 200
}
],
"returns": "null",
"title": "DeleteAnomaly"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "vocab:Location",
"readonly": "false",
"required": "true",
"title": "Location",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/eventStatus",
"readonly": "false",
"required": "true",
"title": "Status",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "AnomalyID",
"writeonly": "false"
}
],
"title": "Anomaly"
},
{
"@id": "vocab:DroneLog",
"@type": "hydra:Class",
"description": "Class for a drone log entry",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "DroneLog not found",
"statusCode": 404
},
{
"description": "DroneLog returned",
"statusCode": 200
}
],
"returns": "vocab:DroneLog",
"title": "ReadDroneLog"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/identifier",
"readonly": "false",
"required": "true",
"title": "DroneID",
"writeonly": "false"
},
{
"@type": "SupportedProperty",
"property": "http://schema.org/Text",
"readonly": "false",
"required": "true",
"title": "LogString",
"writeonly": "false"
}
],
"title": "DroneLog"
},
{
"@id": "vocab:Message",
"@type": "hydra:Class",
"description": "Class for messages received by the GUI interface",
"supportedOperation": [
{
"@type": "hydra:Operation",
"expects": "null",
"method": "GET",
"possibleStatus": [
{
"description": "Message not found",
"statusCode": 404
},
{
"description": "Message returned",
"statusCode": 200
}
],
"returns": "vocab:Message",
"title": "GetMessage"
},
{
"@type": "http://schema.org/DeleteAction",
"expects": "null",
"method": "DELETE",
"possibleStatus": [
{
"description": "Message not found",
"statusCode": 404
},
{
"description": "Message successfully deleted.",
"statusCode": 200
}
],
"returns": "null",
"title": "DeleteMessage"
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://schema.org/Text",
"readonly": "false",
"required": "true",
"title": "MessageString",
"writeonly": "false"
}
],
"title": "Message"
},
{
"@id": "http://www.w3.org/ns/hydra/core#Resource",
"@type": "hydra:Class",
"description": "null",
"supportedOperation": [],
"supportedProperty": [],
"title": "Resource"
},
{
"@id": "http://www.w3.org/ns/hydra/core#Collection",
"@type": "hydra:Class",
"description": "null",
"supportedOperation": [],
"supportedProperty": [
{
"@type": "SupportedProperty",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "null",
"title": "members",
"writeonly": "false"
}
],
"title": "Collection"
},
{
"@id": "vocab:CommandCollection",
"@type": "hydra:Class",
"description": "A collection of command",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:command_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Command entities",
"expects": "null",
"method": "GET",
"returns": "vocab:CommandCollection",
"statusCodes": []
},
{
"@id": "_:command_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Command entitity",
"expects": "vocab:Command",
"method": "PUT",
"returns": "vocab:Command",
"statusCodes": [
{
"description": "If the Command entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The command",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "CommandCollection"
},
{
"@id": "vocab:ControllerLogCollection",
"@type": "hydra:Class",
"description": "A collection of controllerlog",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:controllerlog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all ControllerLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:ControllerLogCollection",
"statusCodes": []
},
{
"@id": "_:controllerlog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new ControllerLog entitity",
"expects": "vocab:ControllerLog",
"method": "PUT",
"returns": "vocab:ControllerLog",
"statusCodes": [
{
"description": "If the ControllerLog entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The controllerlog",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "ControllerLogCollection"
},
{
"@id": "vocab:DroneLogCollection",
"@type": "hydra:Class",
"description": "A collection of dronelog",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:dronelog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all DroneLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DroneLogCollection",
"statusCodes": []
},
{
"@id": "_:dronelog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new DroneLog entitity",
"expects": "vocab:DroneLog",
"method": "PUT",
"returns": "vocab:DroneLog",
"statusCodes": [
{
"description": "If the DroneLog entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The dronelog",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "DroneLogCollection"
},
{
"@id": "vocab:HttpApiLogCollection",
"@type": "hydra:Class",
"description": "A collection of httpapilog",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:httpapilog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all HttpApiLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:HttpApiLogCollection",
"statusCodes": []
},
{
"@id": "_:httpapilog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new HttpApiLog entitity",
"expects": "vocab:HttpApiLog",
"method": "PUT",
"returns": "vocab:HttpApiLog",
"statusCodes": [
{
"description": "If the HttpApiLog entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The httpapilog",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "HttpApiLogCollection"
},
{
"@id": "vocab:DatastreamCollection",
"@type": "hydra:Class",
"description": "A collection of datastream",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:datastream_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Datastream entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DatastreamCollection",
"statusCodes": []
},
{
"@id": "_:datastream_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Datastream entitity",
"expects": "vocab:Datastream",
"method": "PUT",
"returns": "vocab:Datastream",
"statusCodes": [
{
"description": "If the Datastream entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The datastream",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "DatastreamCollection"
},
{
"@id": "vocab:AnomalyCollection",
"@type": "hydra:Class",
"description": "A collection of anomaly",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:anomaly_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Anomaly entities",
"expects": "null",
"method": "GET",
"returns": "vocab:AnomalyCollection",
"statusCodes": []
},
{
"@id": "_:anomaly_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Anomaly entitity",
"expects": "vocab:Anomaly",
"method": "PUT",
"returns": "vocab:Anomaly",
"statusCodes": [
{
"description": "If the Anomaly entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The anomaly",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "AnomalyCollection"
},
{
"@id": "vocab:DroneCollection",
"@type": "hydra:Class",
"description": "A collection of drone",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:drone_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Drone entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DroneCollection",
"statusCodes": []
},
{
"@id": "_:drone_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Drone entitity",
"expects": "vocab:Drone",
"method": "PUT",
"returns": "vocab:Drone",
"statusCodes": [
{
"description": "If the Drone entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The drone",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "DroneCollection"
},
{
"@id": "vocab:MessageCollection",
"@type": "hydra:Class",
"description": "A collection of message",
"subClassOf": "http://www.w3.org/ns/hydra/core#Collection",
"supportedOperation": [
{
"@id": "_:message_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Message entities",
"expects": "null",
"method": "GET",
"returns": "vocab:MessageCollection",
"statusCodes": []
},
{
"@id": "_:message_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Message entitity",
"expects": "vocab:Message",
"method": "PUT",
"returns": "vocab:Message",
"statusCodes": [
{
"description": "If the Message entity was created successfully.",
"statusCode": 201
}
]
}
],
"supportedProperty": [
{
"@type": "SupportedProperty",
"description": "The message",
"property": "http://www.w3.org/ns/hydra/core#member",
"readonly": "false",
"required": "false",
"title": "members",
"writeonly": "false"
}
],
"title": "MessageCollection"
},
{
"@id": "vocab:EntryPoint",
"@type": "hydra:Class",
"description": "The main entry point or homepage of the API.",
"supportedOperation": [
{
"@id": "_:entry_point",
"@type": "hydra:Operation",
"description": "The APIs main entry point.",
"expects": "null",
"method": "GET",
"returns": "null",
"statusCodes": "vocab:EntryPoint"
}
],
"supportedProperty": [
{
"hydra:description": "The Location Class",
"hydra:title": "location",
"property": {
"@id": "vocab:EntryPoint/Location",
"@type": "hydra:Link",
"description": "Class for location of the central controller.",
"domain": "vocab:EntryPoint",
"label": "Location",
"range": "vocab:Location",
"supportedOperation": [
{
"@id": "_:updatelocation",
"@type": "hydra:Operation",
"description": "null",
"expects": "vocab:Location",
"label": "UpdateLocation",
"method": "POST",
"returns": "null",
"statusCodes": [
{
"description": "Controller location updated successfully.",
"statusCode": 200
}
]
},
{
"@id": "_:addlocation",
"@type": "hydra:Operation",
"description": "null",
"expects": "vocab:Location",
"label": "AddLocation",
"method": "PUT",
"returns": "null",
"statusCodes": [
{
"description": "Controller location added successfully.",
"statusCode": 200
}
]
},
{
"@id": "_:getlocation",
"@type": "hydra:Operation",
"description": "null",
"expects": "null",
"label": "GetLocation",
"method": "GET",
"returns": "vocab:Location",
"statusCodes": [
{
"description": "Location of Controller not found.",
"statusCode": 404
},
{
"description": "Location of controller returned.",
"statusCode": 200
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The CommandCollection collection",
"hydra:title": "commandcollection",
"property": {
"@id": "vocab:EntryPoint/CommandCollection",
"@type": "hydra:Link",
"description": "The CommandCollection collection",
"domain": "vocab:EntryPoint",
"label": "CommandCollection",
"range": "vocab:CommandCollection",
"supportedOperation": [
{
"@id": "_:_:command_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Command entities",
"expects": "null",
"method": "GET",
"returns": "vocab:CommandCollection",
"statusCodes": []
},
{
"@id": "_:_:command_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Command entitity",
"expects": "vocab:Command",
"method": "PUT",
"returns": "vocab:Command",
"statusCodes": [
{
"description": "If the Command entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The ControllerLogCollection collection",
"hydra:title": "controllerlogcollection",
"property": {
"@id": "vocab:EntryPoint/ControllerLogCollection",
"@type": "hydra:Link",
"description": "The ControllerLogCollection collection",
"domain": "vocab:EntryPoint",
"label": "ControllerLogCollection",
"range": "vocab:ControllerLogCollection",
"supportedOperation": [
{
"@id": "_:_:controllerlog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all ControllerLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:ControllerLogCollection",
"statusCodes": []
},
{
"@id": "_:_:controllerlog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new ControllerLog entitity",
"expects": "vocab:ControllerLog",
"method": "PUT",
"returns": "vocab:ControllerLog",
"statusCodes": [
{
"description": "If the ControllerLog entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The DroneLogCollection collection",
"hydra:title": "dronelogcollection",
"property": {
"@id": "vocab:EntryPoint/DroneLogCollection",
"@type": "hydra:Link",
"description": "The DroneLogCollection collection",
"domain": "vocab:EntryPoint",
"label": "DroneLogCollection",
"range": "vocab:DroneLogCollection",
"supportedOperation": [
{
"@id": "_:_:dronelog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all DroneLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DroneLogCollection",
"statusCodes": []
},
{
"@id": "_:_:dronelog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new DroneLog entitity",
"expects": "vocab:DroneLog",
"method": "PUT",
"returns": "vocab:DroneLog",
"statusCodes": [
{
"description": "If the DroneLog entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The HttpApiLogCollection collection",
"hydra:title": "httpapilogcollection",
"property": {
"@id": "vocab:EntryPoint/HttpApiLogCollection",
"@type": "hydra:Link",
"description": "The HttpApiLogCollection collection",
"domain": "vocab:EntryPoint",
"label": "HttpApiLogCollection",
"range": "vocab:HttpApiLogCollection",
"supportedOperation": [
{
"@id": "_:_:httpapilog_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all HttpApiLog entities",
"expects": "null",
"method": "GET",
"returns": "vocab:HttpApiLogCollection",
"statusCodes": []
},
{
"@id": "_:_:httpapilog_create",
"@type": "http://schema.org/AddAction",
"description": "Create new HttpApiLog entitity",
"expects": "vocab:HttpApiLog",
"method": "PUT",
"returns": "vocab:HttpApiLog",
"statusCodes": [
{
"description": "If the HttpApiLog entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The DatastreamCollection collection",
"hydra:title": "datastreamcollection",
"property": {
"@id": "vocab:EntryPoint/DatastreamCollection",
"@type": "hydra:Link",
"description": "The DatastreamCollection collection",
"domain": "vocab:EntryPoint",
"label": "DatastreamCollection",
"range": "vocab:DatastreamCollection",
"supportedOperation": [
{
"@id": "_:_:datastream_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Datastream entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DatastreamCollection",
"statusCodes": []
},
{
"@id": "_:_:datastream_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Datastream entitity",
"expects": "vocab:Datastream",
"method": "PUT",
"returns": "vocab:Datastream",
"statusCodes": [
{
"description": "If the Datastream entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The AnomalyCollection collection",
"hydra:title": "anomalycollection",
"property": {
"@id": "vocab:EntryPoint/AnomalyCollection",
"@type": "hydra:Link",
"description": "The AnomalyCollection collection",
"domain": "vocab:EntryPoint",
"label": "AnomalyCollection",
"range": "vocab:AnomalyCollection",
"supportedOperation": [
{
"@id": "_:_:anomaly_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Anomaly entities",
"expects": "null",
"method": "GET",
"returns": "vocab:AnomalyCollection",
"statusCodes": []
},
{
"@id": "_:_:anomaly_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Anomaly entitity",
"expects": "vocab:Anomaly",
"method": "PUT",
"returns": "vocab:Anomaly",
"statusCodes": [
{
"description": "If the Anomaly entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The DroneCollection collection",
"hydra:title": "dronecollection",
"property": {
"@id": "vocab:EntryPoint/DroneCollection",
"@type": "hydra:Link",
"description": "The DroneCollection collection",
"domain": "vocab:EntryPoint",
"label": "DroneCollection",
"range": "vocab:DroneCollection",
"supportedOperation": [
{
"@id": "_:_:drone_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Drone entities",
"expects": "null",
"method": "GET",
"returns": "vocab:DroneCollection",
"statusCodes": []
},
{
"@id": "_:_:drone_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Drone entitity",
"expects": "vocab:Drone",
"method": "PUT",
"returns": "vocab:Drone",
"statusCodes": [
{
"description": "If the Drone entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
},
{
"hydra:description": "The MessageCollection collection",
"hydra:title": "messagecollection",
"property": {
"@id": "vocab:EntryPoint/MessageCollection",
"@type": "hydra:Link",
"description": "The MessageCollection collection",
"domain": "vocab:EntryPoint",
"label": "MessageCollection",
"range": "vocab:MessageCollection",
"supportedOperation": [
{
"@id": "_:_:message_collection_retrieve",
"@type": "hydra:Operation",
"description": "Retrieves all Message entities",
"expects": "null",
"method": "GET",
"returns": "vocab:MessageCollection",
"statusCodes": []
},
{
"@id": "_:_:message_create",
"@type": "http://schema.org/AddAction",
"description": "Create new Message entitity",
"expects": "vocab:Message",
"method": "PUT",
"returns": "vocab:Message",
"statusCodes": [
{
"description": "If the Message entity was created successfully.",
"statusCode": 201
}
]
}
]
},
"readonly": "true",
"required": "null",
"writeonly": "false"
}
],
"title": "EntryPoint"
}
],
"title": "API Doc for the server side API"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment