openapi-metadata/src/generators/operation.ts

Auto-Generate OpenAPI specifications from Typescript decorators

import type { OpenAPIV3 } from "openapi-types";
import type { Context } from "../context.js";
import type { OperationMetadata } from "../metadata/operation.js";
import { OperationBodyMetadataStorage } from "../metadata/operation-body.js";
import { generateOperationBody } from "./operation-body.js";
import { OperationParameterMetadataStorage } from "../metadata/operation-parameter.js";
import { generateOperationParameters } from "./operation-parameters.js";
import { OperationResponseMetadataStorage } from "../metadata/operation-response.js";
import { generateOperationResponse } from "./operation-response.js";
import { OperationSecurityMetadataStorage } from "../metadata/operation-security.js";

export async function generateOperation(
  context: Context,
  controller: Function,
  propertyKey: string,
  { path, methods, ...metadata }: OperationMetadata,
): Promise<OpenAPIV3.OperationObject> {
  const operation: OpenAPIV3.OperationObject = { ...metadata, responses: {} };

  const target = controller.prototype;

  const body = OperationBodyMetadataStorage.getMetadata(target, propertyKey);
  if (body) {
    operation.requestBody = await generateOperationBody(context, body);
  }

  const parameters = OperationParameterMetadataStorage.getMetadata(target, propertyKey, true);
  operation.parameters = [];
  for (const parameter of parameters) {
    operation.parameters.push(await generateOperationParameters(context, parameter));
  }

  const responses = OperationResponseMetadataStorage.getMetadata(target, propertyKey, true);
  for (const [status, response] of Object.entries(responses)) {
    operation.responses[status] = await generateOperationResponse(context, response);
  }

  const security = OperationSecurityMetadataStorage.getMetadata(target, propertyKey, true);

  // TODO: Check what the difference between `[{ auth1: {} }, {auth2: {} }]` and `[{ auth1: {}, auth2: {}}]`
  operation.security = Object.keys(security).length > 0 ? [security] : [];

  return operation;
}