updating api after rebuild
This commit is contained in:
416
api/about/documentation/1.0.0/about.json
Normal file
416
api/about/documentation/1.0.0/about.json
Normal file
@@ -0,0 +1,416 @@
|
||||
{
|
||||
"paths": {
|
||||
"/about": {
|
||||
"get": {
|
||||
"deprecated": false,
|
||||
"description": "Find all the about's records",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retrieve about document(s)",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/About"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "",
|
||||
"tags": [
|
||||
"About"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "_limit",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Maximum number of results possible",
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_sort",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Sort according to a specific field.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_start",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Skip a specific number of entries (especially useful for pagination)",
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "=",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get entries that matches exactly your input",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_ne",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that are not equals to something",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_lt",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get record that are lower than a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_lte",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that are lower than or equal to a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_gt",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that are greater than a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_gte",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that are greater than or equal a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_contains",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that contains a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_containss",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that contains (case sensitive) a value",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_in",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that matches any value in the array of values",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"name": "_nin",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "Get records that doesn't match any value in the array of values",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"put": {
|
||||
"deprecated": false,
|
||||
"description": "Update a single about record",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retrieve about document(s)",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/About"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "",
|
||||
"tags": [
|
||||
"About"
|
||||
],
|
||||
"requestBody": {
|
||||
"description": "",
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/NewAbout"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": []
|
||||
},
|
||||
"delete": {
|
||||
"deprecated": false,
|
||||
"description": "Delete a single about record",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "deletes a single about based on the ID supplied",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "",
|
||||
"tags": [
|
||||
"About"
|
||||
],
|
||||
"parameters": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"About": {
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"Content": {
|
||||
"type": "string"
|
||||
},
|
||||
"Title": {
|
||||
"type": "string"
|
||||
},
|
||||
"Video": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"hash",
|
||||
"mime",
|
||||
"size",
|
||||
"url",
|
||||
"provider"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"alternativeText": {
|
||||
"type": "string"
|
||||
},
|
||||
"caption": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"formats": {
|
||||
"type": "object"
|
||||
},
|
||||
"hash": {
|
||||
"type": "string"
|
||||
},
|
||||
"ext": {
|
||||
"type": "string"
|
||||
},
|
||||
"mime": {
|
||||
"type": "string"
|
||||
},
|
||||
"size": {
|
||||
"type": "number"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"previewUrl": {
|
||||
"type": "string"
|
||||
},
|
||||
"provider": {
|
||||
"type": "string"
|
||||
},
|
||||
"provider_metadata": {
|
||||
"type": "object"
|
||||
},
|
||||
"related": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Optionextra": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"NewAbout": {
|
||||
"properties": {
|
||||
"Content": {
|
||||
"type": "string"
|
||||
},
|
||||
"Title": {
|
||||
"type": "string"
|
||||
},
|
||||
"Optionextra": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
{
|
||||
"name": "About"
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user