2021-08-19 16:49:33 +02:00
|
|
|
'use strict';
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
openapi: '3.0.0',
|
|
|
|
info: {
|
|
|
|
version: '1.0.0',
|
|
|
|
title: 'DOCUMENTATION',
|
|
|
|
description: '',
|
|
|
|
termsOfService: 'YOUR_TERMS_OF_SERVICE_URL',
|
|
|
|
contact: {
|
|
|
|
name: 'TEAM',
|
|
|
|
email: 'contact-email@something.io',
|
|
|
|
url: 'mywebsite.io',
|
|
|
|
},
|
|
|
|
license: {
|
|
|
|
name: 'Apache 2.0',
|
|
|
|
url: 'https://www.apache.org/licenses/LICENSE-2.0.html',
|
|
|
|
},
|
|
|
|
},
|
|
|
|
'x-strapi-config': {
|
|
|
|
path: '/documentation',
|
|
|
|
showGeneratedFiles: true,
|
|
|
|
generateDefaultResponse: true,
|
2022-04-01 17:42:15 +02:00
|
|
|
plugins: ['email', 'upload', 'users-permissions'],
|
2021-08-19 16:49:33 +02:00
|
|
|
},
|
2021-10-26 11:18:36 +02:00
|
|
|
servers: [],
|
2021-08-19 16:49:33 +02:00
|
|
|
externalDocs: {
|
|
|
|
description: 'Find out more',
|
2021-11-29 07:01:25 -08:00
|
|
|
url: 'https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html',
|
2021-08-19 16:49:33 +02:00
|
|
|
},
|
|
|
|
security: [
|
|
|
|
{
|
|
|
|
bearerAuth: [],
|
|
|
|
},
|
|
|
|
],
|
2021-09-02 11:25:24 +02:00
|
|
|
components: {
|
|
|
|
securitySchemes: {
|
|
|
|
bearerAuth: {
|
|
|
|
type: 'http',
|
|
|
|
scheme: 'bearer',
|
|
|
|
bearerFormat: 'JWT',
|
|
|
|
},
|
|
|
|
},
|
2022-03-17 16:54:37 +01:00
|
|
|
schemas: {
|
|
|
|
Error: {
|
|
|
|
type: 'object',
|
|
|
|
required: ['error'],
|
|
|
|
properties: {
|
|
|
|
data: {
|
|
|
|
nullable: true,
|
2022-05-17 10:22:33 +02:00
|
|
|
oneOf: [{ type: 'object' }, { type: 'array', items: [] }],
|
2022-03-17 16:54:37 +01:00
|
|
|
},
|
|
|
|
error: {
|
|
|
|
type: 'object',
|
|
|
|
properties: {
|
|
|
|
status: {
|
|
|
|
type: 'integer',
|
|
|
|
},
|
|
|
|
name: {
|
|
|
|
type: 'string',
|
|
|
|
},
|
|
|
|
message: {
|
|
|
|
type: 'string',
|
|
|
|
},
|
|
|
|
details: {
|
|
|
|
type: 'object',
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2021-09-02 11:25:24 +02:00
|
|
|
},
|
2021-08-19 16:49:33 +02:00
|
|
|
};
|