Function toEndpointResponse

packages/axe-api/src/Builders/SwaggerBuilder.ts:249–299

(endpoint: IRouteDocumentation)

};

const toEndpointResponse = (endpoint: IRouteDocumentation) => {
  const response: any = {};

  if (ALLOWED_2XX_HANDLERS.includes(endpoint.handler)) {
    response["200"] = {
      ...to2XXResponse(endpoint),
      description: "OK",
    };
  }

  if (endpoint.handler === HandlerTypes.INSERT) {
    response["201"] = {
      ...to2XXResponse(endpoint),
      description: "Created",
    };
    response["400"] = {
      description: "Bad request",
      content: {
        "application/json": {
          schema: {
            $ref: `#/components/schemas/ValidationError`,
          },
        },
      },
    };
  }

  if (NO_CONTENT_HANDLERS.includes(endpoint.handler)) {
    response["204"] = {
      description: "No Content",
    };
  }

  if (
    POSSIBLE_404_HANDLERS.includes(endpoint.handler) ||
    endpoint.parentModel
  ) {
    response["404"] = {
      description: "Not Found",
      content: {
        "application/json": {
          schema: {
            $ref: `#/components/schemas/Error`,
          },
        },
      },
    };
  }

  return response;
};

const toFillableFieldProperties = (model: IModelService) => {
  const fields = model.instance.getFillableFields(HttpMethods.POST);