Function getGHExample

components/lib/get-rest-code-samples.ts:104–154

(operation: Operation, codeSample: CodeSample)

    -fref,topic-branch=0,payload,{ "deploy": "migrate" }=1,description,Deploy request from hubot=2
*/
export function getGHExample(operation: Operation, codeSample: CodeSample) {
  const defaultAcceptHeader = getAcceptHeader(codeSample)
  const hostname = operation.serverUrl !== 'https://api.github.com' ? '--hostname HOSTNAME' : ''

  let requestPath = codeSample?.request?.parameters
    ? parseTemplate(operation.requestPath).expand(codeSample.request.parameters)
    : operation.requestPath

  const requiredQueryParams = getRequiredQueryParamsPath(operation, codeSample)
  requestPath += requiredQueryParams ? `?${requiredQueryParams}` : ''

  let requestBodyParams = ''
  // Most of the time the example body parameters have a name and value
  // and are included in an object. But, some cases are a single value
  // and the type is a string.
  const { bodyParameters } = codeSample.request
  if (bodyParameters) {
    if (typeof bodyParameters === 'object' && !Array.isArray(bodyParameters)) {
      const bodyParamValues = Object.values(codeSample.request.bodyParameters)
      // GitHub CLI does not support sending Objects and arrays using the -F or
      // -f flags. That support may be added in the future. It is possible to
      // use gh api --input to take a JSON object from standard input
      // constructed by jq and piped to gh api. However, we'll hold off on adding
      // that complexity for now.
      if (bodyParamValues.some((elem) => typeof elem === 'object')) {
        return undefined
      }
      requestBodyParams = Object.keys(codeSample.request.bodyParameters)
        .map((key) => {
          if (typeof codeSample.request.bodyParameters[key] === 'string') {
            return `-f ${key}='${codeSample.request.bodyParameters[key]}' `
          } else {
            return `-F ${key}=${codeSample.request.bodyParameters[key]} `
          }
        })
        .join('\\\n ')
    } else {
      requestBodyParams = `-f '${codeSample.request.bodyParameters}'`
    }
  }
  const args = [
    operation.verb !== 'get' && `--method ${operation.verb.toUpperCase()}`,
    `-H "Accept: ${defaultAcceptHeader}"`,
    hostname,
    requestPath,
    requestBodyParams,
  ].filter(Boolean)
  return `# GitHub CLI api\n# https://cli.github.com/manual/gh_api\n\ngh api \\\n  ${args.join(
    ' \\\n  '
  )}`
}

/*
  Generates an octokit.js example