Xero-OpenAPI/validator/spectral.yaml at b2837dd3d18da0b8d26f074d54209eaec063b632 · rpocklin/Xero-OpenAPI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
extends: ["spectral:oas", "./xero-spectral.yaml"]

rules:
  # Override default rules to be more lenient for existing Xero API specs

  # Re-enabled: operation-description (produces warnings only - acceptable for documentation improvement)
  # operation-description: off

  # Disabled: info-description (xero_accounting.yaml missing description)
  info-description: off

  # Disabled: operation-tag-defined (many APIs use undeclared tags)
  operation-tag-defined: off

  # Disabled: no-$ref-siblings (xero_accounting.yaml uses this pattern with type field)
  no-$ref-siblings: off

  # Disabled: example validation rules (legacy string examples would cause many errors)
  oas3-valid-media-example: off
  oas3-valid-schema-example: off

  # Re-enabled: oas3-unused-component (produces warnings only - helps identify unused schemas)
  # oas3-unused-component: off

  # Re-enabled: oas3-server-trailing-slash (produces warnings only - helps clean up URLs)
  # oas3-server-trailing-slash: off

  # Disabled: path-params (FileId/FolderId path conflicts in xero_files.yaml)
  path-params: off

  # Re-enabled: oas3-operation-security-defined (produces warnings only - helps identify security gaps)
  # oas3-operation-security-defined: off