{ "swagger": "2.0", "info": { "description": "This is a documentation for Eaas api-experiments", "version": "0.1.0", "title": "Eaas Event Instances", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "basePath": "/", "tags": [ { "name": "event instances", "externalDocs": { "description": "Find out more", "url": "http://swagger.io" } } ], "schemes": [ "https", "http" ], "paths": { "/data_collection_projects/{projectID}/event_configs/{configID}/event_instances": { "get": { "tags": [ "event instances" ], "summary": "Get the project's event instance", "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success" }, "404": { "description": "Not found" }, "405": { "description": "Invalid input" } }, "parameters": [ { "in": "path", "name": "projectID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "configID", "required": true, "type": "integer", "format": "int64" } ], "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "event instances" ], "summary": "Add a new event instance to the project", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "projectID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "configID", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "event_instance", "schema": { "type": "object", "required": ["parent_entry_id"], "properties":{ "parent_entry_id":{ "type": "integer" }, "start_frame_num":{ "type": "integer", "example":20 }, "end_frame_num":{ "type": "integer", "example":40 }, "start_ts_ms":{ "type": "integer", "example":16433976073929140 }, "end_ts_ms":{ "type": "integer", "example":16433976073929170 } } } } ], "responses": { "201": { "description": "Success,created" }, "422":{ "description": "Unprocessable Entity" } }, "security": [ { "basicAuth": [] } ] } }, "/data_collection_projects/{projectID}/event_configs/{configsID}/event_instances/{instanceID}": { "get": { "tags": [ "event instances" ], "summary": "Find an event instance by ID", "description": "Returns a single event instance", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "projectID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "configsID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "instanceID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request" }, "404": { "description": "Not found" } }, "security": [ { "basicAuth": [] } ] }, "put": { "tags": [ "event instances" ], "summary": "Updates an event instance", "description": "", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "projectID", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "configsID", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "instanceID", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "event_instances", "schema": { "type": "object", "properties":{ "start_frame_num":{ "type": "integer", "example":20 }, "end_frame_num":{ "type": "integer", "example":40 }, "start_ts_ms":{ "type": "integer", "example":16433976073929140 }, "end_ts_ms":{ "type": "integer", "example":16433976073929170 } } } } ], "responses": { "200": { "description": "Updated successfully" }, "400": { "description": "Bad request" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "event instances" ], "summary": "Delete event instance by ID", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "projectID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "configsID", "required": true, "type": "integer", "format": "int64" }, { "in": "path", "name": "instanceID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "204": { "description": "Deleted successfully" }, "400": { "description": "Bad request" }, "404": { "description": "Not found" } }, "security": [ { "basicAuth": [] } ] } } }, "securityDefinitions": { "basicAuth":{ "type": "basic" } }, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" } }