Function getSchemas

src/rest/scripts/utils/get-openapi-schemas.js:13–49

(directory = OPEN_API_RELEASES_DIR)

// directory in `github/github`
// You can also specify getting specific versions of schemas.
export async function getSchemas(directory = OPEN_API_RELEASES_DIR) {
  const openAPIConfigs = await readdir(directory)
  const unpublished = []
  const deprecated = []
  const currentReleases = []

  // The file content in the `github/github` repo is YAML before it is
  // bundled into JSON.
  for (const file of openAPIConfigs) {
    const fileBaseName = path.basename(file, '.yaml')
    const newFileName = `${fileBaseName}.deref.json`
    const content = await readFile(path.join(directory, file), 'utf8')
    const yamlContent = yaml.load(content)

    const isDeprecatedInDocs = !Object.keys(allVersions).find(
      (version) => allVersions[version].openApiVersionName === fileBaseName
    )
    if (!yamlContent.published) {
      unpublished.push(newFileName)
    }
    // If it's deprecated, it must have been published at some point in the past
    // This checks if the schema is deprecated in github/github and
    // github/docs-internal. Sometimes deprecating in github/github lags
    // behind deprecating in github/docs-internal a few days
    if (
      (yamlContent.deprecated && yamlContent.published) ||
      (isDeprecatedInDocs && yamlContent.published)
    ) {
      deprecated.push(newFileName)
    }
    if (!yamlContent.deprecated && !isDeprecatedInDocs && yamlContent.published) {
      currentReleases.push(newFileName)
    }
  }

  return { currentReleases, unpublished, deprecated }
}

export async function validateVersionsOptions(versions) {
  const schemas = await getSchemas()