ipa-spectral.yaml

extends:
  - ./rulesets/IPA-005.yaml
  - ./rulesets/IPA-102.yaml
  - ./rulesets/IPA-104.yaml
  - ./rulesets/IPA-105.yaml
  - ./rulesets/IPA-106.yaml
  - ./rulesets/IPA-107.yaml
  - ./rulesets/IPA-108.yaml
  - ./rulesets/IPA-109.yaml
  - ./rulesets/IPA-110.yaml
  - ./rulesets/IPA-112.yaml
  - ./rulesets/IPA-113.yaml
  - ./rulesets/IPA-114.yaml
  - ./rulesets/IPA-117.yaml
  - ./rulesets/IPA-118.yaml
  - ./rulesets/IPA-119.yaml
  - ./rulesets/IPA-121.yaml
  - ./rulesets/IPA-123.yaml
  - ./rulesets/IPA-124.yaml
  - ./rulesets/IPA-125.yaml
  - ./rulesets/IPA-126.yaml

overrides:
  - files:
      - '**#/components/schemas/DataLakeDatabaseDataSourceSettings'
      - '**#/components/schemas/DataLakeAtlasStoreReadPreference'
    rules:
      xgen-IPA-123-enum-values-must-be-upper-snake-case: 'off'
  - files:
      - '**#/components/schemas/DataLakeAtlasStoreInstance'
    rules:
      xgen-IPA-112-avoid-project-field-names: 'off'
  - files:
      - '**#/components/schemas/ClusterProviderSettings/properties/providerName' # dynamic field which can't be documented
      - '**#/components/schemas/DataLakeStoreSettings/properties/provider'
    rules:
      xgen-IPA-117-description: 'off'
  - files:
      - '**#/components/schemas/DataLakeAzureBlobStore' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/AdvancedClusterDescription/properties/mongoDBEmployeeAccessGrant' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/AtlasTenantClusterUpgradeRequest20240805/properties/mongoDBEmployeeAccessGrant' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/ClusterDescription20240805/properties/mongoDBEmployeeAccessGrant' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/LegacyAtlasCluster/properties/mongoDBEmployeeAccessGrant' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest/properties/mongoDBEmployeeAccessGrant' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/AdvancedAutoScalingSettings/properties/diskGB' # unable to document exceptions, to be covered by CLOUDP-308286
      - '**#/components/schemas/UserSecurity/properties/customerX509' # unable to document exceptions, to be covered by CLOUDP-308286
    rules:
      xgen-IPA-112-field-names-are-camel-case: 'off'
  - files:
      - '**#/components/schemas/DataLakeS3StoreSettings/allOf/1/properties/additionalStorageClasses' # unable to document exceptions, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseDataSourceSettings/properties/databaseRegex' # unable to document exceptions, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseDataSourceSettings/properties/collectionRegex' # unable to document exceptions, to be covered by CLOUDP-293178
    rules:
      xgen-IPA-117-description-should-not-use-inline-links: 'off'
  - files:
      - '**#/paths/~1api~1atlas~1v2~1unauth~1openapi~1versions' # external reference, to be covered by CLOUDP-309694
      - '**#/paths/~1api~1atlas~1v2~1openapi~1info' # external reference, to be covered by CLOUDP-309694
      - '**#/paths/~1rest~1unauth~1version' # external reference, to be covered by CLOUDP-309694
    rules:
      xgen-IPA-114-error-responses-refer-to-api-error: 'off'
  - files:
      - '**#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D~1clusters~1%7BclusterName%7D~1%7BclusterView%7D~1%7BdatabaseName%7D~1%7BcollectionName%7D~1collStats~1measurements' # reference to support future investigation - CLOUDP-310775
      - '**#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D~1processes~1%7BprocessId%7D~1%7BdatabaseName%7D~1%7BcollectionName%7D~1collStats~1measurements' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/HostMetricValue' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/DefaultEventViewForOrg' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AlertsThresholdInteger' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AppServiceMetricThreshold' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/FlexClusterMetricThreshold' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/HostMetricThreshold' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/ServerlessMetricThreshold' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/StreamProcessorMetricThreshold' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSKMSConfiguration/properties/region' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSKMSEARPrivateEndpoint/properties/regionName/oneOf/0' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSKMSEARPrivateEndpoint/properties/regionName/oneOf/1' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureKeyVaultEARPrivateEndpoint/properties/regionName/oneOf/0' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureKeyVaultEARPrivateEndpoint/properties/regionName/oneOf/1' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/EARPrivateEndpoint/properties/regionName/oneOf/0' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/EARPrivateEndpoint/properties/regionName/oneOf/1' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSHardwareSpec20240805/properties/instanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureHardwareSpec20240805/properties/instanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig20240805/properties/regionName/oneOf/0' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig20240805/properties/regionName/oneOf/1' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig20240805/properties/regionName/oneOf/2' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/ApiSearchDeploymentSpecView/properties/instanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSCloudProviderContainer/allOf/1/properties/regionName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureCloudProviderContainer/allOf/1/properties/region' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/GCPCloudProviderContainer/allOf/1/properties/regions/items' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/DatabasePrivilegeAction/properties/action' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSCloudProviderSettings/allOf/1/properties/instanceSizeName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSCloudProviderSettings/allOf/1/properties/regionName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSComputeAutoScaling/properties/maxInstanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSComputeAutoScaling/properties/minInstanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureCloudProviderSettings/allOf/1/properties/instanceSizeName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureCloudProviderSettings/allOf/1/properties/regionName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureComputeAutoScalingRules/properties/maxInstanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureComputeAutoScalingRules/properties/minInstanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudGCPProviderSettings/allOf/1/properties/regionName' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AWSHardwareSpec/properties/instanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/AzureHardwareSpec/properties/instanceSize' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig/properties/regionName/oneOf/0' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig/properties/regionName/oneOf/1' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/CloudRegionConfig/properties/regionName/oneOf/2' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/InvoiceLineItem/properties/sku' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/Collation/properties/locale' # reference to support future investigation - CLOUDP-310775
      - '**#/components/schemas/tokenFiltersnowballStemming/properties/stemmerName' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeS3StoreSettings/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDLSAWSStore/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDLSAzureStore/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeAzureBlobStore/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeGoogleCloudStorageStore/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDLSGCPStore/allOf/1/properties/region' # external field, to be covered by CLOUDP-293178
    rules:
      xgen-IPA-123-allowable-enum-values-should-not-exceed-20: 'off'
  - files:
      - '**#/components/schemas/DataLakeStorage/properties/databases' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeStorage/properties/stores' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseInstance/properties/collections' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseInstance/properties/views' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseCollection/properties/dataSources' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeDatabaseDataSourceSettings/properties/urls' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeS3StoreSettings/allOf/1/properties/additionalStorageClasses' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeAtlasStoreReadPreference/properties/tagSets' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeAtlasStoreReadPreference/properties/tagSets/items' # external field, to be covered by CLOUDP-293178
      - '**#/components/schemas/DataLakeHTTPStore/allOf/1/properties/urls' # external field, to be covered by CLOUDP-293178
    rules:
      xgen-IPA-124-array-max-items: 'off'