Penn Medicine · API Governance Rules
Penn Medicine API Rules
Spectral linting rules defining API design standards and conventions for Penn Medicine.
4 Rules
error 2
warn 2
Rule Categories
penn
Rules
error
penn-medicine-server-url
All Penn Medicine API specs must reference the production FHIR R4 base URL.
$.servers[*].url
warn
penn-medicine-operation-summary-title-case
Operation summaries must use Title Case.
$.paths[*][get,post,put,patch,delete].summary
error
penn-medicine-smart-on-fhir-security
Every Penn Medicine spec must declare the smartOnFhir OAuth2 security scheme.
$.components.securitySchemes
warn
penn-medicine-canonical-tags
Operations must carry one of the canonical Penn Medicine tags.
$.paths[*][get,post,put,patch,delete].tags[*]