Function toRequestParameters

packages/axe-api/src/Builders/SwaggerBuilder.ts:337–510

(
  endpoint: IRouteDocumentation,
  modelService: IModelService,
)

};

const toRequestParameters = (
  endpoint: IRouteDocumentation,
  modelService: IModelService,
) => {
  const parameters: any = [
    {
      in: "header",
      name: "Accept-Language",
      schema: {
        type: "string",
        example: "en;q=0.8, de;q=0.7, *;q=0.5",
      },
      required: false,
    },
  ];

  if (endpoint.url.includes(":")) {
    const sections = endpoint.url
      .split("/")
      .filter((item) => item.includes(":"))
      .map((item) => item.replace(":", ""));

    for (const section of sections) {
      parameters.push({
        in: "path",
        name: section,
        required: true,
      });
    }
  }

  if (endpoint.handler === HandlerTypes.PAGINATE) {
    parameters.push(
      ...[
        {
          name: "page",
          in: "query",
          description: "The page number to list",
          required: false,
          schema: {
            type: "integer",
            default: 1,
          },
        },
        {
          name: "per_page",
          in: "query",
          description: "Number of records to list on a page",
          required: false,
          schema: {
            type: "integer",
            default: 10,
          },
        },
        {
          name: "sort",
          in: "query",
          description: "The field to sort the data (ASC: id, DESC: -id)",