docusaurus-graphql-plugin/src/converters/convertMutationToMarkdown.ts

Docusaurus plugin generating Markdown documentation from a GraphQL schema.

import { GraphQLField } from "graphql";
import { MarkdownConverterOptions } from "../types";
import { escapeSpecialCharacters } from "./parseMarkdown";
import { pushArguments } from "./pushArguments";

export function convertMutationToMarkdown(
  mutation: GraphQLField<any, any>,
  options: MarkdownConverterOptions
): string {
  const lines: string[] = [];

  lines.push(`## ${mutation.name}`, `\n\n`);

  const typeUrl = options.getTypePath(mutation.type);
  lines.push(
    `**Type:** ${
      typeUrl
        ? `[${mutation.type.toJSON()}](${typeUrl})`
        : mutation.type.toJSON()
    }`,
    `\n\n`
  );

  if (mutation.deprecationReason) {
    lines.push(
      `> Deprecated: ${escapeSpecialCharacters(mutation.deprecationReason)}`,
      `\n\n`
    );
  }

  lines.push(mutation.description || "", `\n\n`);

  if (mutation.args.length > 0) {
    pushArguments(lines, mutation.args, options);
  }

  return lines.join("");
}