Citrix · API Governance Rules

Citrix API Rules

Spectral linting rules defining API design standards and conventions for Citrix.

7 Rules error 4 warn 3

citrix

warn

citrix-info-contact

API info MUST contain a contact email or URL.

$.info

error

citrix-https-only

All Citrix API servers MUST use HTTPS.

$.servers[*].url

error

citrix-operation-id

Operations MUST have an operationId.

$.paths[*][get,post,put,delete,patch]

warn

citrix-tag-required

Operations MUST be tagged for product domain grouping.

$.paths[*][get,post,put,delete,patch].tags

error

citrix-security-required

API MUST define security schemes (OAuth 2.0 bearer for Citrix Cloud).

$.components.securitySchemes

error

citrix-server-url

API MUST declare at least one server URL.

$.servers

warn

citrix-customer-id-templating

Customer-scoped Citrix Cloud paths SHOULD use templated customerId.

$.paths