Function getRequestExamples

src/rest/scripts/utils/create-rest-examples.js:129–218

(operation)

  }
*/
export function getRequestExamples(operation) {
  const requestExamples = []
  const parameterExamples = getParameterExamples(operation)

  // When no request body or parameters are defined, we create a generic
  // request example. Not all operations have request bodies or parameters,
  // but we always want to show at least an example with the path.
  if (!operation.requestBody && Object.keys(parameterExamples).length === 0) {
    return [
      {
        key: DEFAULT_EXAMPLE_KEY,
        request: {
          description: DEFAULT_EXAMPLE_DESCRIPTION,
          acceptHeader: DEFAULT_ACCEPT_HEADER,
        },
      },
    ]
  }

  // When no request body exists, we create an example from the parameters
  if (!operation.requestBody) {
    return Object.keys(parameterExamples).map((key) => {
      return {
        key,
        request: {
          description: DEFAULT_EXAMPLE_DESCRIPTION,
          acceptHeader: DEFAULT_ACCEPT_HEADER,
          parameters: parameterExamples[key] || parameterExamples.default,
        },
      }
    })
  }

  // Requests can have multiple content types each with their own set of
  // examples.
  Object.keys(operation.requestBody.content).forEach((contentType) => {
    let examples = {}
    // This is a fallback to allow using the `example` property in
    // the schema. If we start to enforce using examples vs. example using
    // a linter, we can remove the check for `example`.
    // For now, we'll use the key default, which is a common default
    // example name in the OpenAPI schema.
    if (operation.requestBody.content[contentType].example) {
      examples = {
        default: {
          value: operation.requestBody.content[contentType].example,
        },
      }
    } else if (operation.requestBody.content[contentType].examples) {
      examples = operation.requestBody.content[contentType].examples
    } else {
      // Example for this content type doesn't exist so we'll try and create one
      requestExamples.push({
        key: DEFAULT_EXAMPLE_KEY,
        request: {
          contentType,
          description: DEFAULT_EXAMPLE_DESCRIPTION,
          acceptHeader: DEFAULT_ACCEPT_HEADER,