starting point for checking API state

[darrell-thobe-sp]

No description provided.

[github-actions]

Linting Report

Last updated: 8/20/2025, 8:33:22 AM

Found 21 total issues:

• ❌ Error: 21

OpenAPI Specs

❌ Invalid Ref (8)

• File: /packages/test-files/sailpoint-api.OpenAPI.yaml (7)

  • Line 86: #/ é, à, ö,/schemas/Pet does not exist
  • Line 100: #/components/schemas/ é, à, ö, does not exist
  • Line 138: #/components/ é, à, ö,/Pet does not exist
  • Line 314: #/components/ é, à, ö,/ApiResponse does not exist
  • Line 349: #/Test/schemas/Order does not exist
  • Line 352: #/components/Test/Order does not exist
  • Line 355: #/components/schemas/Test does not exist

• File: /packages/test-files/v2024/paths/account.yaml (1)

  • Line 32: ENOENT: no such file or directory, open /home/runner/work/api-linter/api-linter/packages/test-files/v2024/responses/InvalidReference.yaml

❌ Paths Must Not Reference Documents Outside Of Their Version (2)

• File: /packages/test-files/v2024/paths/account.yaml (2)

  • Line 28: Rule 405: Referenced document beta/schemas/Account.yaml is outside the allowed version folder v2024: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#405
  • Line 66: Rule 405: Referenced document beta/schemas/BaseCommonDto.yaml is outside the allowed version folder v2024: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#405

❌ Root Tags Must Be In Alphabetical Order (1)

• File: /packages/test-files/sailpoint-api.OpenAPI.yaml (1)

  • Line 23: Rule 403: Tags must be in alphabetical order: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#403

Gateway

❌ Gateway Route Additional Versions Must Be Valid (1)

• File: /packages/test-files/sp-gateway-routes.yaml (1)

  • Line 8: Invalid value specified for additionalVersion. Must be beta or v3.

❌ Gateway Route Api State Documented (1)

• File: /packages/test-files/sp-gateway-routes.yaml (1)

  • Line 27: /accounts: Marked as public-preview but all methods are public in 2024

❌ Gateway Route Must Have Path In Order (1)

• File: /packages/test-files/sp-gateway-routes.yaml (1)

  • Line 2: Route with path "/access-request-test" and id "access-request-test" is at position 0 but should be at position "2" where route with id "identities" and path "/identities" is located"

❌ Gateway Route Must Have Required Properties (3)

• File: /packages/test-files/sp-gateway-routes.yaml (3)

  • Line 3: Mandatory properties id, path and service must be specified
  • Line 19: Mandatory properties id, path and service must be specified
  • Line 27: Mandatory properties id, path and service must be specified

❌ Gateway Route Must Have Valid Version Start (2)

• File: /packages/test-files/sp-gateway-routes.yaml (2)

  • Line 3: versionStart must be a number
  • Line 3: versionStart must be 0 or higher than 2024

❌ Gateway Route Must Have Version Start In Order (2)

• File: /packages/test-files/sp-gateway-routes.yaml (2)

  • Line 21: versioned apis must be specified above non-versioned apis
  • Line 29: versioned apis must be specified above non-versioned apis