@strapi/plugin-documentation 4.2.0-beta.0 → 4.2.0-beta.3

package/server/services/utils/parametersOptions.json

@@ -1,134 +0,0 @@
-[
-  {
-    "name": "_limit",
-    "in": "query",
-    "required": false,
-    "description": "Maximum number of results possible",
-    "schema": {
-      "type": "integer"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_sort",
-    "in": "query",
-    "required": false,
-    "description": "Sort according to a specific field.",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_start",
-    "in": "query",
-    "required": false,
-    "description": "Skip a specific number of entries (especially useful for pagination)",
-    "schema": {
-      "type": "integer"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "=",
-    "in": "query",
-    "required": false,
-    "description": "Get entries that matches exactly your input",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_ne",
-    "in": "query",
-    "required": false,
-    "description": "Get records that are not equals to something",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_lt",
-    "in": "query",
-    "required": false,
-    "description": "Get record that are lower than a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_lte",
-    "in": "query",
-    "required": false,
-    "description": "Get records that are lower than or equal to a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_gt",
-    "in": "query",
-    "required": false,
-    "description": "Get records that are greater than a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_gte",
-    "in": "query",
-    "required": false,
-    "description": "Get records that are greater than  or equal a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_contains",
-    "in": "query",
-    "required": false,
-    "description": "Get records that contains a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_containss",
-    "in": "query",
-    "required": false,
-    "description": "Get records that contains (case sensitive) a value",
-    "schema": {
-      "type": "string"
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_in",
-    "in": "query",
-    "required": false,
-    "description": "Get records that matches any value in the array of values",
-    "schema": {
-      "type": "array",
-      "items": { "type": "string" }
-    },
-    "deprecated": false
-  },
-  {
-    "name": "_nin",
-    "in": "query",
-    "required": false,
-    "description": "Get records that doesn't match any value in the array of values",
-    "schema": {
-      "type": "array",
-      "items": { "type": "string" }
-    },
-    "deprecated": false
-  }
-]

package/server/services/utils/unknownComponent.json

@@ -1,11 +0,0 @@
-{
-  "components": {
-    "schemas": {
-      "Foo": {
-        "properties": {
-          "bar": "string"
-        }
-      }
-    }
-  }
-}

package/server/utils/builders/build-api-endpoint-path.js

@@ -1,180 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-const pathToRegexp = require('path-to-regexp');
-
-const queryParams = require('../query-params');
-const buildApiRequests = require('./build-api-requests');
-const buildApiResponses = require('./build-api-responses');
-
-/**
- * @description Parses a route with ':variable'
- *
- * @param {string} routePath - The route's path property
- * @returns {string}
- */
-const parsePathWithVariables = routePath => {
-  return pathToRegexp
-    .parse(routePath)
-    .map(token => {
-      if (_.isObject(token)) {
-        return token.prefix + '{' + token.name + '}';
-      }
-
-      return token;
-    })
-    .join('');
-};
-
-/**
- * @description Builds the required object for a path parameter
- *
- * @param {string} routePath - The route's path property
- *
- * @returns {object } Swagger path params object
- */
-const getPathParams = routePath => {
-  return pathToRegexp
-    .parse(routePath)
-    .filter(token => _.isObject(token))
-    .map(param => {
-      return {
-        name: param.name,
-        in: 'path',
-        description: '',
-        deprecated: false,
-        required: true,
-        schema: { type: 'string' },
-      };
-    });
-};
-
-/**
- *
- * @param {string} prefix - The route prefix
- * @param {string} path - The route path
- *
- * @returns {string}
- */
-const getPathWithPrefix = (prefix, path) => {
-  if (path.includes('localizations')) {
-    return path;
-  }
-
-  if (path.endsWith('/')) {
-    return prefix;
-  }
-
-  return prefix.concat(path);
-};
-
-/**
- *
- * @param {object} api - Information about the api
- * @param {object} api.routeInfo - The routes for a given api or plugin
- * @param {string} api.routeInfo.prefix - The prefix for all routes
- * @param {array}  api.routeInfo.routes - The routes for the current api
- * @param {object} api.attributes - The attributes for a given api or plugin
- * @param {string} api.tag - A descriptor for OpenAPI
- *
- * @returns {object}
- */
-const getPaths = ({ routeInfo, attributes, tag }) => {
-  const paths = routeInfo.routes.reduce((acc, route) => {
-    // TODO: Find a more reliable way to determine list of entities vs a single entity
-    const isListOfEntities = route.handler.split('.').pop() === 'find';
-    const methodVerb = route.method.toLowerCase();
-
-    const hasPathParams = route.path.includes('/:');
-    const pathWithPrefix = routeInfo.prefix
-      ? getPathWithPrefix(routeInfo.prefix, route.path)
-      : route.path;
-    const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;
-
-    const { responses } = buildApiResponses(attributes, route, isListOfEntities);
-
-    const swaggerConfig = {
-      responses,
-      tags: [_.upperFirst(tag)],
-      parameters: [],
-      operationId: `${methodVerb}${routePath}`,
-    };
-
-    if (isListOfEntities) {
-      swaggerConfig.parameters.push(...queryParams);
-    }
-
-    if (hasPathParams) {
-      const pathParams = getPathParams(route.path);
-      swaggerConfig.parameters.push(...pathParams);
-    }
-
-    if (['post', 'put'].includes(methodVerb)) {
-      const { requestBody } = buildApiRequests(attributes, route);
-
-      swaggerConfig.requestBody = requestBody;
-    }
-
-    _.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);
-
-    return acc;
-  }, {});
-
-  return { paths };
-};
-
-/**
- * @description - Builds the Swagger paths object for each api
- *
- * @param {object} api - Information about the current api
- * @property {string} api.name - The name of the api
- * @property {string} api.getter - The getter for the api (api | plugin)
- * @property {array} api.ctNames - The name of all contentTypes found on the api
- *
- * @returns {object}
- */
-module.exports = api => {
-  if (!api.ctNames.length && api.getter === 'plugin') {
-    // Set arbitrary attributes
-    const attributes = { foo: { type: 'string' } };
-    const routeInfo = strapi.plugin(api.name).routes['admin'];
-
-    const apiInfo = {
-      routeInfo,
-      attributes,
-      tag: api.name,
-    };
-
-    return getPaths(apiInfo);
-  }
-
-  // An api could have multiple contentTypes
-  let paths = {};
-  for (const contentTypeName of api.ctNames) {
-    // Get the attributes found on the api's contentType
-    const uid = `${api.getter}::${api.name}.${contentTypeName}`;
-    const ct = strapi.contentType(uid);
-    const attributes = ct.attributes;
-
-    // Get the routes for the current api
-    const routeInfo =
-      api.getter === 'plugin'
-        ? strapi.plugin(api.name).routes['content-api']
-        : strapi.api[api.name].routes[contentTypeName];
-
-    // Parse an identifier for OpenAPI tag if the api name and contentType name don't match
-    const tag = api.name === contentTypeName ? api.name : `${api.name} - ${contentTypeName}`;
-    const apiInfo = {
-      routeInfo,
-      attributes,
-      tag,
-    };
-
-    paths = {
-      ...paths,
-      ...getPaths(apiInfo).paths,
-    };
-  }
-
-  return { paths };
-};

package/server/utils/builders/build-api-requests.js

@@ -1,41 +0,0 @@
-'use strict';
-
-const cleanSchemaAttributes = require('../clean-schema-attributes');
-
-/**
- *
- * @param {object} attributes - The attributes found on a contentType
- * @param {object} route - The current route
- *
- * @returns The Swagger requestBody
- */
-module.exports = (attributes, route) => {
-  const requiredAttributes = Object.entries(attributes)
-    .filter(([, attribute]) => attribute.required)
-    .map(([attributeName, attribute]) => {
-      return { [attributeName]: attribute };
-    });
-
-  const requestAttributes =
-    route.method === 'POST' && requiredAttributes.length
-      ? Object.assign({}, ...requiredAttributes)
-      : attributes;
-
-  return {
-    requestBody: {
-      required: true,
-      content: {
-        'application/json': {
-          schema: {
-            properties: {
-              data: {
-                type: 'object',
-                properties: cleanSchemaAttributes(requestAttributes, { isRequest: true }),
-              },
-            },
-          },
-        },
-      },
-    },
-  };
-};

package/server/utils/builders/build-api-responses.js

@@ -1,109 +0,0 @@
-'use strict';
-
-const getSchemaData = require('../get-schema-data');
-const cleanSchemaAttributes = require('../clean-schema-attributes');
-const errorResponse = require('../error-response');
-
-/**
- *
- * @param {boolean} isSingleEntity - Checks for a single entity
- * @returns {object} The correctly formatted meta object
- */
-const getMeta = isListOfEntities => {
-  if (isListOfEntities) {
-    return {
-      type: 'object',
-      properties: {
-        pagination: {
-          properties: {
-            page: { type: 'integer' },
-            pageSize: { type: 'integer', minimum: 25 },
-            pageCount: { type: 'integer', maximum: 1 },
-            total: { type: 'integer' },
-          },
-        },
-      },
-    };
-  }
-
-  return { type: 'object' };
-};
-
-/**
- * @description - Builds the Swagger response object for a given api
- *
- * @param {object} attributes - The attributes found on a contentType
- * @param {object} route - The current route
- * @param {boolean} isListOfEntities - Checks for a list of entitities
- *
- * @returns The Swagger responses
- */
-module.exports = (attributes, route, isListOfEntities = false) => {
-  let schema;
-  if (route.method === 'DELETE') {
-    schema = {
-      type: 'integer',
-      format: 'int64',
-    };
-  } else {
-    schema = {
-      properties: {
-        data: getSchemaData(isListOfEntities, cleanSchemaAttributes(attributes)),
-        meta: getMeta(isListOfEntities),
-      },
-    };
-  }
-
-  return {
-    responses: {
-      '200': {
-        description: 'OK',
-        content: {
-          'application/json': {
-            schema,
-          },
-        },
-      },
-      '400': {
-        description: 'Bad Request',
-        content: {
-          'application/json': {
-            schema: errorResponse,
-          },
-        },
-      },
-      '401': {
-        description: 'Unauthorized',
-        content: {
-          'application/json': {
-            schema: errorResponse,
-          },
-        },
-      },
-      '403': {
-        description: 'Forbidden',
-        content: {
-          'application/json': {
-            schema: errorResponse,
-          },
-        },
-      },
-      '404': {
-        description: 'Not Found',
-        content: {
-          'application/json': {
-            schema: errorResponse,
-          },
-        },
-      },
-      '500': {
-        description: 'Internal Server Error',
-        content: {
-          'application/json': {
-            schema: errorResponse,
-          },
-        },
-      },
-    },
-  };
-};

package/server/utils/builders/index.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const buildApiResponses = require('./build-api-responses');
-const buildApiRequests = require('./build-api-requests');
-const builApiEndpointPath = require('./build-api-endpoint-path');
-
-module.exports = {
-  buildApiResponses,
-  buildApiRequests,
-  builApiEndpointPath,
-};

package/server/utils/error-response.js

@@ -1,22 +0,0 @@
-'use strict';
-
-module.exports = {
-  type: 'object',
-  required: ['error'],
-  properties: {
-    error: {
-      type: 'object',
-      properties: {
-        status: {
-          type: 'integer',
-        },
-        name: {
-          type: 'string',
-        },
-        message: {
-          type: 'string',
-        },
-      },
-    },
-  },
-};