BJ's Wholesale Club · API Governance Rules

BJ's Wholesale Club API Rules

Spectral linting rules defining API design standards and conventions for BJ's Wholesale Club.

5 Rules warn 5
View Rules File View on GitHub

Rule Categories

bjs

Rules

warn
bjs-membership-number-required
Orders and membership verifications must include a membershipNumber
$.paths['/membership/verify'].post.requestBody.content['application/json'].schema
warn
bjs-order-status-enum
Order status must be one of the defined enum values
$.components.schemas.Order.properties.status
warn
bjs-product-price-positive
Product price must be defined as a number type
$.components.schemas.Product.properties.price
warn
bjs-api-key-security
All endpoints must use ApiKeyAuth security scheme
$.paths[*][*]
warn
bjs-operations-have-tags
All operations should have at least one tag
$.paths[*][*]