Unisys · API Governance Rules

Unisys — stealth rules

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

30 Rules error 13 warn 14 info 3
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's; it was most likely written by an API Evangelist pass before outputs were stamped.
View Rules File View on GitHub

Rule Categories

components get info isolation no openapi operation parameter paths request response schema security servers stealth

Rules

error
info-title-required
$.info
warn
info-title-contains-unisys
$.info.title
warn
info-description-required
$.info
error
info-version-required
$.info
error
openapi-version-3
$
error
servers-defined
$
error
servers-https-only
$.servers[*].url
warn
paths-no-trailing-slash
$.paths[*]~
info
stealth-paths-use-api-prefix
$.paths[*]~
error
operation-id-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-summary-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-title-case
$.paths[*][get,post,put,patch,delete,head,options].summary
warn
operation-description-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-description
$.paths[*][post,put,patch].requestBody
error
response-success-defined
$.paths[*][get,post,put,patch,delete]
error
response-description-required
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-401-unauthorized
$.paths[*][get,post,put,patch,delete]
info
response-400-bad-request
$.paths[*][post,put,patch]
error
security-schemes-defined
$.components
warn
security-basic-auth
$.components.securitySchemes[*]
error
get-no-request-body
$.paths[*].get
info
isolation-uses-post
$.paths[?(@property =~ /isolate|unisolate/)][*]
warn
schema-property-camel-case
$.components.schemas[*].properties[*]~
warn
schema-description-required
$.components.schemas[*]
warn
no-empty-descriptions
$..description
error
components-schemas-defined
$.components

Spectral Ruleset

Raw ↑ 
rules:

  # ─── INFO / METADATA ───────────────────────────────────────────────────────

  info-title-required:
    message: API info title is required
    severity: error
    given: $.info
    then:
      field: title
      function: truthy

  info-title-contains-unisys:
    message: API title should reference Unisys
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: "(?i)unisys"

  info-description-required:
    message: API info description is required
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy

  info-version-required:
    message: API info version is required
    severity: error
    given: $.info
    then:
      field: version
      function: truthy

  # ─── OPENAPI VERSION ────────────────────────────────────────────────────────

  openapi-version-3:
    message: OpenAPI version must be 3.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  # ─── SERVERS ────────────────────────────────────────────────────────────────

  servers-defined:
    message: At least one server must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy

  servers-https-only:
    message: Server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  # ─── PATHS — NAMING CONVENTIONS ─────────────────────────────────────────────

  paths-no-trailing-slash:
    message: Paths must not end with a trailing slash
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  stealth-paths-use-api-prefix:
    message: Unisys Stealth EcoAPI paths should begin with /api/
    severity: info
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: "^/api/"

  # ─── OPERATIONS ─────────────────────────────────────────────────────────────

  operation-id-required:
    message: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: operationId
      function: truthy

  operation-id-camel-case:
    message: operationId should use camelCase (Unisys convention)
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].operationId
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]+$"

  operation-summary-required:
    message: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: summary
      function: truthy

  operation-summary-title-case:
    message: Operation summaries should start with an uppercase letter
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].summary
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z]"

  operation-description-required:
    message: Every operation should have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: description
      function: truthy

  operation-tags-required:
    message: Every operation should have at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: tags
      function: truthy

  # ─── PARAMETERS ─────────────────────────────────────────────────────────────

  parameter-description-required:
    message: All parameters should have descriptions
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: description
      function: truthy

  parameter-schema-required:
    message: All parameters must have a schema
    severity: error
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: schema
      function: truthy

  # ─── REQUEST BODIES ──────────────────────────────────────────────────────────

  request-body-description:
    message: Request bodies should have a description
    severity: warn
    given: $.paths[*][post,put,patch].requestBody
    then:
      field: description
      function: truthy

  # ─── RESPONSES ───────────────────────────────────────────────────────────────

  response-success-defined:
    message: Every operation must define at least one 2xx success response
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses
      function: truthy

  response-description-required:
    message: All responses must have a description
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then:
      field: description
      function: truthy

  response-401-unauthorized:
    message: Protected operations should define 401 Unauthorized response
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses.401
      function: truthy

  response-400-bad-request:
    message: Write operations should define 400 Bad Request response
    severity: info
    given: $.paths[*][post,put,patch]
    then:
      field: responses.400
      function: truthy

  # ─── SECURITY ────────────────────────────────────────────────────────────────

  security-schemes-defined:
    message: Security schemes must be defined
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy

  security-basic-auth:
    message: Unisys Stealth EcoAPI uses HTTP Basic Authentication
    severity: warn
    given: $.components.securitySchemes[*]
    then:
      field: type
      function: enumeration
      functionOptions:
        values:
          - http

  # ─── HTTP METHOD CONVENTIONS ─────────────────────────────────────────────────

  get-no-request-body:
    message: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy

  isolation-uses-post:
    message: >-
      Isolation and un-isolation operations should use POST method
    severity: info
    given: $.paths[?(@property =~ /isolate|unisolate/)][*]
    then:
      function: truthy

  # ─── SCHEMAS — PROPERTY NAMING ───────────────────────────────────────────────

  schema-property-camel-case:
    message: Schema properties should use camelCase (Unisys convention)
    severity: warn
    given: $.components.schemas[*].properties[*]~
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  schema-description-required:
    message: Top-level component schemas should have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy

  # ─── GENERAL QUALITY ─────────────────────────────────────────────────────────

  no-empty-descriptions:
    message: Descriptions must not be empty strings
    severity: warn
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: ".+"

  components-schemas-defined:
    message: Components schemas section should be defined
    severity: error
    given: $.components
    then:
      field: schemas
      function: truthy

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset 
curl "https://apis.io/api/v1/rules/unisys-stealth-spectral-rules"
All spectral rules 
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.