YAML Schema

StackOne: 1.0.0
actions: [ ... ]
authentication: [ ... ]
baseUrl: 'https://api.provider.com'
concurrency: { ... }
documentation: { ... }
events: { ... }
forkedFrom: acme_hris
info: { ... }
mcp: { ... }
rateLimit: { ... }
releaseStage: ga
resources: 'https://api.provider.com/docs'
scopeDefinitions: { ... }

# Static URL
baseUrl: 'https://api.bamboohr.com/api/gateway.php'

# Dynamic URL with credentials:
baseUrl: 'https://api.bamboohr.com/api/gateway.php/${credentials.subdomain}/v1'

concurrency:
  mainMaxConcurrency: 5
  subPools:
    - subPoolKey: reports
      urlPattern: '/reports'
      maxConcurrency: 1

documentation:
  references:
    - title: API reference
      url: https://api.acme.com/docs
      description: Full REST API documentation.

info:
  title: Acme HRIS
  key: acme_hris
  version: 1.0.0
  description: HRIS connector for Acme covering employees, departments, and time-off.
  assets:
    icon: https://stackone-logos.com/api/acme/filled/png

rateLimit:
  mainRatelimit: 10
  subPools:
    - subPoolKey: search
      urlPattern: '/search'
      rateLimit: 2
  mappedRateLimitErrors:
    - errorStatus: 429
      errorMessage: Too Many Requests
      retryAfterPath: "$['retry-after']"
      retryAfterUnit: seconds

scopeDefinitions:
  employees:read:
    description: Read employee data
  employees:write:
    description: Create and update employee records
    includes: employees:read