From 1101e080f75ed9827441a3a983c194dbf2a1e914 Mon Sep 17 00:00:00 2001 From: Alexander Sadovsky Date: Tue, 28 Aug 2018 21:16:58 +0200 Subject: [PATCH] deprecate generateSwagger --- README.md | 12 +- swagger.json | 1527 -------------------------------------------------- 2 files changed, 8 insertions(+), 1531 deletions(-) delete mode 100644 swagger.json diff --git a/README.md b/README.md index 6cee539..a8e57ba 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,8 @@ # Note this is a work in progress, some things needs to be done first so we can call this production ready. -- [ ] authentication and user sessions -- [ ] user profile must be defined and implemented -- [ ] manually tested +- [ ] swagger API definition version 1.0.0 +- [ ] system accounts and authentication - [ ] automated tests written and implemented # Roadmap @@ -32,10 +31,15 @@ install dependencies # Seeing the swagger documentation When you are running the server, you can navigate to http://localhost:1337/docs -# Generating swagger file +# Generating swagger file (deprecated) ```yarn run generateSwagger``` creates or overwrites *swagger.json* +We don't use the generated swagger file anymore. +The swagger definition is [hosted on SwaggerHub](https://app.swaggerhub.com/apis/Alino/tapicc-api), and the changes are being synchronised to this github repo [_assets/swaggerhub_](https://github.com/GALAglobal/TAPICC-API-implementation/tree/master/assets/swaggerhub) folder. + + + # Testing ```yarn test``` diff --git a/swagger.json b/swagger.json deleted file mode 100644 index 5626aa5..0000000 --- a/swagger.json +++ /dev/null @@ -1,1527 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "tapicc-api", - "description": "a Sails application", - "version": "0.0.2", - "contact": { - "name": "alino" - }, - "license": { - "name": "" - } - }, - "host": "localhost:1337", - "tags": [ - { - "name": "Swagger" - }, - { - "name": "Asset" - }, - { - "name": "Job" - }, - { - "name": "Task" - }, - { - "name": "User" - }, - { - "name": "Webhook" - } - ], - "definitions": { - "asset": { - "properties": { - "id": { - "type": "integer", - "description": "(auto-generated)", - "format": "int32" - }, - "fileDescriptor": { - "type": "string", - "description": "unique name of the file. (auto-generated)", - "format": "string" - }, - "fileOriginalName": { - "type": "string", - "description": "original name of the file as uploaded. (auto-filled)", - "format": "string" - }, - "isReference": { - "type": "boolean", - "description": "if is set to true, then the Asset is not suppossed to be actionable." - }, - "sourceLanguage": { - "type": "string", - "description": "language code of the source", - "format": "string" - }, - "encoding": { - "type": "string", - "description": "encoding code", - "format": "string" - }, - "jobId": { - "$ref": "#/definitions/job" - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/definitions/task" - } - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - } - } - }, - "job": { - "properties": { - "id": { - "type": "integer", - "description": "(auto-generated)", - "format": "int32" - }, - "name": { - "type": "string", - "description": "name of a Job", - "format": "string" - }, - "description": { - "type": "string", - "format": "string" - }, - "submitDate": { - "type": "string", - "description": "a date when the Job was submit (auto-generated)", - "format": "date-time" - }, - "dueDate": { - "type": "string", - "description": "a date with a deadline", - "format": "date-time" - }, - "closedDate": { - "type": "string", - "description": "a date when the Job was closed", - "format": "date-time" - }, - "submitter": { - "type": "string", - "description": "\"server name / id\" of the user who did submit the Job", - "example": "symfonie.com/43920149320", - "required": true, - "format": "string" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/definitions/asset" - } - }, - "externalId": { - "type": "string", - "description": "external project id, as is defined on the external system", - "format": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "submitter" - ] - }, - "task": { - "properties": { - "id": { - "type": "integer", - "description": "(auto-generated)", - "format": "int32" - }, - "type": { - "type": "string", - "enum": [ - "translation", - "machine translation", - "modification", - "proof" - ], - "required": true, - "format": "string" - }, - "targetLanguage": { - "type": "string", - "description": "language code of the target", - "format": "string" - }, - "progress": { - "type": "string", - "description": "pending - the Task has been created, and it's pending to be reviewed and assigned to someone.\n\nin progress - the Task has been assigned to someone and is being worked on.\n\npaused - the Task went from in progress, to paused, because something is blocking the Task, or the assignee has other priorities.\n\ncanceled - someone did cancel this Task.\n\nfinished - the work on this Task is done and deliverableLocation is filled with a path to deliverable.", - "enum": [ - "pending", - "in progress", - "paused", - "canceled", - "finished" - ], - "default": "pending", - "format": "string" - }, - "assignedTo": { - "type": "string", - "description": "\"server name / id\" of the user who it is assigned to", - "example": "symfonie.com/43920149320", - "format": "string" - }, - "fileDescriptor": { - "type": "string", - "description": "unique name of the file. (auto-generated)", - "format": "string" - }, - "fileOriginalName": { - "type": "string", - "description": "original name of the file as uploaded. (auto-filled)", - "format": "string" - }, - "jobId": { - "$ref": "#/definitions/job" - }, - "assetId": { - "$ref": "#/definitions/asset" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "type" - ] - }, - "user": { - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - } - } - }, - "webhook": { - "properties": { - "id": { - "type": "integer", - "description": "(auto-generated)", - "format": "int32" - }, - "name": { - "type": "string", - "description": "name of the Webhook", - "format": "string" - }, - "description": { - "type": "string", - "format": "string" - }, - "url": { - "type": "string", - "description": "url which the server will make a request to when an event occurs", - "required": true, - "format": "string" - }, - "eventType": { - "type": "string", - "description": "type of event - if this event occurs, then the \"url\" will be requested by the TAPICC server", - "enum": [ - "taskCreated", - "taskUpdated", - "taskDeleted", - "jobCreated", - "jobUpdated", - "jobDeleted", - "assetCreated", - "assetUpdated", - "assetDeleted" - ], - "required": true, - "format": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "eventType", - "url" - ] - } - }, - "paths": { - "/job/{id}": { - "get": { - "summary": "Get a Job", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "Get a Job" - }, - "put": { - "summary": "Update a Job", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/job" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "Update a Job" - }, - "delete": { - "summary": "Delete a Job", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "Delete a Job" - } - }, - "/job/{parentid}/asset/{id}": { - "get": { - "summary": "Get an Asset", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Get an Asset which belongs to a specific job" - }, - "put": { - "summary": "Update an Asset", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "schema": null - }, - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string", - "schema": null - }, - { - "name": "asset", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/asset" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Update an Asset which belongs to a specific job" - }, - "delete": { - "summary": "Delete an Asset", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Delete an Asset which belongs to a specific job" - } - }, - "/asset/{parentid}/task/{id}": { - "get": { - "summary": "Get a Task", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Gets a Task which belongs to a specific job" - }, - "put": { - "summary": "Update a Task", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "task", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/task" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Updates a Task which belongs to a specific job" - }, - "delete": { - "summary": "Delete a Task", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Deletes a Task which belongs to a specific job" - } - }, - "/webhook/{id}": { - "get": { - "summary": "Get a Webhook", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/webhook" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Webhook" - ], - "description": "Get a Webhook" - }, - "put": { - "summary": "Update a Webhook", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "webhook", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/webhook" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/webhook" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Webhook" - ], - "description": "Update a Webhook" - }, - "delete": { - "summary": "Delete a Webhook", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/webhook" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Webhook" - ], - "description": "Delete a Webhook" - } - }, - "/swagger/doc": { - "get": { - "summary": "Read Object(s)", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource" - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Swagger" - ] - }, - "post": { - "summary": "Create Object(s)", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource" - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Swagger" - ] - }, - "put": { - "summary": "Update Object(s)", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource" - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Swagger" - ] - }, - "patch": { - "summary": "Update Object(s)", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource" - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Swagger" - ] - }, - "delete": { - "summary": "Destroy Object(s)", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource" - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Swagger" - ] - } - }, - "/job": { - "get": { - "summary": "List all Jobs", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "List all Jobs" - }, - "post": { - "summary": "Create a Job", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/job" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "Create a Job", - "schema": { - "$ref": "#/definitions/job" - } - } - }, - "/job/{parentid}/asset": { - "get": { - "summary": "List all Assets", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "List all Assets which belongs to a specific job" - }, - "post": { - "summary": "Create an Assets", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "asset", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/asset" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Create an Assets which will belong to a specific job" - } - }, - "/asset/{parentid}/task": { - "get": { - "summary": "List all Task", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Lists all Task which belong to a specific job" - }, - "post": { - "summary": "Create a Task", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "task", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/task" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Creates a Task which will belong to a specific job." - } - }, - "/job/{parentid}/asset/{id}/downloadfile": { - "get": { - "summary": "Download an asset file", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The asset file", - "schema": { - "$ref": "#/definitions/asset", - "type": "file" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Download an asset file" - } - }, - "/asset/{parentid}/task/{id}/downloaddeliverable": { - "get": { - "summary": "Download deliverable file", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The deliverable file", - "schema": { - "$ref": "#/definitions/task", - "type": "file" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Download deliverable file" - } - }, - "/task": { - "get": { - "summary": "List all Tasks", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task" - ], - "description": "List all Tasks" - } - }, - "/asset": { - "get": { - "summary": "List all Assets", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset" - ], - "description": "List all Assets" - } - }, - "/webhook": { - "get": { - "summary": "List all Webhooks", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/webhook" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Webhook" - ], - "description": "List all Webhooks" - }, - "post": { - "summary": "Create a Webhook", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "webhook", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/webhook" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/webhook" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Webhook" - ], - "description": "Create a Webhook" - } - }, - "/job/{id}/submit": { - "post": { - "summary": "Submit a Job", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/job" - } - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/job" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Job" - ], - "description": "Submit a Job, optionally with assets and tasks" - } - }, - "/job/{parentid}/asset/uploadfile": { - "post": { - "summary": "Upload an asset file and create an asset", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string", - "schema": null - }, - { - "name": "sourceLanguage", - "in": "formData", - "required": true, - "schema": null, - "type": "string" - }, - { - "name": "encoding", - "in": "formData", - "type": "string", - "schema": null - }, - { - "name": "asset", - "in": "formData", - "description": "The Asset file", - "required": true, - "type": "file", - "schema": null - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/asset" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Asset", - "Job" - ], - "description": "Upload an asset file and create an asset" - } - }, - "/asset/{parentid}/task/{id}/uploaddeliverable": { - "post": { - "summary": "Upload deliverable file", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "parentid", - "in": "path", - "required": true, - "type": "string", - "schema": null - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "schema": null - }, - { - "name": "deliverable", - "in": "formData", - "required": true, - "schema": null, - "description": "The deliverable file", - "type": "file" - } - ], - "responses": { - "200": { - "description": "The requested resource", - "schema": { - "$ref": "#/definitions/task" - } - }, - "404": { - "description": "Resource not found" - }, - "500": { - "description": "Internal server error" - } - }, - "tags": [ - "Task", - "Asset" - ], - "description": "Upload deliverable file" - } - } - } -} \ No newline at end of file