function checkSchemaTypeAndFormat()

in packages/rulesets/src/spectral/functions/schema-type-and-format.ts [17:104]

• 79 lines of code
• 20 McCabe index (conditional complexity)

function checkSchemaTypeAndFormat(schema: Oas2Schema, options: any, { path }: { path: JsonPath }): IFunctionResult[] {
  if (schema === null || typeof schema !== "object") {
    return [] as IFunctionResult[]
  }

  const errors: IFunctionResult[] = []

  const stringFormats = [
    // OAS-defined formats
    "byte",
    "binary",
    "date",
    "date-time",
    "password",
    // Additional formats recognized by autorest
    "char",
    "time",
    "date-time-rfc1123",
    "date-time-rfc7231", // Support for https://github.com/Azure/autorest/issues/4740
    "duration",
    "uuid",
    "base64url",
    "url",
    "uri",
    "odata-query",
    "certificate",
  ]

  if (schema.type === "string") {
    if (schema.format) {
      if (!stringFormats.includes(schema.format)) {
        errors.push({
          message: `Schema with type: string has unrecognized format: ${schema.format}`,
          path: [...path, "format"],
        })
      }
    }
  } else if (schema.type === "integer") {
    if (schema.format) {
      if (!["int32", "int64", "unixtime"].includes(schema.format)) {
        errors.push({
          message: `Schema with type: integer has unrecognized format: ${schema.format}`,
          path: [...path, "format"],
        })
      }
    } else {
      errors.push({
        message: "Schema with type: integer should specify format",
        path,
      })
    }
  } else if (schema.type === "number") {
    if (schema.format) {
      if (!["float", "double", "decimal"].includes(schema.format)) {
        errors.push({
          message: `Schema with type: number has unrecognized format: ${schema.format}`,
          path: [...path, "format"],
        })
      }
    } else {
      errors.push({
        message: "Schema with type: number should specify format",
        path,
      })
    }
  } else if (schema.type === "boolean") {
    if (schema.format) {
      errors.push({
        message: "Schema with type: boolean should not specify format",
        path: [...path, "format"],
      })
    }
  } else if (schema.properties && typeof schema.properties === "object") {
    // eslint-disable-next-line no-restricted-syntax
    for (const [key, value] of Object.entries(schema.properties)) {
      errors.push(...checkSchemaTypeAndFormat(value, options, { path: [...path, "properties", key] }))
    }
  }

  if (schema.allOf && Array.isArray(schema.allOf)) {
    // eslint-disable-next-line no-restricted-syntax
    for (const [index, value] of schema.allOf.entries()) {
      errors.push(...checkSchemaTypeAndFormat(value, options, { path: [...path, "allOf", index] }))
    }
  }

  return errors
}