diff --git a/src/api/resource/content-types/resource/schema.json b/src/api/resource/content-types/resource/schema.json new file mode 100644 index 0000000..274e627 --- /dev/null +++ b/src/api/resource/content-types/resource/schema.json @@ -0,0 +1,64 @@ +{ + "kind": "collectionType", + "collectionName": "resources", + "info": { + "singularName": "resource", + "pluralName": "resources", + "displayName": "Resource", + "description": "Create programmatic or batch article content" + }, + "options": { + "draftAndPublish": true + }, + "pluginOptions": {}, + "attributes": { + "title": { + "type": "string", + "required": true + }, + "description": { + "type": "text", + "maxLength": 256, + "required": true + }, + "slug": { + "type": "uid", + "targetField": "title", + "required": true + }, + "campaign": { + "type": "string", + "required": true, + "regex": "^[a-z0-9]+(?:-[a-z0-9]+)*$" + }, + "cover": { + "type": "media", + "multiple": false, + "required": false, + "allowedTypes": ["images", "files", "videos"] + }, + "blocks": { + "type": "dynamiczone", + "components": [ + "shared.media", + "shared.quote", + "shared.rich-text", + "shared.slider", + "shared.video-embed" + ] + }, + "seo": { + "type": "component", + "repeatable": false, + "component": "shared.seo" + }, + "publishDate": { + "type": "datetime" + }, + "publishDateVisible": { + "type": "boolean", + "default": true, + "required": true + } + } +} diff --git a/src/api/resource/controllers/resource.ts b/src/api/resource/controllers/resource.ts new file mode 100644 index 0000000..dccc8c3 --- /dev/null +++ b/src/api/resource/controllers/resource.ts @@ -0,0 +1,9 @@ +"use strict"; + +/** + * resource controller + */ + +import { factories } from "@strapi/strapi"; + +export default factories.createCoreController("api::resource.resource"); diff --git a/src/api/resource/documentation/1.0.0/resource.json b/src/api/resource/documentation/1.0.0/resource.json new file mode 100644 index 0000000..50e748f --- /dev/null +++ b/src/api/resource/documentation/1.0.0/resource.json @@ -0,0 +1,508 @@ +{ + "/resources": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceListResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Resource" + ], + "parameters": [ + { + "name": "sort", + "in": "query", + "description": "Sort by attributes ascending (asc) or descending (desc)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "pagination[withCount]", + "in": "query", + "description": "Return page/pageSize (default: true)", + "deprecated": false, + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pagination[page]", + "in": "query", + "description": "Page number (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[pageSize]", + "in": "query", + "description": "Page size (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[start]", + "in": "query", + "description": "Offset value (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[limit]", + "in": "query", + "description": "Number of entities to return (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "in": "query", + "description": "Fields to return (ex: title,author)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "populate", + "in": "query", + "description": "Relations to return", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "filters", + "in": "query", + "description": "Filters to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "object", + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "get/resources" + }, + "post": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Resource" + ], + "parameters": [], + "operationId": "post/resources", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceRequest" + } + } + } + } + } + }, + "/resources/{id}": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Resource" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "get/resources/{id}" + }, + "put": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Resource" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "put/resources/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceRequest" + } + } + } + } + }, + "delete": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Resource" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/resources/{id}" + } + } +} diff --git a/src/api/resource/routes/resource.ts b/src/api/resource/routes/resource.ts new file mode 100644 index 0000000..39324f7 --- /dev/null +++ b/src/api/resource/routes/resource.ts @@ -0,0 +1,9 @@ +"use strict"; + +/** + * resource router + */ + +import { factories } from "@strapi/strapi"; + +export default factories.createCoreRouter("api::resource.resource"); diff --git a/src/api/resource/services/resource.ts b/src/api/resource/services/resource.ts new file mode 100644 index 0000000..5084a59 --- /dev/null +++ b/src/api/resource/services/resource.ts @@ -0,0 +1,9 @@ +"use strict"; + +/** + * resource service + */ + +import { factories } from "@strapi/strapi"; + +export default factories.createCoreService("api::resource.resource"); diff --git a/src/extensions/documentation/documentation/1.0.0/full_documentation.json b/src/extensions/documentation/documentation/1.0.0/full_documentation.json index da00a26..19b14e2 100644 --- a/src/extensions/documentation/documentation/1.0.0/full_documentation.json +++ b/src/extensions/documentation/documentation/1.0.0/full_documentation.json @@ -29473,52 +29473,1461 @@ } } } + }, + "ResourceRequest": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "required": [ + "description", + "featured", + "publishDateVisible" + ], + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "cover": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "example": "string or id" + }, + "categories": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "example": "string or id" + } + }, + "blocks": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SharedMediaComponent" + }, + { + "$ref": "#/components/schemas/SharedQuoteComponent" + }, + { + "$ref": "#/components/schemas/SharedRichTextComponent" + }, + { + "$ref": "#/components/schemas/SharedSliderComponent" + }, + { + "$ref": "#/components/schemas/SharedVideoEmbedComponent" + } + ] + } + }, + "authorsBio": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "example": "string or id" + }, + "seo": { + "$ref": "#/components/schemas/SharedSeoComponent" + }, + "tags": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "example": "string or id" + } + }, + "featured": { + "type": "boolean" + }, + "publishDate": { + "type": "string", + "format": "date-time" + }, + "publishDateVisible": { + "type": "boolean" + } + } + } + } + }, + "ResourceListResponseDataItem": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "$ref": "#/components/schemas/Resource" + } + } + }, + "ResourceListResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResourceListResponseDataItem" + } + }, + "meta": { + "type": "object", + "properties": { + "pagination": { + "type": "object", + "properties": { + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer", + "minimum": 25 + }, + "pageCount": { + "type": "integer", + "maximum": 1 + }, + "total": { + "type": "integer" + } + } + } + } + } + } + }, + "Resource": { + "type": "object", + "required": [ + "description", + "campaign", + "publishDateVisible" + ], + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "cover": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "alternativeText": { + "type": "string" + }, + "caption": { + "type": "string" + }, + "width": { + "type": "integer" + }, + "height": { + "type": "integer" + }, + "formats": {}, + "hash": { + "type": "string" + }, + "ext": { + "type": "string" + }, + "mime": { + "type": "string" + }, + "size": { + "type": "number", + "format": "float" + }, + "url": { + "type": "string" + }, + "previewUrl": { + "type": "string" + }, + "provider": { + "type": "string" + }, + "provider_metadata": {}, + "related": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "folder": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "pathId": { + "type": "integer" + }, + "parent": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "children": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "files": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "alternativeText": { + "type": "string" + }, + "caption": { + "type": "string" + }, + "width": { + "type": "integer" + }, + "height": { + "type": "integer" + }, + "formats": {}, + "hash": { + "type": "string" + }, + "ext": { + "type": "string" + }, + "mime": { + "type": "string" + }, + "size": { + "type": "number", + "format": "float" + }, + "url": { + "type": "string" + }, + "previewUrl": { + "type": "string" + }, + "provider": { + "type": "string" + }, + "provider_metadata": {}, + "related": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "folder": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "folderPath": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "firstname": { + "type": "string" + }, + "lastname": { + "type": "string" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "resetPasswordToken": { + "type": "string" + }, + "registrationToken": { + "type": "string" + }, + "isActive": { + "type": "boolean" + }, + "roles": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "code": { + "type": "string" + }, + "description": { + "type": "string" + }, + "users": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "permissions": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "actionParameters": {}, + "subject": { + "type": "string" + }, + "properties": {}, + "conditions": {}, + "role": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + } + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + } + }, + "blocked": { + "type": "boolean" + }, + "preferedLanguage": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + } + }, + "path": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + }, + "folderPath": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + } + } + } + } + } + } + }, + "blocks": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SharedMediaComponent" + }, + { + "$ref": "#/components/schemas/SharedQuoteComponent" + }, + { + "$ref": "#/components/schemas/SharedRichTextComponent" + }, + { + "$ref": "#/components/schemas/SharedSliderComponent" + }, + { + "$ref": "#/components/schemas/SharedVideoEmbedComponent" + } + ] + } + }, + "seo": { + "$ref": "#/components/schemas/SharedSeoComponent" + }, + "publishDate": { + "type": "string", + "format": "date-time" + }, + "publishDateVisible": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "publishedAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "updatedBy": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "type": "object", + "properties": {} + } + } + } + } + }, + "campaign": { + "type": "string", + "description": "URL segment grouping programmatic content (e.g. tokens, eips)" + } + } + }, + "ResourceResponseDataObject": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "attributes": { + "$ref": "#/components/schemas/Resource" + } + } + }, + "ResourceResponse": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ResourceResponseDataObject" + }, + "meta": { + "type": "object" + } + } + } + }, + "requestBodies": { + "Users-Permissions-RoleRequest": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "permissions": { + "$ref": "#/components/schemas/Users-Permissions-PermissionsTree" + } + } + }, + "example": { + "name": "foo", + "description": "role foo", + "permissions": { + "api::content-type.content-type": { + "controllers": { + "controllerA": { + "find": { + "enabled": true + } + } + } + } + } + } + } + } + } + } + }, + "paths": { + "/affiliates": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateListResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Affiliate" + ], + "parameters": [ + { + "name": "sort", + "in": "query", + "description": "Sort by attributes ascending (asc) or descending (desc)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "pagination[withCount]", + "in": "query", + "description": "Return page/pageSize (default: true)", + "deprecated": false, + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pagination[page]", + "in": "query", + "description": "Page number (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[pageSize]", + "in": "query", + "description": "Page size (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[start]", + "in": "query", + "description": "Offset value (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[limit]", + "in": "query", + "description": "Number of entities to return (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "in": "query", + "description": "Fields to return (ex: title,author)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "populate", + "in": "query", + "description": "Relations to return", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "filters", + "in": "query", + "description": "Filters to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "object", + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "get/affiliates" + }, + "post": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Affiliate" + ], + "parameters": [], + "operationId": "post/affiliates", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateRequest" + } + } + } + } } }, - "requestBodies": { - "Users-Permissions-RoleRequest": { - "required": true, - "content": { - "application/json": { + "/affiliates/{id}": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Affiliate" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "type": "string" - }, - "permissions": { - "$ref": "#/components/schemas/Users-Permissions-PermissionsTree" + "type": "number" + } + } + ], + "operationId": "get/affiliates/{id}" + }, + "put": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Affiliate" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "put/affiliates/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AffiliateRequest" + } + } + } + } + }, + "delete": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" } } - }, - "example": { - "name": "foo", - "description": "role foo", - "permissions": { - "api::content-type.content-type": { - "controllers": { - "controllerA": { - "find": { - "enabled": true - } - } - } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" } } } } - } + }, + "tags": [ + "Affiliate" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/affiliates/{id}" } - } - }, - "paths": { - "/affiliates": { + }, + "/announcements": { "get": { "responses": { "200": { @@ -29526,7 +30935,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateListResponse" + "$ref": "#/components/schemas/AnnouncementListResponse" } } } @@ -29583,7 +30992,7 @@ } }, "tags": [ - "Affiliate" + "Announcement" ], "parameters": [ { @@ -29689,7 +31098,7 @@ } } ], - "operationId": "get/affiliates" + "operationId": "get/announcements" }, "post": { "responses": { @@ -29698,7 +31107,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateResponse" + "$ref": "#/components/schemas/AnnouncementResponse" } } } @@ -29755,23 +31164,23 @@ } }, "tags": [ - "Affiliate" + "Announcement" ], "parameters": [], - "operationId": "post/affiliates", + "operationId": "post/announcements", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateRequest" + "$ref": "#/components/schemas/AnnouncementRequest" } } } } } }, - "/affiliates/{id}": { + "/announcements/{id}": { "get": { "responses": { "200": { @@ -29779,7 +31188,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateResponse" + "$ref": "#/components/schemas/AnnouncementResponse" } } } @@ -29836,7 +31245,7 @@ } }, "tags": [ - "Affiliate" + "Announcement" ], "parameters": [ { @@ -29850,7 +31259,7 @@ } } ], - "operationId": "get/affiliates/{id}" + "operationId": "get/announcements/{id}" }, "put": { "responses": { @@ -29859,7 +31268,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateResponse" + "$ref": "#/components/schemas/AnnouncementResponse" } } } @@ -29916,7 +31325,7 @@ } }, "tags": [ - "Affiliate" + "Announcement" ], "parameters": [ { @@ -29930,13 +31339,13 @@ } } ], - "operationId": "put/affiliates/{id}", + "operationId": "put/announcements/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AffiliateRequest" + "$ref": "#/components/schemas/AnnouncementRequest" } } } @@ -30007,7 +31416,7 @@ } }, "tags": [ - "Affiliate" + "Announcement" ], "parameters": [ { @@ -30021,10 +31430,10 @@ } } ], - "operationId": "delete/affiliates/{id}" + "operationId": "delete/announcements/{id}" } }, - "/announcements": { + "/articles": { "get": { "responses": { "200": { @@ -30032,7 +31441,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementListResponse" + "$ref": "#/components/schemas/ArticleListResponse" } } } @@ -30089,7 +31498,7 @@ } }, "tags": [ - "Announcement" + "Article" ], "parameters": [ { @@ -30195,7 +31604,7 @@ } } ], - "operationId": "get/announcements" + "operationId": "get/articles" }, "post": { "responses": { @@ -30204,7 +31613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementResponse" + "$ref": "#/components/schemas/ArticleResponse" } } } @@ -30261,23 +31670,23 @@ } }, "tags": [ - "Announcement" + "Article" ], "parameters": [], - "operationId": "post/announcements", + "operationId": "post/articles", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementRequest" + "$ref": "#/components/schemas/ArticleRequest" } } } } } }, - "/announcements/{id}": { + "/articles/{id}": { "get": { "responses": { "200": { @@ -30285,7 +31694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementResponse" + "$ref": "#/components/schemas/ArticleResponse" } } } @@ -30342,7 +31751,7 @@ } }, "tags": [ - "Announcement" + "Article" ], "parameters": [ { @@ -30356,7 +31765,7 @@ } } ], - "operationId": "get/announcements/{id}" + "operationId": "get/articles/{id}" }, "put": { "responses": { @@ -30365,7 +31774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementResponse" + "$ref": "#/components/schemas/ArticleResponse" } } } @@ -30422,7 +31831,7 @@ } }, "tags": [ - "Announcement" + "Article" ], "parameters": [ { @@ -30436,13 +31845,13 @@ } } ], - "operationId": "put/announcements/{id}", + "operationId": "put/articles/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnnouncementRequest" + "$ref": "#/components/schemas/ArticleRequest" } } } @@ -30513,7 +31922,7 @@ } }, "tags": [ - "Announcement" + "Article" ], "parameters": [ { @@ -30527,10 +31936,10 @@ } } ], - "operationId": "delete/announcements/{id}" + "operationId": "delete/articles/{id}" } }, - "/articles": { + "/authors": { "get": { "responses": { "200": { @@ -30538,7 +31947,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleListResponse" + "$ref": "#/components/schemas/AuthorListResponse" } } } @@ -30595,7 +32004,7 @@ } }, "tags": [ - "Article" + "Author" ], "parameters": [ { @@ -30701,7 +32110,7 @@ } } ], - "operationId": "get/articles" + "operationId": "get/authors" }, "post": { "responses": { @@ -30710,7 +32119,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleResponse" + "$ref": "#/components/schemas/AuthorResponse" } } } @@ -30767,23 +32176,23 @@ } }, "tags": [ - "Article" + "Author" ], "parameters": [], - "operationId": "post/articles", + "operationId": "post/authors", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleRequest" + "$ref": "#/components/schemas/AuthorRequest" } } } } } }, - "/articles/{id}": { + "/authors/{id}": { "get": { "responses": { "200": { @@ -30791,7 +32200,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleResponse" + "$ref": "#/components/schemas/AuthorResponse" } } } @@ -30848,7 +32257,7 @@ } }, "tags": [ - "Article" + "Author" ], "parameters": [ { @@ -30862,7 +32271,7 @@ } } ], - "operationId": "get/articles/{id}" + "operationId": "get/authors/{id}" }, "put": { "responses": { @@ -30871,7 +32280,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleResponse" + "$ref": "#/components/schemas/AuthorResponse" } } } @@ -30928,7 +32337,7 @@ } }, "tags": [ - "Article" + "Author" ], "parameters": [ { @@ -30942,13 +32351,13 @@ } } ], - "operationId": "put/articles/{id}", + "operationId": "put/authors/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ArticleRequest" + "$ref": "#/components/schemas/AuthorRequest" } } } @@ -31019,7 +32428,7 @@ } }, "tags": [ - "Article" + "Author" ], "parameters": [ { @@ -31033,10 +32442,10 @@ } } ], - "operationId": "delete/articles/{id}" + "operationId": "delete/authors/{id}" } }, - "/authors": { + "/bonding-pools": { "get": { "responses": { "200": { @@ -31044,7 +32453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorListResponse" + "$ref": "#/components/schemas/BondingPoolListResponse" } } } @@ -31101,7 +32510,7 @@ } }, "tags": [ - "Author" + "Bonding-pool" ], "parameters": [ { @@ -31207,7 +32616,7 @@ } } ], - "operationId": "get/authors" + "operationId": "get/bonding-pools" }, "post": { "responses": { @@ -31216,7 +32625,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorResponse" + "$ref": "#/components/schemas/BondingPoolResponse" } } } @@ -31273,23 +32682,23 @@ } }, "tags": [ - "Author" + "Bonding-pool" ], "parameters": [], - "operationId": "post/authors", + "operationId": "post/bonding-pools", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorRequest" + "$ref": "#/components/schemas/BondingPoolRequest" } } } } } }, - "/authors/{id}": { + "/bonding-pools/{id}": { "get": { "responses": { "200": { @@ -31297,7 +32706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorResponse" + "$ref": "#/components/schemas/BondingPoolResponse" } } } @@ -31354,7 +32763,7 @@ } }, "tags": [ - "Author" + "Bonding-pool" ], "parameters": [ { @@ -31368,7 +32777,7 @@ } } ], - "operationId": "get/authors/{id}" + "operationId": "get/bonding-pools/{id}" }, "put": { "responses": { @@ -31377,7 +32786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorResponse" + "$ref": "#/components/schemas/BondingPoolResponse" } } } @@ -31434,7 +32843,7 @@ } }, "tags": [ - "Author" + "Bonding-pool" ], "parameters": [ { @@ -31448,13 +32857,13 @@ } } ], - "operationId": "put/authors/{id}", + "operationId": "put/bonding-pools/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AuthorRequest" + "$ref": "#/components/schemas/BondingPoolRequest" } } } @@ -31525,7 +32934,7 @@ } }, "tags": [ - "Author" + "Bonding-pool" ], "parameters": [ { @@ -31539,10 +32948,10 @@ } } ], - "operationId": "delete/authors/{id}" + "operationId": "delete/bonding-pools/{id}" } }, - "/bonding-pools": { + "/categories": { "get": { "responses": { "200": { @@ -31550,7 +32959,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolListResponse" + "$ref": "#/components/schemas/CategoryListResponse" } } } @@ -31607,7 +33016,7 @@ } }, "tags": [ - "Bonding-pool" + "Category" ], "parameters": [ { @@ -31713,7 +33122,7 @@ } } ], - "operationId": "get/bonding-pools" + "operationId": "get/categories" }, "post": { "responses": { @@ -31722,7 +33131,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolResponse" + "$ref": "#/components/schemas/CategoryResponse" } } } @@ -31779,23 +33188,23 @@ } }, "tags": [ - "Bonding-pool" + "Category" ], "parameters": [], - "operationId": "post/bonding-pools", + "operationId": "post/categories", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolRequest" + "$ref": "#/components/schemas/CategoryRequest" } } } } } }, - "/bonding-pools/{id}": { + "/categories/{id}": { "get": { "responses": { "200": { @@ -31803,7 +33212,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolResponse" + "$ref": "#/components/schemas/CategoryResponse" } } } @@ -31860,7 +33269,7 @@ } }, "tags": [ - "Bonding-pool" + "Category" ], "parameters": [ { @@ -31874,7 +33283,7 @@ } } ], - "operationId": "get/bonding-pools/{id}" + "operationId": "get/categories/{id}" }, "put": { "responses": { @@ -31883,7 +33292,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolResponse" + "$ref": "#/components/schemas/CategoryResponse" } } } @@ -31940,7 +33349,7 @@ } }, "tags": [ - "Bonding-pool" + "Category" ], "parameters": [ { @@ -31954,13 +33363,13 @@ } } ], - "operationId": "put/bonding-pools/{id}", + "operationId": "put/categories/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BondingPoolRequest" + "$ref": "#/components/schemas/CategoryRequest" } } } @@ -32031,7 +33440,7 @@ } }, "tags": [ - "Bonding-pool" + "Category" ], "parameters": [ { @@ -32045,10 +33454,10 @@ } } ], - "operationId": "delete/bonding-pools/{id}" + "operationId": "delete/categories/{id}" } }, - "/categories": { + "/correlated-tokens": { "get": { "responses": { "200": { @@ -32056,7 +33465,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryListResponse" + "$ref": "#/components/schemas/CorrelatedTokenListResponse" } } } @@ -32113,7 +33522,7 @@ } }, "tags": [ - "Category" + "Correlated-token" ], "parameters": [ { @@ -32219,7 +33628,7 @@ } } ], - "operationId": "get/categories" + "operationId": "get/correlated-tokens" }, "post": { "responses": { @@ -32228,7 +33637,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryResponse" + "$ref": "#/components/schemas/CorrelatedTokenResponse" } } } @@ -32285,23 +33694,23 @@ } }, "tags": [ - "Category" + "Correlated-token" ], "parameters": [], - "operationId": "post/categories", + "operationId": "post/correlated-tokens", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryRequest" + "$ref": "#/components/schemas/CorrelatedTokenRequest" } } } } } }, - "/categories/{id}": { + "/correlated-tokens/{id}": { "get": { "responses": { "200": { @@ -32309,7 +33718,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryResponse" + "$ref": "#/components/schemas/CorrelatedTokenResponse" } } } @@ -32366,7 +33775,7 @@ } }, "tags": [ - "Category" + "Correlated-token" ], "parameters": [ { @@ -32380,7 +33789,7 @@ } } ], - "operationId": "get/categories/{id}" + "operationId": "get/correlated-tokens/{id}" }, "put": { "responses": { @@ -32389,7 +33798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryResponse" + "$ref": "#/components/schemas/CorrelatedTokenResponse" } } } @@ -32446,7 +33855,7 @@ } }, "tags": [ - "Category" + "Correlated-token" ], "parameters": [ { @@ -32460,13 +33869,13 @@ } } ], - "operationId": "put/categories/{id}", + "operationId": "put/correlated-tokens/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CategoryRequest" + "$ref": "#/components/schemas/CorrelatedTokenRequest" } } } @@ -32537,7 +33946,7 @@ } }, "tags": [ - "Category" + "Correlated-token" ], "parameters": [ { @@ -32551,10 +33960,10 @@ } } ], - "operationId": "delete/categories/{id}" + "operationId": "delete/correlated-tokens/{id}" } }, - "/correlated-tokens": { + "/environments": { "get": { "responses": { "200": { @@ -32562,7 +33971,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenListResponse" + "$ref": "#/components/schemas/EnvironmentListResponse" } } } @@ -32619,7 +34028,7 @@ } }, "tags": [ - "Correlated-token" + "Environment" ], "parameters": [ { @@ -32725,7 +34134,7 @@ } } ], - "operationId": "get/correlated-tokens" + "operationId": "get/environments" }, "post": { "responses": { @@ -32734,7 +34143,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenResponse" + "$ref": "#/components/schemas/EnvironmentResponse" } } } @@ -32791,23 +34200,23 @@ } }, "tags": [ - "Correlated-token" + "Environment" ], "parameters": [], - "operationId": "post/correlated-tokens", + "operationId": "post/environments", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenRequest" + "$ref": "#/components/schemas/EnvironmentRequest" } } } } } }, - "/correlated-tokens/{id}": { + "/environments/{id}": { "get": { "responses": { "200": { @@ -32815,7 +34224,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenResponse" + "$ref": "#/components/schemas/EnvironmentResponse" } } } @@ -32872,7 +34281,7 @@ } }, "tags": [ - "Correlated-token" + "Environment" ], "parameters": [ { @@ -32886,7 +34295,7 @@ } } ], - "operationId": "get/correlated-tokens/{id}" + "operationId": "get/environments/{id}" }, "put": { "responses": { @@ -32895,7 +34304,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenResponse" + "$ref": "#/components/schemas/EnvironmentResponse" } } } @@ -32952,7 +34361,7 @@ } }, "tags": [ - "Correlated-token" + "Environment" ], "parameters": [ { @@ -32966,13 +34375,13 @@ } } ], - "operationId": "put/correlated-tokens/{id}", + "operationId": "put/environments/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CorrelatedTokenRequest" + "$ref": "#/components/schemas/EnvironmentRequest" } } } @@ -33043,7 +34452,7 @@ } }, "tags": [ - "Correlated-token" + "Environment" ], "parameters": [ { @@ -33057,10 +34466,10 @@ } } ], - "operationId": "delete/correlated-tokens/{id}" + "operationId": "delete/environments/{id}" } }, - "/environments": { + "/faq-categories": { "get": { "responses": { "200": { @@ -33068,7 +34477,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentListResponse" + "$ref": "#/components/schemas/FaqCategoryListResponse" } } } @@ -33125,7 +34534,7 @@ } }, "tags": [ - "Environment" + "Faq-category" ], "parameters": [ { @@ -33231,7 +34640,7 @@ } } ], - "operationId": "get/environments" + "operationId": "get/faq-categories" }, "post": { "responses": { @@ -33240,7 +34649,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentResponse" + "$ref": "#/components/schemas/FaqCategoryResponse" } } } @@ -33297,23 +34706,23 @@ } }, "tags": [ - "Environment" + "Faq-category" ], "parameters": [], - "operationId": "post/environments", + "operationId": "post/faq-categories", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentRequest" + "$ref": "#/components/schemas/FaqCategoryRequest" } } } } } }, - "/environments/{id}": { + "/faq-categories/{id}": { "get": { "responses": { "200": { @@ -33321,7 +34730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentResponse" + "$ref": "#/components/schemas/FaqCategoryResponse" } } } @@ -33378,7 +34787,7 @@ } }, "tags": [ - "Environment" + "Faq-category" ], "parameters": [ { @@ -33392,7 +34801,7 @@ } } ], - "operationId": "get/environments/{id}" + "operationId": "get/faq-categories/{id}" }, "put": { "responses": { @@ -33401,7 +34810,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentResponse" + "$ref": "#/components/schemas/FaqCategoryResponse" } } } @@ -33458,7 +34867,7 @@ } }, "tags": [ - "Environment" + "Faq-category" ], "parameters": [ { @@ -33472,13 +34881,13 @@ } } ], - "operationId": "put/environments/{id}", + "operationId": "put/faq-categories/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EnvironmentRequest" + "$ref": "#/components/schemas/FaqCategoryRequest" } } } @@ -33549,7 +34958,7 @@ } }, "tags": [ - "Environment" + "Faq-category" ], "parameters": [ { @@ -33563,10 +34972,10 @@ } } ], - "operationId": "delete/environments/{id}" + "operationId": "delete/faq-categories/{id}" } }, - "/faq-categories": { + "/faq-questions": { "get": { "responses": { "200": { @@ -33574,7 +34983,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryListResponse" + "$ref": "#/components/schemas/FaqQuestionListResponse" } } } @@ -33631,7 +35040,7 @@ } }, "tags": [ - "Faq-category" + "Faq-question" ], "parameters": [ { @@ -33737,7 +35146,7 @@ } } ], - "operationId": "get/faq-categories" + "operationId": "get/faq-questions" }, "post": { "responses": { @@ -33746,7 +35155,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryResponse" + "$ref": "#/components/schemas/FaqQuestionResponse" } } } @@ -33803,23 +35212,23 @@ } }, "tags": [ - "Faq-category" + "Faq-question" ], "parameters": [], - "operationId": "post/faq-categories", + "operationId": "post/faq-questions", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryRequest" + "$ref": "#/components/schemas/FaqQuestionRequest" } } } } } }, - "/faq-categories/{id}": { + "/faq-questions/{id}": { "get": { "responses": { "200": { @@ -33827,7 +35236,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryResponse" + "$ref": "#/components/schemas/FaqQuestionResponse" } } } @@ -33884,7 +35293,7 @@ } }, "tags": [ - "Faq-category" + "Faq-question" ], "parameters": [ { @@ -33898,7 +35307,7 @@ } } ], - "operationId": "get/faq-categories/{id}" + "operationId": "get/faq-questions/{id}" }, "put": { "responses": { @@ -33907,7 +35316,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryResponse" + "$ref": "#/components/schemas/FaqQuestionResponse" } } } @@ -33964,7 +35373,7 @@ } }, "tags": [ - "Faq-category" + "Faq-question" ], "parameters": [ { @@ -33978,13 +35387,13 @@ } } ], - "operationId": "put/faq-categories/{id}", + "operationId": "put/faq-questions/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqCategoryRequest" + "$ref": "#/components/schemas/FaqQuestionRequest" } } } @@ -34055,7 +35464,7 @@ } }, "tags": [ - "Faq-category" + "Faq-question" ], "parameters": [ { @@ -34069,10 +35478,10 @@ } } ], - "operationId": "delete/faq-categories/{id}" + "operationId": "delete/faq-questions/{id}" } }, - "/faq-questions": { + "/global": { "get": { "responses": { "200": { @@ -34080,7 +35489,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqQuestionListResponse" + "$ref": "#/components/schemas/GlobalResponse" } } } @@ -34137,7 +35546,7 @@ } }, "tags": [ - "Faq-question" + "Global" ], "parameters": [ { @@ -34228,112 +35637,31 @@ "required": false, "schema": { "type": "object", - "additionalProperties": true - }, - "style": "deepObject" - }, - { - "name": "locale", - "in": "query", - "description": "Locale to apply", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "get/faq-questions" - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FaqQuestionResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "Faq-question" - ], - "parameters": [], - "operationId": "post/faq-questions", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FaqQuestionRequest" - } + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" } } - } - } - }, - "/faq-questions/{id}": { - "get": { + ], + "operationId": "get/global" + }, + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqQuestionResponse" + "$ref": "#/components/schemas/GlobalResponse" } } } @@ -34390,30 +35718,30 @@ } }, "tags": [ - "Faq-question" + "Global" ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" + "parameters": [], + "operationId": "put/global", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GlobalRequest" + } } } - ], - "operationId": "get/faq-questions/{id}" + } }, - "put": { + "delete": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaqQuestionResponse" + "type": "integer", + "format": "int64" } } } @@ -34470,41 +35798,21 @@ } }, "tags": [ - "Faq-question" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } + "Global" ], - "operationId": "put/faq-questions/{id}", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FaqQuestionRequest" - } - } - } - } - }, - "delete": { + "parameters": [], + "operationId": "delete/global" + } + }, + "/global/localizations": { + "post": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/GlobalLocalizationResponse" } } } @@ -34561,24 +35869,23 @@ } }, "tags": [ - "Faq-question" + "Global" ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" + "parameters": [], + "operationId": "post/global/localizations", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GlobalLocalizationRequest" + } } } - ], - "operationId": "delete/faq-questions/{id}" + } } }, - "/global": { + "/lead-form-submissions": { "get": { "responses": { "200": { @@ -34586,7 +35893,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalResponse" + "$ref": "#/components/schemas/LeadFormSubmissionListResponse" } } } @@ -34643,7 +35950,7 @@ } }, "tags": [ - "Global" + "Lead-form-submission" ], "parameters": [ { @@ -34749,16 +36056,16 @@ } } ], - "operationId": "get/global" + "operationId": "get/lead-form-submissions" }, - "put": { + "post": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalResponse" + "$ref": "#/components/schemas/LeadFormSubmissionResponse" } } } @@ -34815,30 +36122,31 @@ } }, "tags": [ - "Global" + "Lead-form-submission" ], "parameters": [], - "operationId": "put/global", + "operationId": "post/lead-form-submissions", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalRequest" + "$ref": "#/components/schemas/LeadFormSubmissionRequest" } } } } - }, - "delete": { + } + }, + "/lead-form-submissions/{id}": { + "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/LeadFormSubmissionResponse" } } } @@ -34895,21 +36203,30 @@ } }, "tags": [ - "Global" + "Lead-form-submission" ], - "parameters": [], - "operationId": "delete/global" - } - }, - "/global/localizations": { - "post": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "get/lead-form-submissions/{id}" + }, + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalLocalizationResponse" + "$ref": "#/components/schemas/LeadFormSubmissionResponse" } } } @@ -34966,23 +36283,115 @@ } }, "tags": [ - "Global" + "Lead-form-submission" ], - "parameters": [], - "operationId": "post/global/localizations", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "put/lead-form-submissions/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlobalLocalizationRequest" + "$ref": "#/components/schemas/LeadFormSubmissionRequest" + } + } + } + } + }, + "delete": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } } } } - } + }, + "tags": [ + "Lead-form-submission" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/lead-form-submissions/{id}" } }, - "/lead-form-submissions": { + "/networks": { "get": { "responses": { "200": { @@ -34990,7 +36399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionListResponse" + "$ref": "#/components/schemas/NetworkListResponse" } } } @@ -35047,7 +36456,7 @@ } }, "tags": [ - "Lead-form-submission" + "Network" ], "parameters": [ { @@ -35153,7 +36562,7 @@ } } ], - "operationId": "get/lead-form-submissions" + "operationId": "get/networks" }, "post": { "responses": { @@ -35162,7 +36571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionResponse" + "$ref": "#/components/schemas/NetworkResponse" } } } @@ -35219,23 +36628,23 @@ } }, "tags": [ - "Lead-form-submission" + "Network" ], "parameters": [], - "operationId": "post/lead-form-submissions", + "operationId": "post/networks", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionRequest" + "$ref": "#/components/schemas/NetworkRequest" } } } } } }, - "/lead-form-submissions/{id}": { + "/networks/{id}": { "get": { "responses": { "200": { @@ -35243,7 +36652,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionResponse" + "$ref": "#/components/schemas/NetworkResponse" } } } @@ -35300,7 +36709,7 @@ } }, "tags": [ - "Lead-form-submission" + "Network" ], "parameters": [ { @@ -35314,7 +36723,7 @@ } } ], - "operationId": "get/lead-form-submissions/{id}" + "operationId": "get/networks/{id}" }, "put": { "responses": { @@ -35323,7 +36732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionResponse" + "$ref": "#/components/schemas/NetworkResponse" } } } @@ -35380,7 +36789,7 @@ } }, "tags": [ - "Lead-form-submission" + "Network" ], "parameters": [ { @@ -35394,13 +36803,13 @@ } } ], - "operationId": "put/lead-form-submissions/{id}", + "operationId": "put/networks/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LeadFormSubmissionRequest" + "$ref": "#/components/schemas/NetworkRequest" } } } @@ -35471,7 +36880,7 @@ } }, "tags": [ - "Lead-form-submission" + "Network" ], "parameters": [ { @@ -35485,10 +36894,10 @@ } } ], - "operationId": "delete/lead-form-submissions/{id}" + "operationId": "delete/networks/{id}" } }, - "/networks": { + "/notifications": { "get": { "responses": { "200": { @@ -35496,7 +36905,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkListResponse" + "$ref": "#/components/schemas/NotificationListResponse" } } } @@ -35553,7 +36962,7 @@ } }, "tags": [ - "Network" + "Notification" ], "parameters": [ { @@ -35659,7 +37068,7 @@ } } ], - "operationId": "get/networks" + "operationId": "get/notifications" }, "post": { "responses": { @@ -35668,7 +37077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkResponse" + "$ref": "#/components/schemas/NotificationResponse" } } } @@ -35725,23 +37134,23 @@ } }, "tags": [ - "Network" + "Notification" ], "parameters": [], - "operationId": "post/networks", + "operationId": "post/notifications", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkRequest" + "$ref": "#/components/schemas/NotificationRequest" } } } } } }, - "/networks/{id}": { + "/notifications/{id}": { "get": { "responses": { "200": { @@ -35749,7 +37158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkResponse" + "$ref": "#/components/schemas/NotificationResponse" } } } @@ -35806,7 +37215,7 @@ } }, "tags": [ - "Network" + "Notification" ], "parameters": [ { @@ -35820,7 +37229,7 @@ } } ], - "operationId": "get/networks/{id}" + "operationId": "get/notifications/{id}" }, "put": { "responses": { @@ -35829,7 +37238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkResponse" + "$ref": "#/components/schemas/NotificationResponse" } } } @@ -35886,7 +37295,7 @@ } }, "tags": [ - "Network" + "Notification" ], "parameters": [ { @@ -35900,13 +37309,13 @@ } } ], - "operationId": "put/networks/{id}", + "operationId": "put/notifications/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NetworkRequest" + "$ref": "#/components/schemas/NotificationRequest" } } } @@ -35974,200 +37383,28 @@ } } } - } - }, - "tags": [ - "Network" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } - ], - "operationId": "delete/networks/{id}" - } - }, - "/notifications": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationListResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "Notification" - ], - "parameters": [ - { - "name": "sort", - "in": "query", - "description": "Sort by attributes ascending (asc) or descending (desc)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "pagination[withCount]", - "in": "query", - "description": "Return page/pageSize (default: true)", - "deprecated": false, - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "pagination[page]", - "in": "query", - "description": "Page number (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[pageSize]", - "in": "query", - "description": "Page size (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[start]", - "in": "query", - "description": "Offset value (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[limit]", - "in": "query", - "description": "Number of entities to return (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "fields", - "in": "query", - "description": "Fields to return (ex: title,author)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "populate", - "in": "query", - "description": "Relations to return", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "filters", - "in": "query", - "description": "Filters to apply", - "deprecated": false, - "required": false, - "schema": { - "type": "object", - "additionalProperties": true - }, - "style": "deepObject" - }, + } + }, + "tags": [ + "Notification" + ], + "parameters": [ { - "name": "locale", - "in": "query", - "description": "Locale to apply", + "name": "id", + "in": "path", + "description": "", "deprecated": false, - "required": false, + "required": true, "schema": { - "type": "string" + "type": "number" } } ], - "operationId": "get/notifications" - }, - "post": { + "operationId": "delete/notifications/{id}" + } + }, + "/notification-list/{account}": { + "get": { "responses": { "200": { "description": "OK", @@ -36233,21 +37470,22 @@ "tags": [ "Notification" ], - "parameters": [], - "operationId": "post/notifications", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationRequest" - } + "parameters": [ + { + "name": "account", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" } } - } + ], + "operationId": "get/notification-list/{account}" } }, - "/notifications/{id}": { + "/accounts/{account}/notifications": { "get": { "responses": { "200": { @@ -36316,7 +37554,7 @@ ], "parameters": [ { - "name": "id", + "name": "account", "in": "path", "description": "", "deprecated": false, @@ -36326,9 +37564,11 @@ } } ], - "operationId": "get/notifications/{id}" - }, - "put": { + "operationId": "get/accounts/{account}/notifications" + } + }, + "/push-notifications": { + "get": { "responses": { "200": { "description": "OK", @@ -36394,39 +37634,19 @@ "tags": [ "Notification" ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } - ], - "operationId": "put/notifications/{id}", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationRequest" - } - } - } - } - }, - "delete": { + "parameters": [], + "operationId": "get/push-notifications" + } + }, + "/notification-templates": { + "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/NotificationTemplateListResponse" } } } @@ -36483,24 +37703,195 @@ } }, "tags": [ - "Notification" + "Notification-template" ], "parameters": [ { - "name": "id", - "in": "path", - "description": "", + "name": "sort", + "in": "query", + "description": "Sort by attributes ascending (asc) or descending (desc)", "deprecated": false, - "required": true, + "required": false, "schema": { - "type": "number" + "type": "string" + } + }, + { + "name": "pagination[withCount]", + "in": "query", + "description": "Return page/pageSize (default: true)", + "deprecated": false, + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pagination[page]", + "in": "query", + "description": "Page number (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[pageSize]", + "in": "query", + "description": "Page size (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[start]", + "in": "query", + "description": "Offset value (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[limit]", + "in": "query", + "description": "Number of entities to return (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "in": "query", + "description": "Fields to return (ex: title,author)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "populate", + "in": "query", + "description": "Relations to return", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "filters", + "in": "query", + "description": "Filters to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "object", + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "get/notification-templates" + }, + "post": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationTemplateResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } } } + }, + "tags": [ + "Notification-template" ], - "operationId": "delete/notifications/{id}" + "parameters": [], + "operationId": "post/notification-templates", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationTemplateRequest" + } + } + } + } } }, - "/notification-list/{account}": { + "/notification-templates/{id}": { "get": { "responses": { "200": { @@ -36508,7 +37899,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationResponse" + "$ref": "#/components/schemas/NotificationTemplateResponse" } } } @@ -36565,11 +37956,11 @@ } }, "tags": [ - "Notification" + "Notification-template" ], "parameters": [ { - "name": "account", + "name": "id", "in": "path", "description": "", "deprecated": false, @@ -36579,18 +37970,16 @@ } } ], - "operationId": "get/notification-list/{account}" - } - }, - "/accounts/{account}/notifications": { - "get": { + "operationId": "get/notification-templates/{id}" + }, + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationResponse" + "$ref": "#/components/schemas/NotificationTemplateResponse" } } } @@ -36647,11 +38036,11 @@ } }, "tags": [ - "Notification" + "Notification-template" ], "parameters": [ { - "name": "account", + "name": "id", "in": "path", "description": "", "deprecated": false, @@ -36661,18 +38050,27 @@ } } ], - "operationId": "get/accounts/{account}/notifications" - } - }, - "/push-notifications": { - "get": { + "operationId": "put/notification-templates/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationTemplateRequest" + } + } + } + } + }, + "delete": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationResponse" + "type": "integer", + "format": "int64" } } } @@ -36729,13 +38127,24 @@ } }, "tags": [ - "Notification" + "Notification-template" ], - "parameters": [], - "operationId": "get/push-notifications" + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/notification-templates/{id}" } }, - "/notification-templates": { + "/notifications-consumer": { "get": { "responses": { "200": { @@ -36743,7 +38152,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateListResponse" + "$ref": "#/components/schemas/NotificationsConsumerResponse" } } } @@ -36800,7 +38209,7 @@ } }, "tags": [ - "Notification-template" + "Notifications-consumer" ], "parameters": [ { @@ -36906,16 +38315,16 @@ } } ], - "operationId": "get/notification-templates" + "operationId": "get/notifications-consumer" }, - "post": { + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateResponse" + "$ref": "#/components/schemas/NotificationsConsumerResponse" } } } @@ -36972,23 +38381,93 @@ } }, "tags": [ - "Notification-template" + "Notifications-consumer" ], "parameters": [], - "operationId": "post/notification-templates", + "operationId": "put/notifications-consumer", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateRequest" + "$ref": "#/components/schemas/NotificationsConsumerRequest" } } } } + }, + "delete": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Notifications-consumer" + ], + "parameters": [], + "operationId": "delete/notifications-consumer" } }, - "/notification-templates/{id}": { + "/pages": { "get": { "responses": { "200": { @@ -36996,7 +38475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateResponse" + "$ref": "#/components/schemas/PageListResponse" } } } @@ -37031,52 +38510,144 @@ } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Page" + ], + "parameters": [ + { + "name": "sort", + "in": "query", + "description": "Sort by attributes ascending (asc) or descending (desc)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "pagination[withCount]", + "in": "query", + "description": "Return page/pageSize (default: true)", + "deprecated": false, + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pagination[page]", + "in": "query", + "description": "Page number (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[pageSize]", + "in": "query", + "description": "Page size (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[start]", + "in": "query", + "description": "Offset value (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[limit]", + "in": "query", + "description": "Number of entities to return (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "in": "query", + "description": "Fields to return (ex: title,author)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" } }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } + { + "name": "populate", + "in": "query", + "description": "Relations to return", + "deprecated": false, + "required": false, + "schema": { + "type": "string" } - } - }, - "tags": [ - "Notification-template" - ], - "parameters": [ + }, { - "name": "id", - "in": "path", - "description": "", + "name": "filters", + "in": "query", + "description": "Filters to apply", "deprecated": false, - "required": true, + "required": false, "schema": { - "type": "number" + "type": "object", + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" } } ], - "operationId": "get/notification-templates/{id}" + "operationId": "get/pages" }, - "put": { + "post": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateResponse" + "$ref": "#/components/schemas/PageResponse" } } } @@ -37133,41 +38704,31 @@ } }, "tags": [ - "Notification-template" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } + "Page" ], - "operationId": "put/notification-templates/{id}", + "parameters": [], + "operationId": "post/pages", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationTemplateRequest" + "$ref": "#/components/schemas/PageRequest" } } } } - }, - "delete": { + } + }, + "/pages/{id}": { + "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/PageResponse" } } } @@ -37224,7 +38785,7 @@ } }, "tags": [ - "Notification-template" + "Page" ], "parameters": [ { @@ -37238,18 +38799,16 @@ } } ], - "operationId": "delete/notification-templates/{id}" - } - }, - "/notifications-consumer": { - "get": { + "operationId": "get/pages/{id}" + }, + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationsConsumerResponse" + "$ref": "#/components/schemas/PageResponse" } } } @@ -37306,122 +38865,41 @@ } }, "tags": [ - "Notifications-consumer" + "Page" ], "parameters": [ { - "name": "sort", - "in": "query", - "description": "Sort by attributes ascending (asc) or descending (desc)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "pagination[withCount]", - "in": "query", - "description": "Return page/pageSize (default: true)", - "deprecated": false, - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "pagination[page]", - "in": "query", - "description": "Page number (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[pageSize]", - "in": "query", - "description": "Page size (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[start]", - "in": "query", - "description": "Offset value (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[limit]", - "in": "query", - "description": "Number of entities to return (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "fields", - "in": "query", - "description": "Fields to return (ex: title,author)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "populate", - "in": "query", - "description": "Relations to return", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "filters", - "in": "query", - "description": "Filters to apply", - "deprecated": false, - "required": false, - "schema": { - "type": "object", - "additionalProperties": true - }, - "style": "deepObject" - }, - { - "name": "locale", - "in": "query", - "description": "Locale to apply", + "name": "id", + "in": "path", + "description": "", "deprecated": false, - "required": false, + "required": true, "schema": { - "type": "string" + "type": "number" } } ], - "operationId": "get/notifications-consumer" + "operationId": "put/pages/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageRequest" + } + } + } + } }, - "put": { + "delete": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NotificationsConsumerResponse" + "type": "integer", + "format": "int64" } } } @@ -37478,30 +38956,32 @@ } }, "tags": [ - "Notifications-consumer" + "Page" ], - "parameters": [], - "operationId": "put/notifications-consumer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConsumerRequest" - } + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" } } - } - }, - "delete": { + ], + "operationId": "delete/pages/{id}" + } + }, + "/pages/{id}/localizations": { + "post": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/PageLocalizationResponse" } } } @@ -37558,13 +39038,34 @@ } }, "tags": [ - "Notifications-consumer" + "Page" ], - "parameters": [], - "operationId": "delete/notifications-consumer" + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "post/pages/{id}/localizations", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageLocalizationRequest" + } + } + } + } } }, - "/pages": { + "/product-features": { "get": { "responses": { "200": { @@ -37572,7 +39073,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageListResponse" + "$ref": "#/components/schemas/ProductFeatureListResponse" } } } @@ -37629,7 +39130,7 @@ } }, "tags": [ - "Page" + "Product-feature" ], "parameters": [ { @@ -37735,7 +39236,7 @@ } } ], - "operationId": "get/pages" + "operationId": "get/product-features" }, "post": { "responses": { @@ -37744,7 +39245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageResponse" + "$ref": "#/components/schemas/ProductFeatureResponse" } } } @@ -37801,23 +39302,23 @@ } }, "tags": [ - "Page" + "Product-feature" ], "parameters": [], - "operationId": "post/pages", + "operationId": "post/product-features", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageRequest" + "$ref": "#/components/schemas/ProductFeatureRequest" } } } } } }, - "/pages/{id}": { + "/product-features/{id}": { "get": { "responses": { "200": { @@ -37825,7 +39326,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageResponse" + "$ref": "#/components/schemas/ProductFeatureResponse" } } } @@ -37882,7 +39383,7 @@ } }, "tags": [ - "Page" + "Product-feature" ], "parameters": [ { @@ -37896,7 +39397,7 @@ } } ], - "operationId": "get/pages/{id}" + "operationId": "get/product-features/{id}" }, "put": { "responses": { @@ -37905,7 +39406,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageResponse" + "$ref": "#/components/schemas/ProductFeatureResponse" } } } @@ -37962,7 +39463,7 @@ } }, "tags": [ - "Page" + "Product-feature" ], "parameters": [ { @@ -37976,13 +39477,13 @@ } } ], - "operationId": "put/pages/{id}", + "operationId": "put/product-features/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageRequest" + "$ref": "#/components/schemas/ProductFeatureRequest" } } } @@ -38053,89 +39554,7 @@ } }, "tags": [ - "Page" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } - ], - "operationId": "delete/pages/{id}" - } - }, - "/pages/{id}/localizations": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageLocalizationResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "Page" + "Product-feature" ], "parameters": [ { @@ -38149,20 +39568,10 @@ } } ], - "operationId": "post/pages/{id}/localizations", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageLocalizationRequest" - } - } - } - } + "operationId": "delete/product-features/{id}" } }, - "/product-features": { + "/restricted-token-lists": { "get": { "responses": { "200": { @@ -38170,7 +39579,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureListResponse" + "$ref": "#/components/schemas/RestrictedTokenListListResponse" } } } @@ -38227,7 +39636,7 @@ } }, "tags": [ - "Product-feature" + "Restricted-token-list" ], "parameters": [ { @@ -38333,7 +39742,7 @@ } } ], - "operationId": "get/product-features" + "operationId": "get/restricted-token-lists" }, "post": { "responses": { @@ -38342,7 +39751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureResponse" + "$ref": "#/components/schemas/RestrictedTokenListResponse" } } } @@ -38399,23 +39808,23 @@ } }, "tags": [ - "Product-feature" + "Restricted-token-list" ], "parameters": [], - "operationId": "post/product-features", + "operationId": "post/restricted-token-lists", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureRequest" + "$ref": "#/components/schemas/RestrictedTokenListRequest" } } } } } }, - "/product-features/{id}": { + "/restricted-token-lists/{id}": { "get": { "responses": { "200": { @@ -38423,7 +39832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureResponse" + "$ref": "#/components/schemas/RestrictedTokenListResponse" } } } @@ -38480,7 +39889,7 @@ } }, "tags": [ - "Product-feature" + "Restricted-token-list" ], "parameters": [ { @@ -38494,7 +39903,7 @@ } } ], - "operationId": "get/product-features/{id}" + "operationId": "get/restricted-token-lists/{id}" }, "put": { "responses": { @@ -38503,7 +39912,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureResponse" + "$ref": "#/components/schemas/RestrictedTokenListResponse" } } } @@ -38560,7 +39969,7 @@ } }, "tags": [ - "Product-feature" + "Restricted-token-list" ], "parameters": [ { @@ -38574,13 +39983,13 @@ } } ], - "operationId": "put/product-features/{id}", + "operationId": "put/restricted-token-lists/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureRequest" + "$ref": "#/components/schemas/RestrictedTokenListRequest" } } } @@ -38651,7 +40060,7 @@ } }, "tags": [ - "Product-feature" + "Restricted-token-list" ], "parameters": [ { @@ -38665,10 +40074,10 @@ } } ], - "operationId": "delete/product-features/{id}" + "operationId": "delete/restricted-token-lists/{id}" } }, - "/restricted-token-lists": { + "/solvers": { "get": { "responses": { "200": { @@ -38676,7 +40085,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListListResponse" + "$ref": "#/components/schemas/SolverListResponse" } } } @@ -38733,7 +40142,7 @@ } }, "tags": [ - "Restricted-token-list" + "Solver" ], "parameters": [ { @@ -38839,7 +40248,7 @@ } } ], - "operationId": "get/restricted-token-lists" + "operationId": "get/solvers" }, "post": { "responses": { @@ -38848,7 +40257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListResponse" + "$ref": "#/components/schemas/SolverResponse" } } } @@ -38905,23 +40314,23 @@ } }, "tags": [ - "Restricted-token-list" + "Solver" ], "parameters": [], - "operationId": "post/restricted-token-lists", + "operationId": "post/solvers", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListRequest" + "$ref": "#/components/schemas/SolverRequest" } } } } } }, - "/restricted-token-lists/{id}": { + "/solvers/{id}": { "get": { "responses": { "200": { @@ -38929,7 +40338,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListResponse" + "$ref": "#/components/schemas/SolverResponse" } } } @@ -38986,7 +40395,7 @@ } }, "tags": [ - "Restricted-token-list" + "Solver" ], "parameters": [ { @@ -39000,7 +40409,7 @@ } } ], - "operationId": "get/restricted-token-lists/{id}" + "operationId": "get/solvers/{id}" }, "put": { "responses": { @@ -39009,7 +40418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListResponse" + "$ref": "#/components/schemas/SolverResponse" } } } @@ -39066,7 +40475,7 @@ } }, "tags": [ - "Restricted-token-list" + "Solver" ], "parameters": [ { @@ -39080,13 +40489,13 @@ } } ], - "operationId": "put/restricted-token-lists/{id}", + "operationId": "put/solvers/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictedTokenListRequest" + "$ref": "#/components/schemas/SolverRequest" } } } @@ -39157,7 +40566,7 @@ } }, "tags": [ - "Restricted-token-list" + "Solver" ], "parameters": [ { @@ -39171,10 +40580,10 @@ } } ], - "operationId": "delete/restricted-token-lists/{id}" + "operationId": "delete/solvers/{id}" } }, - "/solvers": { + "/solver-bonding-pools": { "get": { "responses": { "200": { @@ -39182,7 +40591,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverListResponse" + "$ref": "#/components/schemas/SolverBondingPoolListResponse" } } } @@ -39239,7 +40648,7 @@ } }, "tags": [ - "Solver" + "Solver-bonding-pool" ], "parameters": [ { @@ -39345,7 +40754,7 @@ } } ], - "operationId": "get/solvers" + "operationId": "get/solver-bonding-pools" }, "post": { "responses": { @@ -39354,7 +40763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverResponse" + "$ref": "#/components/schemas/SolverBondingPoolResponse" } } } @@ -39411,23 +40820,23 @@ } }, "tags": [ - "Solver" + "Solver-bonding-pool" ], "parameters": [], - "operationId": "post/solvers", + "operationId": "post/solver-bonding-pools", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverRequest" + "$ref": "#/components/schemas/SolverBondingPoolRequest" } } } } } }, - "/solvers/{id}": { + "/solver-bonding-pools/{id}": { "get": { "responses": { "200": { @@ -39435,7 +40844,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverResponse" + "$ref": "#/components/schemas/SolverBondingPoolResponse" } } } @@ -39492,7 +40901,7 @@ } }, "tags": [ - "Solver" + "Solver-bonding-pool" ], "parameters": [ { @@ -39506,7 +40915,7 @@ } } ], - "operationId": "get/solvers/{id}" + "operationId": "get/solver-bonding-pools/{id}" }, "put": { "responses": { @@ -39515,7 +40924,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverResponse" + "$ref": "#/components/schemas/SolverBondingPoolResponse" } } } @@ -39572,7 +40981,7 @@ } }, "tags": [ - "Solver" + "Solver-bonding-pool" ], "parameters": [ { @@ -39586,13 +40995,13 @@ } } ], - "operationId": "put/solvers/{id}", + "operationId": "put/solver-bonding-pools/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverRequest" + "$ref": "#/components/schemas/SolverBondingPoolRequest" } } } @@ -39663,7 +41072,7 @@ } }, "tags": [ - "Solver" + "Solver-bonding-pool" ], "parameters": [ { @@ -39677,10 +41086,10 @@ } } ], - "operationId": "delete/solvers/{id}" + "operationId": "delete/solver-bonding-pools/{id}" } }, - "/solver-bonding-pools": { + "/solver-networks": { "get": { "responses": { "200": { @@ -39688,7 +41097,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolListResponse" + "$ref": "#/components/schemas/SolverNetworkListResponse" } } } @@ -39745,7 +41154,7 @@ } }, "tags": [ - "Solver-bonding-pool" + "Solver-network" ], "parameters": [ { @@ -39851,7 +41260,7 @@ } } ], - "operationId": "get/solver-bonding-pools" + "operationId": "get/solver-networks" }, "post": { "responses": { @@ -39860,7 +41269,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolResponse" + "$ref": "#/components/schemas/SolverNetworkResponse" } } } @@ -39917,23 +41326,23 @@ } }, "tags": [ - "Solver-bonding-pool" + "Solver-network" ], "parameters": [], - "operationId": "post/solver-bonding-pools", + "operationId": "post/solver-networks", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolRequest" + "$ref": "#/components/schemas/SolverNetworkRequest" } } } } } }, - "/solver-bonding-pools/{id}": { + "/solver-networks/{id}": { "get": { "responses": { "200": { @@ -39941,7 +41350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolResponse" + "$ref": "#/components/schemas/SolverNetworkResponse" } } } @@ -39998,7 +41407,7 @@ } }, "tags": [ - "Solver-bonding-pool" + "Solver-network" ], "parameters": [ { @@ -40012,7 +41421,7 @@ } } ], - "operationId": "get/solver-bonding-pools/{id}" + "operationId": "get/solver-networks/{id}" }, "put": { "responses": { @@ -40021,7 +41430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolResponse" + "$ref": "#/components/schemas/SolverNetworkResponse" } } } @@ -40078,7 +41487,7 @@ } }, "tags": [ - "Solver-bonding-pool" + "Solver-network" ], "parameters": [ { @@ -40092,13 +41501,13 @@ } } ], - "operationId": "put/solver-bonding-pools/{id}", + "operationId": "put/solver-networks/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverBondingPoolRequest" + "$ref": "#/components/schemas/SolverNetworkRequest" } } } @@ -40169,7 +41578,7 @@ } }, "tags": [ - "Solver-bonding-pool" + "Solver-network" ], "parameters": [ { @@ -40183,10 +41592,10 @@ } } ], - "operationId": "delete/solver-bonding-pools/{id}" + "operationId": "delete/solver-networks/{id}" } }, - "/solver-networks": { + "/tags": { "get": { "responses": { "200": { @@ -40194,7 +41603,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkListResponse" + "$ref": "#/components/schemas/TagListResponse" } } } @@ -40251,7 +41660,7 @@ } }, "tags": [ - "Solver-network" + "Tag" ], "parameters": [ { @@ -40357,7 +41766,7 @@ } } ], - "operationId": "get/solver-networks" + "operationId": "get/tags" }, "post": { "responses": { @@ -40366,7 +41775,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkResponse" + "$ref": "#/components/schemas/TagResponse" } } } @@ -40423,23 +41832,23 @@ } }, "tags": [ - "Solver-network" + "Tag" ], "parameters": [], - "operationId": "post/solver-networks", + "operationId": "post/tags", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkRequest" + "$ref": "#/components/schemas/TagRequest" } } } } } }, - "/solver-networks/{id}": { + "/tags/{id}": { "get": { "responses": { "200": { @@ -40447,7 +41856,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkResponse" + "$ref": "#/components/schemas/TagResponse" } } } @@ -40504,7 +41913,7 @@ } }, "tags": [ - "Solver-network" + "Tag" ], "parameters": [ { @@ -40518,7 +41927,7 @@ } } ], - "operationId": "get/solver-networks/{id}" + "operationId": "get/tags/{id}" }, "put": { "responses": { @@ -40527,7 +41936,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkResponse" + "$ref": "#/components/schemas/TagResponse" } } } @@ -40584,7 +41993,7 @@ } }, "tags": [ - "Solver-network" + "Tag" ], "parameters": [ { @@ -40598,13 +42007,13 @@ } } ], - "operationId": "put/solver-networks/{id}", + "operationId": "put/tags/{id}", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SolverNetworkRequest" + "$ref": "#/components/schemas/TagRequest" } } } @@ -40675,7 +42084,7 @@ } }, "tags": [ - "Solver-network" + "Tag" ], "parameters": [ { @@ -40689,10 +42098,10 @@ } } ], - "operationId": "delete/solver-networks/{id}" + "operationId": "delete/tags/{id}" } }, - "/tags": { + "/telegram-subscriptions": { "get": { "responses": { "200": { @@ -40700,7 +42109,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagListResponse" + "$ref": "#/components/schemas/TelegramSubscriptionListResponse" } } } @@ -40757,7 +42166,7 @@ } }, "tags": [ - "Tag" + "Telegram-subscription" ], "parameters": [ { @@ -40851,189 +42260,28 @@ "additionalProperties": true }, "style": "deepObject" - }, - { - "name": "locale", - "in": "query", - "description": "Locale to apply", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "get/tags" - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "Tag" - ], - "parameters": [], - "operationId": "post/tags", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagRequest" - } - } - } - } - } - }, - "/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "Tag" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", "deprecated": false, - "required": true, + "required": false, "schema": { - "type": "number" + "type": "string" } } ], - "operationId": "get/tags/{id}" + "operationId": "get/telegram-subscriptions" }, - "put": { + "post": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagResponse" + "$ref": "#/components/schemas/TelegramSubscriptionResponse" } } } @@ -41090,41 +42338,31 @@ } }, "tags": [ - "Tag" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } + "Telegram-subscription" ], - "operationId": "put/tags/{id}", + "parameters": [], + "operationId": "post/telegram-subscriptions", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagRequest" + "$ref": "#/components/schemas/TelegramSubscriptionRequest" } } } } - }, - "delete": { + } + }, + "/telegram-subscriptions/{id}": { + "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/TelegramSubscriptionResponse" } } } @@ -41181,7 +42419,7 @@ } }, "tags": [ - "Tag" + "Telegram-subscription" ], "parameters": [ { @@ -41195,18 +42433,16 @@ } } ], - "operationId": "delete/tags/{id}" - } - }, - "/telegram-subscriptions": { - "get": { + "operationId": "get/telegram-subscriptions/{id}" + }, + "put": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionListResponse" + "$ref": "#/components/schemas/TelegramSubscriptionResponse" } } } @@ -41267,118 +42503,37 @@ ], "parameters": [ { - "name": "sort", - "in": "query", - "description": "Sort by attributes ascending (asc) or descending (desc)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "pagination[withCount]", - "in": "query", - "description": "Return page/pageSize (default: true)", - "deprecated": false, - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "pagination[page]", - "in": "query", - "description": "Page number (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[pageSize]", - "in": "query", - "description": "Page size (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[start]", - "in": "query", - "description": "Offset value (default: 0)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "pagination[limit]", - "in": "query", - "description": "Number of entities to return (default: 25)", - "deprecated": false, - "required": false, - "schema": { - "type": "integer" - } - }, - { - "name": "fields", - "in": "query", - "description": "Fields to return (ex: title,author)", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "populate", - "in": "query", - "description": "Relations to return", - "deprecated": false, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "filters", - "in": "query", - "description": "Filters to apply", - "deprecated": false, - "required": false, - "schema": { - "type": "object", - "additionalProperties": true - }, - "style": "deepObject" - }, - { - "name": "locale", - "in": "query", - "description": "Locale to apply", + "name": "id", + "in": "path", + "description": "", "deprecated": false, - "required": false, + "required": true, "schema": { - "type": "string" + "type": "number" } } ], - "operationId": "get/telegram-subscriptions" + "operationId": "put/telegram-subscriptions/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TelegramSubscriptionRequest" + } + } + } + } }, - "post": { + "delete": { "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionResponse" + "type": "integer", + "format": "int64" } } } @@ -41422,90 +42577,272 @@ } } } - }, - "500": { - "description": "Internal Server Error", + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "Telegram-subscription" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/telegram-subscriptions/{id}" + } + }, + "/upload": { + "post": { + "description": "Upload files", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadFile" + } + } + } + } + } + }, + "summary": "", + "tags": [ + "Upload - File" + ], + "requestBody": { + "description": "Upload files", + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "files" + ], + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The folder where the file(s) will be uploaded to (only supported on strapi-provider-upload-aws-s3)." + }, + "refId": { + "type": "string", + "description": "The ID of the entry which the file(s) will be linked to" + }, + "ref": { + "type": "string", + "description": "The unique ID (uid) of the model which the file(s) will be linked to (api::restaurant.restaurant)." + }, + "field": { + "type": "string", + "description": "The field of the entry which the file(s) will be precisely linked to." + }, + "files": { + "type": "array", + "items": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + } + } + }, + "/upload?id={id}": { + "post": { + "parameters": [ + { + "name": "id", + "in": "query", + "description": "File id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "description": "Upload file information", + "responses": { + "200": { + "description": "response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadFile" + } } } } } }, + "summary": "", "tags": [ - "Telegram-subscription" + "Upload - File" ], - "parameters": [], - "operationId": "post/telegram-subscriptions", "requestBody": { + "description": "Upload files", "required": true, "content": { - "application/json": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionRequest" + "type": "object", + "properties": { + "fileInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "alternativeText": { + "type": "string" + }, + "caption": { + "type": "string" + } + } + }, + "files": { + "type": "string", + "format": "binary" + } + } } } } } } }, - "/telegram-subscriptions/{id}": { + "/upload/files": { "get": { + "tags": [ + "Upload - File" + ], "responses": { "200": { - "description": "OK", + "description": "Get a list of files", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadFile" + } } } } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } + } + } + } + }, + "/upload/files/{id}": { + "get": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "string" } - }, - "401": { - "description": "Unauthorized", + } + ], + "tags": [ + "Upload - File" + ], + "responses": { + "200": { + "description": "Get a specific file", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/UploadFile" } } } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } + } + } + }, + "delete": { + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "string" } - }, - "404": { - "description": "Not Found", + } + ], + "tags": [ + "Upload - File" + ], + "responses": { + "200": { + "description": "Delete a file", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/UploadFile" } } } + } + } + } + }, + "/connect/{provider}": { + "get": { + "parameters": [ + { + "name": "provider", + "in": "path", + "required": true, + "description": "Provider name", + "schema": { + "type": "string", + "pattern": ".*" + } + } + ], + "tags": [ + "Users-Permissions - Auth" + ], + "summary": "Login with a provider", + "description": "Redirects to provider login before being redirect to /auth/{provider}/callback", + "responses": { + "301": { + "description": "Redirect response" }, - "500": { - "description": "Internal Server Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41514,38 +42851,51 @@ } } } - }, + } + } + }, + "/auth/local": { + "post": { "tags": [ - "Telegram-subscription" + "Users-Permissions - Auth" ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" + "summary": "Local login", + "description": "Returns a jwt token and user info", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "example": { + "identifier": "foobar", + "password": "Test1234" + } } - } - ], - "operationId": "get/telegram-subscriptions/{id}" - }, - "put": { + }, + "required": true + }, "responses": { "200": { - "description": "OK", + "description": "Connection", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionResponse" + "$ref": "#/components/schemas/Users-Permissions-UserRegistration" } } } }, - "400": { - "description": "Bad Request", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41553,19 +42903,56 @@ } } } + } + } + } + }, + "/auth/local/register": { + "post": { + "tags": [ + "Users-Permissions - Auth" + ], + "summary": "Register a user", + "description": "Returns a jwt token and user info", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "example": { + "username": "foobar", + "email": "foo.bar@strapi.io", + "password": "Test1234" + } + } }, - "401": { - "description": "Unauthorized", + "required": true + }, + "responses": { + "200": { + "description": "Successful registration", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/Users-Permissions-UserRegistration" } } } }, - "403": { - "description": "Forbidden", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41573,19 +42960,40 @@ } } } - }, - "404": { - "description": "Not Found", + } + } + } + }, + "/auth/{provider}/callback": { + "get": { + "tags": [ + "Users-Permissions - Auth" + ], + "summary": "Default Callback from provider auth", + "parameters": [ + { + "name": "provider", + "in": "path", + "required": true, + "description": "Provider name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns a jwt token and user info", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/Users-Permissions-UserRegistration" } } } }, - "500": { - "description": "Internal Server Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41594,59 +43002,54 @@ } } } - }, + } + } + }, + "/auth/forgot-password": { + "post": { "tags": [ - "Telegram-subscription" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } + "Users-Permissions - Auth" ], - "operationId": "put/telegram-subscriptions/{id}", + "summary": "Send rest password email", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TelegramSubscriptionRequest" + "type": "object", + "properties": { + "email": { + "type": "string" + } + } + }, + "example": { + "email": "foo.bar@strapi.io" } } } - } - }, - "delete": { + }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "Returns ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "type": "object", + "properties": { + "ok": { + "type": "string", + "enum": [ + true + ] + } + } } } } }, - "401": { - "description": "Unauthorized", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41654,29 +43057,55 @@ } } } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" + } + } + } + }, + "/auth/reset-password": { + "post": { + "tags": [ + "Users-Permissions - Auth" + ], + "summary": "Rest user password", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "passwordConfirmation": { + "type": "string" + }, + "code": { + "type": "string" + } } + }, + "example": { + "password": "Test1234", + "passwordConfirmation": "Test1234", + "code": "zertyoaizndoianzodianzdonaizdoinaozdnia" } } - }, - "404": { - "description": "Not Found", + } + }, + "responses": { + "200": { + "description": "Returns a jwt token and user info", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error" + "$ref": "#/components/schemas/Users-Permissions-UserRegistration" } } } }, - "500": { - "description": "Internal Server Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -41685,229 +43114,218 @@ } } } - }, - "tags": [ - "Telegram-subscription" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "number" - } - } - ], - "operationId": "delete/telegram-subscriptions/{id}" + } } }, - "/upload": { + "/auth/change-password": { "post": { - "description": "Upload files", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UploadFile" - } - } - } - } - } - }, - "summary": "", "tags": [ - "Upload - File" + "Users-Permissions - Auth" ], + "summary": "Update user's own password", "requestBody": { - "description": "Upload files", "required": true, "content": { - "multipart/form-data": { + "application/json": { "schema": { + "type": "object", "required": [ - "files" + "password", + "currentPassword", + "passwordConfirmation" ], - "type": "object", "properties": { - "path": { - "type": "string", - "description": "The folder where the file(s) will be uploaded to (only supported on strapi-provider-upload-aws-s3)." - }, - "refId": { - "type": "string", - "description": "The ID of the entry which the file(s) will be linked to" - }, - "ref": { - "type": "string", - "description": "The unique ID (uid) of the model which the file(s) will be linked to (api::restaurant.restaurant)." + "password": { + "type": "string" }, - "field": { - "type": "string", - "description": "The field of the entry which the file(s) will be precisely linked to." + "currentPassword": { + "type": "string" }, - "files": { - "type": "array", - "items": { - "type": "string", - "format": "binary" - } + "passwordConfirmation": { + "type": "string" } } } } } + }, + "responses": { + "200": { + "description": "Returns a jwt token and user info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Users-Permissions-UserRegistration" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } } } }, - "/upload?id={id}": { - "post": { + "/auth/email-confirmation": { + "get": { + "tags": [ + "Users-Permissions - Auth" + ], + "summary": "Confirm user email", "parameters": [ { - "name": "id", "in": "query", - "description": "File id", - "required": true, + "name": "confirmation", "schema": { "type": "string" - } + }, + "description": "confirmation token received by email" } ], - "description": "Upload file information", "responses": { - "200": { - "description": "response", + "301": { + "description": "Redirects to the configure email confirmation redirect url" + }, + "default": { + "description": "Error", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UploadFile" - } + "$ref": "#/components/schemas/Error" } } } } - }, - "summary": "", + } + } + }, + "/auth/send-email-confirmation": { + "post": { "tags": [ - "Upload - File" + "Users-Permissions - Auth" ], + "summary": "Send confirmation email", "requestBody": { - "description": "Upload files", "required": true, "content": { - "multipart/form-data": { + "application/json": { "schema": { "type": "object", "properties": { - "fileInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "alternativeText": { - "type": "string" - }, - "caption": { - "type": "string" - } - } - }, - "files": { - "type": "string", - "format": "binary" + "email": { + "type": "string" } } } } } - } - } - }, - "/upload/files": { - "get": { - "tags": [ - "Upload - File" - ], + }, "responses": { "200": { - "description": "Get a list of files", + "description": "Returns email and boolean to confirm email was sent", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UploadFile" + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "sent": { + "type": "string", + "enum": [ + true + ] + } } } } } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } } } } }, - "/upload/files/{id}": { + "/users-permissions/permissions": { "get": { - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "string" - } - } - ], "tags": [ - "Upload - File" + "Users-Permissions - Users & Roles" ], + "summary": "Get default generated permissions", "responses": { "200": { - "description": "Get a specific file", + "description": "Returns the permissions tree", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UploadFile" + "type": "object", + "properties": { + "permissions": { + "$ref": "#/components/schemas/Users-Permissions-PermissionsTree" + } + } + }, + "example": { + "permissions": { + "api::content-type.content-type": { + "controllers": { + "controllerA": { + "find": { + "enabled": false, + "policy": "" + }, + "findOne": { + "enabled": false, + "policy": "" + }, + "create": { + "enabled": false, + "policy": "" + } + }, + "controllerB": { + "find": { + "enabled": false, + "policy": "" + }, + "findOne": { + "enabled": false, + "policy": "" + }, + "create": { + "enabled": false, + "policy": "" + } + } + } + } + } } } } - } - } - }, - "delete": { - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "deprecated": false, - "required": true, - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Upload - File" - ], - "responses": { - "200": { - "description": "Delete a file", + }, + "default": { + "description": "Error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UploadFile" + "$ref": "#/components/schemas/Error" } } } @@ -41915,28 +43333,55 @@ } } }, - "/connect/{provider}": { + "/users-permissions/roles": { "get": { - "parameters": [ - { - "name": "provider", - "in": "path", - "required": true, - "description": "Provider name", - "schema": { - "type": "string", - "pattern": ".*" - } - } - ], "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Login with a provider", - "description": "Redirects to provider login before being redirect to /auth/{provider}/callback", + "summary": "List roles", "responses": { - "301": { - "description": "Redirect response" + "200": { + "description": "Returns list of roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "roles": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/Users-Permissions-Role" + }, + { + "type": "object", + "properties": { + "nb_users": { + "type": "number" + } + } + } + ] + } + } + } + }, + "example": { + "roles": [ + { + "id": 1, + "name": "Public", + "description": "Default role given to unauthenticated user.", + "type": "public", + "createdAt": "2022-05-19T17:35:35.097Z", + "updatedAt": "2022-05-31T16:05:36.603Z", + "nb_users": 0 + } + ] + } + } + } }, "default": { "description": "Error", @@ -41949,44 +43394,30 @@ } } } - } - }, - "/auth/local": { + }, "post": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Local login", - "description": "Returns a jwt token and user info", + "summary": "Create a role", "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "example": { - "identifier": "foobar", - "password": "Test1234" - } - } - }, - "required": true + "$ref": "#/components/requestBodies/Users-Permissions-RoleRequest" }, "responses": { "200": { - "description": "Connection", + "description": "Returns ok if the role was create", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-UserRegistration" + "type": "object", + "properties": { + "ok": { + "type": "string", + "enum": [ + true + ] + } + } } } } @@ -42004,46 +43435,56 @@ } } }, - "/auth/local/register": { - "post": { + "/users-permissions/roles/{id}": { + "get": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" + ], + "summary": "Get a role", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + }, + "description": "role Id" + } ], - "summary": "Register a user", - "description": "Returns a jwt token and user info", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "example": { - "username": "foobar", - "email": "foo.bar@strapi.io", - "password": "Test1234" - } - } - }, - "required": true - }, "responses": { "200": { - "description": "Successful registration", + "description": "Returns the role", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-UserRegistration" + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/Users-Permissions-Role" + } + } + }, + "example": { + "role": { + "id": 1, + "name": "Public", + "description": "Default role given to unauthenticated user.", + "type": "public", + "createdAt": "2022-05-19T17:35:35.097Z", + "updatedAt": "2022-05-31T16:05:36.603Z", + "permissions": { + "api::content-type.content-type": { + "controllers": { + "controllerA": { + "find": { + "enabled": true + } + } + } + } + } + } } } } @@ -42061,30 +43502,41 @@ } } }, - "/auth/{provider}/callback": { - "get": { + "/users-permissions/roles/{role}": { + "put": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Default Callback from provider auth", + "summary": "Update a role", "parameters": [ { - "name": "provider", "in": "path", + "name": "role", "required": true, - "description": "Provider name", "schema": { "type": "string" - } + }, + "description": "role Id" } ], + "requestBody": { + "$ref": "#/components/requestBodies/Users-Permissions-RoleRequest" + }, "responses": { "200": { - "description": "Returns a jwt token and user info", + "description": "Returns ok if the role was udpated", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-UserRegistration" + "type": "object", + "properties": { + "ok": { + "type": "string", + "enum": [ + true + ] + } + } } } } @@ -42100,35 +43552,26 @@ } } } - } - }, - "/auth/forgot-password": { - "post": { + }, + "delete": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Send rest password email", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string" - } - } - }, - "example": { - "email": "foo.bar@strapi.io" - } - } + "summary": "Delete a role", + "parameters": [ + { + "in": "path", + "name": "role", + "required": true, + "schema": { + "type": "string" + }, + "description": "role Id" } - }, + ], "responses": { "200": { - "description": "Returns ok", + "description": "Returns ok if the role was delete", "content": { "application/json": { "schema": { @@ -42158,46 +43601,35 @@ } } }, - "/auth/reset-password": { - "post": { + "/users": { + "get": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Rest user password", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "password": { - "type": "string" - }, - "passwordConfirmation": { - "type": "string" - }, - "code": { - "type": "string" - } - } - }, - "example": { - "password": "Test1234", - "passwordConfirmation": "Test1234", - "code": "zertyoaizndoianzodianzdonaizdoinaozdnia" - } - } - } - }, + "summary": "Get list of users", "responses": { "200": { - "description": "Returns a jwt token and user info", + "description": "Returns an array of users", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-UserRegistration" - } + "type": "array", + "items": { + "$ref": "#/components/schemas/Users-Permissions-User" + } + }, + "example": [ + { + "id": 9, + "username": "foao@strapi.io", + "email": "foao@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-06-01T18:32:35.211Z", + "updatedAt": "2022-06-01T18:32:35.217Z" + } + ] } } }, @@ -42212,14 +43644,12 @@ } } } - } - }, - "/auth/change-password": { + }, "post": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Update user's own password", + "summary": "Create a user", "requestBody": { "required": true, "content": { @@ -42227,32 +43657,67 @@ "schema": { "type": "object", "required": [ - "password", - "currentPassword", - "passwordConfirmation" + "username", + "email", + "password" ], "properties": { - "password": { + "email": { "type": "string" }, - "currentPassword": { + "username": { "type": "string" }, - "passwordConfirmation": { + "password": { "type": "string" } } + }, + "example": { + "username": "foo", + "email": "foo@strapi.io", + "password": "foo-password" } } } }, "responses": { - "200": { - "description": "Returns a jwt token and user info", + "201": { + "description": "Returns created user info", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-UserRegistration" + "allOf": [ + { + "$ref": "#/components/schemas/Users-Permissions-User" + }, + { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/Users-Permissions-Role" + } + } + } + ] + }, + "example": { + "id": 1, + "username": "foo", + "email": "foo@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-05-19T17:35:35.096Z", + "role": { + "id": 1, + "name": "X", + "description": "Default role given to authenticated user.", + "type": "authenticated", + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-06-04T07:11:59.551Z" + } } } } @@ -42270,25 +43735,43 @@ } } }, - "/auth/email-confirmation": { + "/users/{id}": { "get": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" ], - "summary": "Confirm user email", + "summary": "Get a user", "parameters": [ { - "in": "query", - "name": "confirmation", + "in": "path", + "name": "id", + "required": true, "schema": { "type": "string" }, - "description": "confirmation token received by email" + "description": "user Id" } ], "responses": { - "301": { - "description": "Redirects to the configure email confirmation redirect url" + "200": { + "description": "Returns a user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Users-Permissions-User" + }, + "example": { + "id": 1, + "username": "foo", + "email": "foo@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-05-19T17:35:35.096Z" + } + } + } }, "default": { "description": "Error", @@ -42301,46 +43784,90 @@ } } } - } - }, - "/auth/send-email-confirmation": { - "post": { + }, + "put": { "tags": [ - "Users-Permissions - Auth" + "Users-Permissions - Users & Roles" + ], + "summary": "Update a user", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + }, + "description": "user Id" + } ], - "summary": "Send confirmation email", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "username", + "email", + "password" + ], "properties": { "email": { "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" } } + }, + "example": { + "username": "foo", + "email": "foo@strapi.io", + "password": "foo-password" } } } }, "responses": { "200": { - "description": "Returns email and boolean to confirm email was sent", + "description": "Returns updated user info", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "email": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/Users-Permissions-User" }, - "sent": { - "type": "string", - "enum": [ - true - ] + { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/Users-Permissions-Role" + } + } } + ] + }, + "example": { + "id": 1, + "username": "foo", + "email": "foo@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-05-19T17:35:35.096Z", + "role": { + "id": 1, + "name": "X", + "description": "Default role given to authenticated user.", + "type": "authenticated", + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-06-04T07:11:59.551Z" } } } @@ -42357,62 +43884,84 @@ } } } - } - }, - "/users-permissions/permissions": { - "get": { + }, + "delete": { "tags": [ "Users-Permissions - Users & Roles" ], - "summary": "Get default generated permissions", + "summary": "Delete a user", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + }, + "description": "user Id" + } + ], "responses": { "200": { - "description": "Returns the permissions tree", + "description": "Returns deleted user info", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "permissions": { - "$ref": "#/components/schemas/Users-Permissions-PermissionsTree" + "allOf": [ + { + "$ref": "#/components/schemas/Users-Permissions-User" } - } + ] }, "example": { - "permissions": { - "api::content-type.content-type": { - "controllers": { - "controllerA": { - "find": { - "enabled": false, - "policy": "" - }, - "findOne": { - "enabled": false, - "policy": "" - }, - "create": { - "enabled": false, - "policy": "" - } - }, - "controllerB": { - "find": { - "enabled": false, - "policy": "" - }, - "findOne": { - "enabled": false, - "policy": "" - }, - "create": { - "enabled": false, - "policy": "" - } - } - } - } - } + "id": 1, + "username": "foo", + "email": "foo@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-05-19T17:35:35.096Z" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/users/me": { + "get": { + "tags": [ + "Users-Permissions - Users & Roles" + ], + "summary": "Get authenticated user info", + "responses": { + "200": { + "description": "Returns user info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Users-Permissions-User" + }, + "example": { + "id": 1, + "username": "foo", + "email": "foo@strapi.io", + "provider": "local", + "confirmed": false, + "blocked": false, + "createdAt": "2022-05-19T17:35:35.096Z", + "updatedAt": "2022-05-19T17:35:35.096Z" } } } @@ -42430,53 +43979,21 @@ } } }, - "/users-permissions/roles": { + "/users/count": { "get": { "tags": [ "Users-Permissions - Users & Roles" ], - "summary": "List roles", + "summary": "Get user count", "responses": { "200": { - "description": "Returns list of roles", + "description": "Returns a number", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "roles": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/Users-Permissions-Role" - }, - { - "type": "object", - "properties": { - "nb_users": { - "type": "number" - } - } - } - ] - } - } - } + "type": "number" }, - "example": { - "roles": [ - { - "id": 1, - "name": "Public", - "description": "Default role given to unauthenticated user.", - "type": "public", - "createdAt": "2022-05-19T17:35:35.097Z", - "updatedAt": "2022-05-31T16:05:36.603Z", - "nb_users": 0 - } - ] - } + "example": 1 } } }, @@ -42491,36 +44008,63 @@ } } } - }, - "post": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Create a role", - "requestBody": { - "$ref": "#/components/requestBodies/Users-Permissions-RoleRequest" - }, + } + }, + "/resources": { + "get": { "responses": { "200": { - "description": "Returns ok if the role was create", + "description": "OK", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "ok": { - "type": "string", - "enum": [ - true - ] - } - } + "$ref": "#/components/schemas/ResourceListResponse" } } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", "content": { "application/json": { "schema": { @@ -42529,65 +44073,130 @@ } } } - } - } - }, - "/users-permissions/roles/{id}": { - "get": { + }, "tags": [ - "Users-Permissions - Users & Roles" + "Resource" ], - "summary": "Get a role", "parameters": [ { - "in": "path", - "name": "id", - "required": true, + "name": "sort", + "in": "query", + "description": "Sort by attributes ascending (asc) or descending (desc)", + "deprecated": false, + "required": false, "schema": { "type": "string" - }, - "description": "role Id" - } - ], - "responses": { - "200": { - "description": "Returns the role", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/Users-Permissions-Role" - } - } - }, - "example": { - "role": { - "id": 1, - "name": "Public", - "description": "Default role given to unauthenticated user.", - "type": "public", - "createdAt": "2022-05-19T17:35:35.097Z", - "updatedAt": "2022-05-31T16:05:36.603Z", - "permissions": { - "api::content-type.content-type": { - "controllers": { - "controllerA": { - "find": { - "enabled": true - } - } - } - } - } - } + } + }, + { + "name": "pagination[withCount]", + "in": "query", + "description": "Return page/pageSize (default: true)", + "deprecated": false, + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pagination[page]", + "in": "query", + "description": "Page number (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[pageSize]", + "in": "query", + "description": "Page size (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[start]", + "in": "query", + "description": "Offset value (default: 0)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "pagination[limit]", + "in": "query", + "description": "Number of entities to return (default: 25)", + "deprecated": false, + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "in": "query", + "description": "Fields to return (ex: title,author)", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "populate", + "in": "query", + "description": "Relations to return", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "filters", + "in": "query", + "description": "Filters to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "object", + "additionalProperties": true + }, + "style": "deepObject" + }, + { + "name": "locale", + "in": "query", + "description": "Locale to apply", + "deprecated": false, + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "get/resources" + }, + "post": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceResponse" } } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -42595,51 +44204,19 @@ } } } - } - } - } - }, - "/users-permissions/roles/{role}": { - "put": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Update a role", - "parameters": [ - { - "in": "path", - "name": "role", - "required": true, - "schema": { - "type": "string" - }, - "description": "role Id" - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/Users-Permissions-RoleRequest" - }, - "responses": { - "200": { - "description": "Returns ok if the role was udpated", + }, + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "ok": { - "type": "string", - "enum": [ - true - ] - } - } + "$ref": "#/components/schemas/Error" } } } }, - "default": { - "description": "Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -42647,46 +44224,19 @@ } } } - } - } - }, - "delete": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Delete a role", - "parameters": [ - { - "in": "path", - "name": "role", - "required": true, - "schema": { - "type": "string" - }, - "description": "role Id" - } - ], - "responses": { - "200": { - "description": "Returns ok if the role was delete", + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "ok": { - "type": "string", - "enum": [ - true - ] - } - } + "$ref": "#/components/schemas/Error" } } } }, - "default": { - "description": "Error", + "500": { + "description": "Internal Server Error", "content": { "application/json": { "schema": { @@ -42695,43 +44245,39 @@ } } } + }, + "tags": [ + "Resource" + ], + "parameters": [], + "operationId": "post/resources", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceRequest" + } + } + } } } }, - "/users": { + "/resources/{id}": { "get": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Get list of users", "responses": { "200": { - "description": "Returns an array of users", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Users-Permissions-User" - } - }, - "example": [ - { - "id": 9, - "username": "foao@strapi.io", - "email": "foao@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-06-01T18:32:35.211Z", - "updatedAt": "2022-06-01T18:32:35.217Z" - } - ] + "$ref": "#/components/schemas/ResourceResponse" + } } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -42739,88 +44285,39 @@ } } } - } - } - }, - "post": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Create a user", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "username", - "email", - "password" - ], - "properties": { - "email": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" } - }, - "example": { - "username": "foo", - "email": "foo@strapi.io", - "password": "foo-password" } } - } - }, - "responses": { - "201": { - "description": "Returns created user info", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Users-Permissions-User" - }, - { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/Users-Permissions-Role" - } - } - } - ] - }, - "example": { - "id": 1, - "username": "foo", - "email": "foo@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-05-19T17:35:35.096Z", - "role": { - "id": 1, - "name": "X", - "description": "Default role given to authenticated user.", - "type": "authenticated", - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-06-04T07:11:59.551Z" - } + "$ref": "#/components/schemas/Error" } } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", "content": { "application/json": { "schema": { @@ -42829,49 +44326,38 @@ } } } - } - } - }, - "/users/{id}": { - "get": { + }, "tags": [ - "Users-Permissions - Users & Roles" + "Resource" ], - "summary": "Get a user", "parameters": [ { - "in": "path", "name": "id", + "in": "path", + "description": "", + "deprecated": false, "required": true, "schema": { - "type": "string" - }, - "description": "user Id" + "type": "number" + } } ], + "operationId": "get/resources/{id}" + }, + "put": { "responses": { "200": { - "description": "Returns a user", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-User" - }, - "example": { - "id": 1, - "username": "foo", - "email": "foo@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-05-19T17:35:35.096Z" + "$ref": "#/components/schemas/ResourceResponse" } } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -42879,99 +44365,39 @@ } } } - } - } - }, - "put": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Update a user", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "description": "user Id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "username", - "email", - "password" - ], - "properties": { - "email": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" } - }, - "example": { - "username": "foo", - "email": "foo@strapi.io", - "password": "foo-password" } } - } - }, - "responses": { - "200": { - "description": "Returns updated user info", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Users-Permissions-User" - }, - { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/Users-Permissions-Role" - } - } - } - ] - }, - "example": { - "id": 1, - "username": "foo", - "email": "foo@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-05-19T17:35:35.096Z", - "role": { - "id": 1, - "name": "X", - "description": "Default role given to authenticated user.", - "type": "authenticated", - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-06-04T07:11:59.551Z" - } + "$ref": "#/components/schemas/Error" } } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "500": { + "description": "Internal Server Error", "content": { "application/json": { "schema": { @@ -42980,51 +44406,49 @@ } } } - } - }, - "delete": { + }, "tags": [ - "Users-Permissions - Users & Roles" + "Resource" ], - "summary": "Delete a user", "parameters": [ { - "in": "path", "name": "id", + "in": "path", + "description": "", + "deprecated": false, "required": true, "schema": { - "type": "string" - }, - "description": "user Id" + "type": "number" + } } ], + "operationId": "put/resources/{id}", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceRequest" + } + } + } + } + }, + "delete": { "responses": { "200": { - "description": "Returns deleted user info", + "description": "OK", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Users-Permissions-User" - } - ] - }, - "example": { - "id": 1, - "username": "foo", - "email": "foo@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-05-19T17:35:35.096Z" + "type": "integer", + "format": "int64" } } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -43032,39 +44456,19 @@ } } } - } - } - } - }, - "/users/me": { - "get": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Get authenticated user info", - "responses": { - "200": { - "description": "Returns user info", + }, + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Users-Permissions-User" - }, - "example": { - "id": 1, - "username": "foo", - "email": "foo@strapi.io", - "provider": "local", - "confirmed": false, - "blocked": false, - "createdAt": "2022-05-19T17:35:35.096Z", - "updatedAt": "2022-05-19T17:35:35.096Z" + "$ref": "#/components/schemas/Error" } } } }, - "default": { - "description": "Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -43072,30 +44476,19 @@ } } } - } - } - } - }, - "/users/count": { - "get": { - "tags": [ - "Users-Permissions - Users & Roles" - ], - "summary": "Get user count", - "responses": { - "200": { - "description": "Returns a number", + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "type": "number" - }, - "example": 1 + "$ref": "#/components/schemas/Error" + } } } }, - "default": { - "description": "Error", + "500": { + "description": "Internal Server Error", "content": { "application/json": { "schema": { @@ -43104,7 +44497,23 @@ } } } - } + }, + "tags": [ + "Resource" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "deprecated": false, + "required": true, + "schema": { + "type": "number" + } + } + ], + "operationId": "delete/resources/{id}" } } }, diff --git a/src/gen/types.ts b/src/gen/types.ts index 8a824f9..4ce292e 100644 --- a/src/gen/types.ts +++ b/src/gen/types.ts @@ -937,6 +937,15 @@ export interface paths { }; }; }; + "/resources": { + get: operations["get/resources"]; + post: operations["post/resources"]; + }; + "/resources/{id}": { + get: operations["get/resources/{id}"]; + put: operations["put/resources/{id}"]; + delete: operations["delete/resources/{id}"]; + }; } export type webhooks = Record; @@ -11357,243 +11366,542 @@ export interface components { }; }; }; - }; - responses: never; - parameters: never; - requestBodies: { - "Users-Permissions-RoleRequest": { - content: { - /** - * @example { - * "name": "foo", - * "description": "role foo", - * "permissions": { - * "api::content-type.content-type": { - * "controllers": { - * "controllerA": { - * "find": { - * "enabled": true - * } - * } - * } - * } - * } - * } - */ - "application/json": { - name?: string; - description?: string; - type?: string; - permissions?: components["schemas"]["Users-Permissions-PermissionsTree"]; - }; - }; - }; - }; - headers: never; - pathItems: never; -} - -export type $defs = Record; - -export type external = Record; - -export interface operations { - - "get/affiliates": { - parameters: { - query?: { - /** @description Sort by attributes ascending (asc) or descending (desc) */ - sort?: string; - /** @description Return page/pageSize (default: true) */ - "pagination[withCount]"?: boolean; - /** @description Page number (default: 0) */ - "pagination[page]"?: number; - /** @description Page size (default: 25) */ - "pagination[pageSize]"?: number; - /** @description Offset value (default: 0) */ - "pagination[start]"?: number; - /** @description Number of entities to return (default: 25) */ - "pagination[limit]"?: number; - /** @description Fields to return (ex: title,author) */ - fields?: string; - /** @description Relations to return */ - populate?: string; - /** @description Filters to apply */ - filters?: { - [key: string]: unknown; - }; - /** @description Locale to apply */ - locale?: string; - }; - }; - responses: { - /** @description OK */ - 200: { - content: { - "application/json": components["schemas"]["AffiliateListResponse"]; - }; - }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Forbidden */ - 403: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Not Found */ - 404: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Internal Server Error */ - 500: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - "post/affiliates": { - requestBody: { - content: { - "application/json": components["schemas"]["AffiliateRequest"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: { - "application/json": components["schemas"]["AffiliateResponse"]; - }; - }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Forbidden */ - 403: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Not Found */ - 404: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Internal Server Error */ - 500: { - content: { - "application/json": components["schemas"]["Error"]; - }; + ResourceRequest: { + data: { + title?: string; + description: string; + slug?: string; + /** @example string or id */ + cover?: number | string; + categories?: (number | string)[]; + blocks?: (components["schemas"]["SharedMediaComponent"] | components["schemas"]["SharedQuoteComponent"] | components["schemas"]["SharedRichTextComponent"] | components["schemas"]["SharedSliderComponent"] | components["schemas"]["SharedVideoEmbedComponent"])[]; + /** @example string or id */ + authorsBio?: number | string; + seo?: components["schemas"]["SharedSeoComponent"]; + tags?: (number | string)[]; + featured: boolean; + /** Format: date-time */ + publishDate?: string; + publishDateVisible: boolean; }; }; - }; - "get/affiliates/{id}": { - parameters: { - path: { - id: number; - }; + ResourceListResponseDataItem: { + id?: number; + attributes?: components["schemas"]["Resource"]; }; - responses: { - /** @description OK */ - 200: { - content: { - "application/json": components["schemas"]["AffiliateResponse"]; - }; - }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Forbidden */ - 403: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Not Found */ - 404: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Internal Server Error */ - 500: { - content: { - "application/json": components["schemas"]["Error"]; + ResourceListResponse: { + data?: components["schemas"]["ResourceListResponseDataItem"][]; + meta?: { + pagination?: { + page?: number; + pageSize?: number; + pageCount?: number; + total?: number; }; }; }; - }; - "put/affiliates/{id}": { - parameters: { - path: { - id: number; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["AffiliateRequest"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: { - "application/json": components["schemas"]["AffiliateResponse"]; - }; - }; - /** @description Bad Request */ - 400: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Forbidden */ - 403: { - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - /** @description Not Found */ - 404: { - content: { + Resource: { + title?: string; + description: string; + slug?: string; + cover?: { + data?: { + id?: number; + attributes?: { + name?: string; + alternativeText?: string; + caption?: string; + width?: number; + height?: number; + formats?: unknown; + hash?: string; + ext?: string; + mime?: string; + /** Format: float */ + size?: number; + url?: string; + previewUrl?: string; + provider?: string; + provider_metadata?: unknown; + related?: { + data?: { + id?: number; + attributes?: Record; + }[]; + }; + folder?: { + data?: { + id?: number; + attributes?: { + name?: string; + pathId?: number; + parent?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + children?: { + data?: { + id?: number; + attributes?: Record; + }[]; + }; + files?: { + data?: { + id?: number; + attributes?: { + name?: string; + alternativeText?: string; + caption?: string; + width?: number; + height?: number; + formats?: unknown; + hash?: string; + ext?: string; + mime?: string; + /** Format: float */ + size?: number; + url?: string; + previewUrl?: string; + provider?: string; + provider_metadata?: unknown; + related?: { + data?: { + id?: number; + attributes?: Record; + }[]; + }; + folder?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + folderPath?: string; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: { + firstname?: string; + lastname?: string; + username?: string; + /** Format: email */ + email?: string; + resetPasswordToken?: string; + registrationToken?: string; + isActive?: boolean; + roles?: { + data?: { + id?: number; + attributes?: { + name?: string; + code?: string; + description?: string; + users?: { + data?: { + id?: number; + attributes?: Record; + }[]; + }; + permissions?: { + data?: { + id?: number; + attributes?: { + action?: string; + actionParameters?: unknown; + subject?: string; + properties?: unknown; + conditions?: unknown; + role?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }[]; + }; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }[]; + }; + blocked?: boolean; + preferedLanguage?: string; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }[]; + }; + path?: string; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }; + }; + folderPath?: string; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + }; + }; + }; + blocks?: (components["schemas"]["SharedMediaComponent"] | components["schemas"]["SharedQuoteComponent"] | components["schemas"]["SharedRichTextComponent"] | components["schemas"]["SharedSliderComponent"] | components["schemas"]["SharedVideoEmbedComponent"])[]; + seo?: components["schemas"]["SharedSeoComponent"]; + /** Format: date-time */ + publishDate?: string; + publishDateVisible: boolean; + /** Format: date-time */ + createdAt?: string; + /** Format: date-time */ + updatedAt?: string; + /** Format: date-time */ + publishedAt?: string; + createdBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + updatedBy?: { + data?: { + id?: number; + attributes?: Record; + }; + }; + /** @description URL segment grouping programmatic content (e.g. tokens, eips) */ + campaign: string; + }; + ResourceResponseDataObject: { + id?: number; + attributes?: components["schemas"]["Resource"]; + }; + ResourceResponse: { + data?: components["schemas"]["ResourceResponseDataObject"]; + meta?: Record; + }; + }; + responses: never; + parameters: never; + requestBodies: { + "Users-Permissions-RoleRequest": { + content: { + /** + * @example { + * "name": "foo", + * "description": "role foo", + * "permissions": { + * "api::content-type.content-type": { + * "controllers": { + * "controllerA": { + * "find": { + * "enabled": true + * } + * } + * } + * } + * } + * } + */ + "application/json": { + name?: string; + description?: string; + type?: string; + permissions?: components["schemas"]["Users-Permissions-PermissionsTree"]; + }; + }; + }; + }; + headers: never; + pathItems: never; +} + +export type $defs = Record; + +export type external = Record; + +export interface operations { + + "get/affiliates": { + parameters: { + query?: { + /** @description Sort by attributes ascending (asc) or descending (desc) */ + sort?: string; + /** @description Return page/pageSize (default: true) */ + "pagination[withCount]"?: boolean; + /** @description Page number (default: 0) */ + "pagination[page]"?: number; + /** @description Page size (default: 25) */ + "pagination[pageSize]"?: number; + /** @description Offset value (default: 0) */ + "pagination[start]"?: number; + /** @description Number of entities to return (default: 25) */ + "pagination[limit]"?: number; + /** @description Fields to return (ex: title,author) */ + fields?: string; + /** @description Relations to return */ + populate?: string; + /** @description Filters to apply */ + filters?: { + [key: string]: unknown; + }; + /** @description Locale to apply */ + locale?: string; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["AffiliateListResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "post/affiliates": { + requestBody: { + content: { + "application/json": components["schemas"]["AffiliateRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["AffiliateResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "get/affiliates/{id}": { + parameters: { + path: { + id: number; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["AffiliateResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "put/affiliates/{id}": { + parameters: { + path: { + id: number; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["AffiliateRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["AffiliateResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { "application/json": components["schemas"]["Error"]; }; }; @@ -17448,4 +17756,255 @@ export interface operations { }; }; }; + "get/resources": { + parameters: { + query?: { + /** @description Sort by attributes ascending (asc) or descending (desc) */ + sort?: string; + /** @description Return page/pageSize (default: true) */ + "pagination[withCount]"?: boolean; + /** @description Page number (default: 0) */ + "pagination[page]"?: number; + /** @description Page size (default: 25) */ + "pagination[pageSize]"?: number; + /** @description Offset value (default: 0) */ + "pagination[start]"?: number; + /** @description Number of entities to return (default: 25) */ + "pagination[limit]"?: number; + /** @description Fields to return (ex: title,author) */ + fields?: string; + /** @description Relations to return */ + populate?: string; + /** @description Filters to apply */ + filters?: { + [key: string]: unknown; + }; + /** @description Locale to apply */ + locale?: string; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["ResourceListResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "post/resources": { + requestBody: { + content: { + "application/json": components["schemas"]["ResourceRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["ResourceResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "get/resources/{id}": { + parameters: { + path: { + id: number; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["ResourceResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "put/resources/{id}": { + parameters: { + path: { + id: number; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ResourceRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["ResourceResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "delete/resources/{id}": { + parameters: { + path: { + id: number; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": number; + }; + }; + /** @description Bad Request */ + 400: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Forbidden */ + 403: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Not Found */ + 404: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + /** @description Internal Server Error */ + 500: { + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; } diff --git a/types/generated/contentTypes.d.ts b/types/generated/contentTypes.d.ts index 63fdea5..6722428 100644 --- a/types/generated/contentTypes.d.ts +++ b/types/generated/contentTypes.d.ts @@ -1126,6 +1126,59 @@ export interface ApiProductFeatureProductFeature extends Schema.CollectionType { }; } +export interface ApiResourceResource extends Schema.CollectionType { + collectionName: 'resources'; + info: { + description: 'Create programmatic or batch article content'; + displayName: 'Resource'; + pluralName: 'resources'; + singularName: 'resource'; + }; + options: { + draftAndPublish: true; + }; + attributes: { + blocks: Attribute.DynamicZone< + [ + 'shared.media', + 'shared.quote', + 'shared.rich-text', + 'shared.slider', + 'shared.video-embed' + ] + >; + campaign: Attribute.String & Attribute.Required; + cover: Attribute.Media<'images' | 'files' | 'videos'>; + createdAt: Attribute.DateTime; + createdBy: Attribute.Relation< + 'api::resource.resource', + 'oneToOne', + 'admin::user' + > & + Attribute.Private; + description: Attribute.Text & + Attribute.Required & + Attribute.SetMinMaxLength<{ + maxLength: 256; + }>; + publishDate: Attribute.DateTime; + publishDateVisible: Attribute.Boolean & + Attribute.Required & + Attribute.DefaultTo; + publishedAt: Attribute.DateTime; + seo: Attribute.Component<'shared.seo'>; + slug: Attribute.UID<'api::resource.resource', 'title'> & Attribute.Required; + title: Attribute.String & Attribute.Required; + updatedAt: Attribute.DateTime; + updatedBy: Attribute.Relation< + 'api::resource.resource', + 'oneToOne', + 'admin::user' + > & + Attribute.Private; + }; +} + export interface ApiRestrictedTokenListRestrictedTokenList extends Schema.CollectionType { collectionName: 'restricted_token_lists'; @@ -1835,6 +1888,7 @@ declare module '@strapi/types' { 'api::notifications-consumer.notifications-consumer': ApiNotificationsConsumerNotificationsConsumer; 'api::page.page': ApiPagePage; 'api::product-feature.product-feature': ApiProductFeatureProductFeature; + 'api::resource.resource': ApiResourceResource; 'api::restricted-token-list.restricted-token-list': ApiRestrictedTokenListRestrictedTokenList; 'api::solver-bonding-pool.solver-bonding-pool': ApiSolverBondingPoolSolverBondingPool; 'api::solver-network.solver-network': ApiSolverNetworkSolverNetwork;