Skip to content

Commit

Permalink
generate new swagger file
Browse files Browse the repository at this point in the history
  • Loading branch information
Alino committed Jul 25, 2018
1 parent 2dfdb33 commit f3fa53a
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 5 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "tapicc-api",
"private": true,
"version": "0.0.1",
"version": "0.0.2",
"description": "a Sails application",
"keywords": [],
"dependencies": {
Expand Down
59 changes: 55 additions & 4 deletions swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "tapicc-api",
"description": "a Sails application",
"version": "0.0.1",
"version": "0.0.2",
"contact": {
"name": "alino"
},
Expand Down Expand Up @@ -41,17 +41,21 @@
},
"file": {
"type": "string",
"description": "an actual file (asset)",
"format": "binary"
},
"isReference": {
"type": "boolean"
"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": {
Expand All @@ -75,6 +79,8 @@
},
"name": {
"type": "string",
"description": "name of a Job",
"required": true,
"format": "string"
},
"description": {
Expand All @@ -83,20 +89,29 @@
},
"submitDate": {
"type": "string",
"description": "a date when the Job was submit",
"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": "integer",
"description": "id of the user who did submit the Job",
"format": "int32"
},
"externalId": {
"type": "string",
"description": "external project id, as is defined on the external system",
"format": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
Expand All @@ -105,7 +120,10 @@
"type": "string",
"format": "date-time"
}
}
},
"required": [
"name"
]
},
"task": {
"properties": {
Expand All @@ -115,10 +133,17 @@
},
"type": {
"type": "string",
"enum": [
"translation",
"machine translation",
"modification",
"proof"
],
"format": "string"
},
"targetLanguage": {
"type": "string",
"description": "language code of the target",
"format": "string"
},
"assetId": {
Expand All @@ -127,14 +152,23 @@
},
"progress": {
"type": "string",
"enum": [
"pending",
"in progress",
"paused",
"canceled",
"finished"
],
"format": "string"
},
"assignedTo": {
"type": "integer",
"description": "id of the user who it is assigned to",
"format": "int32"
},
"file": {
"type": "string",
"description": "an actual file (deliverable)",
"format": "binary"
},
"jobId": {
Expand Down Expand Up @@ -174,6 +208,7 @@
},
"name": {
"type": "string",
"description": "name of the Webhook",
"format": "string"
},
"description": {
Expand All @@ -182,10 +217,23 @@
},
"url": {
"type": "string",
"description": "url which the server will make a request to when an event occurs",
"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"
],
"format": "string"
},
"createdAt": {
Expand Down Expand Up @@ -1002,7 +1050,10 @@
"tags": [
"Job"
],
"description": "Create a Job"
"description": "Create a Job",
"schema": {
"$ref": "#/definitions/job"
}
}
},
"/job/{parentid}/asset": {
Expand Down

1 comment on commit f3fa53a

@Alino
Copy link
Member Author

@Alino Alino commented on f3fa53a Jul 25, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

closes #21

Please sign in to comment.