3949 lines
99 KiB
JSON
3949 lines
99 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"version": "1.0.0",
|
|
"title": "DOCUMENTATION",
|
|
"description": "",
|
|
"termsOfService": "YOUR_TERMS_OF_SERVICE_URL",
|
|
"contact": {
|
|
"name": "TEAM",
|
|
"email": "contact-email@something.io",
|
|
"url": "mywebsite.io"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
|
|
},
|
|
"x-generation-date": "04/26/2020 9:40:09 PM"
|
|
},
|
|
"x-strapi-config": {
|
|
"path": "/documentation",
|
|
"showGeneratedFiles": true,
|
|
"generateDefaultResponse": true
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "http://localhost:1337",
|
|
"description": "Development server"
|
|
},
|
|
{
|
|
"url": "YOUR_STAGING_SERVER",
|
|
"description": "Staging server"
|
|
},
|
|
{
|
|
"url": "http://strapi-prod.eu-west-1.elasticbeanstalk.com",
|
|
"description": "Production server"
|
|
}
|
|
],
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://strapi.io/documentation/3.0.0-beta.x/"
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"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": []
|
|
}
|
|
},
|
|
"/homepage": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Find all the homepage's records",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieve homepage document(s)",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Homepage"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Homepage"
|
|
],
|
|
"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 homepage record",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieve homepage document(s)",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Homepage"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Homepage"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewHomepage"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": []
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete a single homepage record",
|
|
"responses": {
|
|
"200": {
|
|
"description": "deletes a single homepage 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": [
|
|
"Homepage"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/tests": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Test"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Test"
|
|
],
|
|
"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
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Create a new record",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Test"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Test"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewTest"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tests/count": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Test"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/tests/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Test"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Test"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"deprecated": false,
|
|
"description": "Update a record",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Test"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Test"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewTest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete a record",
|
|
"responses": {
|
|
"200": {
|
|
"description": "deletes a single record 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": [
|
|
"Test"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/email/": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Send an email",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Email - Email"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/upload/": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Upload a file",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/upload/files/count": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve the total number of uploaded files",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/upload/files": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve all file documents",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/upload/files/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve a single file depending on its id",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete an uploaded file",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/upload/search/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Search for an uploaded file",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"Upload - File"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users-permissions/init": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Check if the first admin user has already been registered",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/users-permissions/roles/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve a role depending on its id",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users-permissions/roles": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve all role documents",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/UsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"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
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Create a new role",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users-permissions/roles/{role}": {
|
|
"put": {
|
|
"deprecated": false,
|
|
"description": "Update a role",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "role",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsersPermissionsRole"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete a role",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - Role"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "role",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users-permissions/search/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Search for users",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/connect/*": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Connect a provider",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/auth/local": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Login a user using the identifiers email and password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/local/register": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Register a new user with the default role",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/{provider}/callback": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Successfull redirection after approving a provider",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "provider",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/auth/forgot-password": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Send the reset password email link",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/reset-password": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Change a user's password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/email-confirmation": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Validate a user account",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/auth/send-email-confirmation": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Send a confirmation email to user",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve all user documents",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users/me": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve the logged in user information",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/users/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve a single user depending on his id",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"deprecated": false,
|
|
"description": "Update an existing user",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsersPermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete an existing user",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": [
|
|
"UsersPermissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"Homepage": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"Content": {
|
|
"type": "string"
|
|
},
|
|
"Title": {
|
|
"type": "string"
|
|
},
|
|
"Banner1": {
|
|
"type": "string"
|
|
},
|
|
"Banner2": {
|
|
"type": "string"
|
|
},
|
|
"Image1": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Image2": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Image3": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"NewHomepage": {
|
|
"properties": {
|
|
"Content": {
|
|
"type": "string"
|
|
},
|
|
"Title": {
|
|
"type": "string"
|
|
},
|
|
"Banner1": {
|
|
"type": "string"
|
|
},
|
|
"Banner2": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Test": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"NewTest": {
|
|
"properties": {
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"UsersPermissionsRole": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"controller",
|
|
"action",
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"controller": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"policy": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"users": {
|
|
"type": "array",
|
|
"items": {
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"resetPasswordToken": {
|
|
"type": "string"
|
|
},
|
|
"confirmed": {
|
|
"type": "boolean"
|
|
},
|
|
"blocked": {
|
|
"type": "boolean"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"NewUsersPermissionsRole": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"users": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UsersPermissionsUser": {
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
},
|
|
"confirmed": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"blocked": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"role": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"users": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"NewUsersPermissionsUser": {
|
|
"required": [
|
|
"username",
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"resetPasswordToken": {
|
|
"type": "string"
|
|
},
|
|
"confirmed": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"blocked": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Error": {
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"bearerAuth": {
|
|
"type": "http",
|
|
"scheme": "bearer",
|
|
"bearerFormat": "JWT"
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "About"
|
|
},
|
|
{
|
|
"name": "Homepage"
|
|
},
|
|
{
|
|
"name": "Test"
|
|
},
|
|
{
|
|
"name": "Email - Email"
|
|
},
|
|
{
|
|
"name": "Upload - File"
|
|
},
|
|
{
|
|
"name": "UsersPermissions - Role"
|
|
},
|
|
{
|
|
"name": "UsersPermissions - User"
|
|
}
|
|
]
|
|
}
|