resourcejs
Version:
A simple Express library to reflect Mongoose models to a REST interface.
256 lines (255 loc) • 6.74 kB
JSON
{
"definitions": {
"skip": {
"title": "skip",
"properties": {
"title": {
"type": "string"
},
"_id": {
"type": "string",
"description": "ObjectId"
}
}
}
},
"paths": {
"/test/skip": {
"get": {
"tags": [
"skip"
],
"summary": "List multiple skip resources.",
"description": "This operation allows you to list and search for skip resources provided query arguments.",
"operationId": "getskips",
"responses": {
"200": {
"description": "Resource(s) found. Returned as array.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/skip"
}
}
},
"401": {
"description": "Unauthorized."
}
},
"parameters": [
{
"name": "skip",
"in": "query",
"description": "How many records to skip when listing. Used for pagination.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "limit",
"in": "query",
"description": "How many records to limit the output.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "sort",
"in": "query",
"description": "Which fields to sort the records on.",
"type": "string",
"required": false,
"default": ""
},
{
"name": "select",
"in": "query",
"description": "Select which fields will be returned by the query.",
"type": "string",
"required": false,
"default": ""
},
{
"name": "populate",
"in": "query",
"description": "Select which fields will be fully populated with the reference.",
"type": "string",
"required": false,
"default": ""
}
]
},
"post": {
"tags": [
"skip"
],
"summary": "Create a new skip",
"description": "Create a new skip",
"operationId": "createskip",
"responses": {
"201": {
"description": "The resource has been created."
},
"400": {
"description": "An error has occured trying to create the resource."
},
"401": {
"description": "Unauthorized. Note that anonymous submissions are *enabled* by default."
}
},
"parameters": [
{
"in": "body",
"name": "body",
"description": "Data used to create a new skip",
"required": true,
"schema": {
"$ref": "#/definitions/skip"
}
}
]
}
},
"/test/skip/{skipId}": {
"get": {
"tags": [
"skip"
],
"summary": "Return a specific skip instance.",
"description": "Return a specific skip instance.",
"operationId": "getskip",
"responses": {
"200": {
"description": "Resource found",
"schema": {
"$ref": "#/definitions/skip"
}
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Resource not found"
},
"500": {
"description": "An error has occurred."
}
},
"parameters": [
{
"name": "skipId",
"in": "path",
"description": "The ID of the skip that will be retrieved.",
"required": true,
"type": "string"
}
]
},
"put": {
"tags": [
"skip"
],
"summary": "Update a specific skip instance.",
"description": "Update a specific skip instance.",
"operationId": "updateskip",
"responses": {
"200": {
"description": "Resource updated",
"schema": {
"$ref": "#/definitions/skip"
}
},
"400": {
"description": "Resource could not be updated."
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Resource not found"
},
"500": {
"description": "An error has occurred."
}
},
"parameters": [
{
"name": "skipId",
"in": "path",
"description": "The ID of the skip that will be updated.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "Data used to update skip",
"required": true,
"schema": {
"$ref": "#/definitions/skip"
}
}
]
},
"delete": {
"tags": [
"skip"
],
"summary": "Delete a specific skip",
"description": "Delete a specific skip",
"operationId": "deleteskip",
"responses": {
"204": {
"description": "Resource was deleted"
},
"400": {
"description": "Resource could not be deleted."
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Resource not found"
},
"500": {
"description": "An error has occurred."
}
},
"parameters": [
{
"name": "skipId",
"in": "path",
"description": "The ID of the skip that will be deleted.",
"required": true,
"type": "string"
}
]
}
},
"/test/skip/virtual/resource": {
"get": {
"tags": [
"skip",
"virtual"
],
"summary": "Virtual resource for skip named resource",
"description": "get skip resource",
"operationId": "get skip resource",
"responses": {
"200": {
"description": "Resource found"
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Resource not found"
},
"500": {
"description": "An error has occurred."
}
}
}
}
}
}