Oracle Integration · API Governance Rules

Oracle Integration API Rules

Spectral linting rules defining API design standards and conventions for Oracle Integration.

36 Rules error 19 warn 11 info 6
View Rules File View on GitHub

Rule Categories

delete examples get info microcks no openapi operation parameter paths request response schema security servers tag

Rules

error
info-title-must-start-with-oracle
Info title must start with "Oracle Integration".
$.info.title
error
info-description-required
Info description is required and must be at least 50 characters.
$.info
error
info-version-required
Info version is required.
$.info
warn
info-contact-required
Info contact information is required.
$.info
warn
info-license-required
Info license information is required.
$.info
error
openapi-version-3
OpenAPI version must be 3.0.x.
$.openapi
error
servers-defined
At least one server must be defined.
$
error
servers-https-required
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-description-required
Each server must have a description.
$.servers[*]
info
paths-kebab-case
Path segments should use kebab-case or camelCase consistently.
$.paths
error
paths-no-trailing-slash
Paths must not have a trailing slash.
$.paths
error
paths-no-query-strings
Paths must not contain query strings.
$.paths
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with "Oracle Integration".
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
Operation IDs should use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
tag-description-required
Global tags should have descriptions.
$.tags[*]
warn
tag-title-case
Tag names should use Title Case.
$.tags[*].name
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must have a schema with a type.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-json-content
Request bodies should use application/json content type.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have a 2xx success response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should include a 401 Unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-properties-camelcase
Schema property names should use camelCase.
$.components.schemas[*].properties
error
schema-type-defined
Schemas must have a type defined.
$.components.schemas[*]
info
schema-description-recommended
Top-level schemas should have descriptions.
$.components.schemas[*].properties[*]
error
security-global-defined
Global security must be defined.
$
error
security-schemes-defined
Security schemes must be defined in components.
$.components
error
get-no-request-body
GET operations should not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings.
$.paths[*][get,post,put,patch,delete].description
info
examples-encouraged
Schema properties should include example values.
$.components.schemas[*].properties[*]
info
microcks-extension-recommended
Operations should include x-microcks-operation for mock server compatibility.
$.paths[*][get,post,put,patch,delete]

Spectral Ruleset

Raw ↑ 
rules:
  # ============================================================
  # INFO / METADATA
  # ============================================================
  info-title-must-start-with-oracle:
    description: Info title must start with "Oracle Integration".
    severity: error
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^Oracle Integration
  info-description-required:
    description: Info description is required and must be at least 50 characters.
    severity: error
    given: $.info
    then:
      field: description
      function: length
      functionOptions:
        min: 50
  info-version-required:
    description: Info version is required.
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  info-contact-required:
    description: Info contact information is required.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  info-license-required:
    description: Info license information is required.
    severity: warn
    given: $.info
    then:
      field: license
      function: truthy

  # ============================================================
  # OPENAPI VERSION
  # ============================================================
  openapi-version-3:
    description: OpenAPI version must be 3.0.x.
    severity: error
    given: $.openapi
    then:
      function: pattern
      functionOptions:
        match: ^3\.0\.\d+$

  # ============================================================
  # SERVERS
  # ============================================================
  servers-defined:
    description: At least one server must be defined.
    severity: error
    given: $
    then:
      field: servers
      function: length
      functionOptions:
        min: 1
  servers-https-required:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-description-required:
    description: Each server must have a description.
    severity: warn
    given: $.servers[*]
    then:
      field: description
      function: truthy

  # ============================================================
  # PATHS — NAMING CONVENTIONS
  # ============================================================
  paths-kebab-case:
    description: Path segments should use kebab-case or camelCase consistently.
    severity: info
    given: $.paths
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z][a-zA-Z0-9{}-]*)+$
  paths-no-trailing-slash:
    description: Paths must not have a trailing slash.
    severity: error
    given: $.paths
    then:
      function: pattern
      functionOptions:
        notMatch: '/$'
  paths-no-query-strings:
    description: Paths must not contain query strings.
    severity: error
    given: $.paths
    then:
      function: pattern
      functionOptions:
        notMatch: '\?'

  # ============================================================
  # OPERATIONS
  # ============================================================
  operation-summary-required:
    description: Every operation must have a summary.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with "Oracle Integration".
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^Oracle Integration
  operation-description-required:
    description: Every operation must have a description.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  operation-operationid-required:
    description: Every operation must have an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  operation-operationid-camelcase:
    description: Operation IDs should use camelCase.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: length
      functionOptions:
        min: 1

  # ============================================================
  # TAGS
  # ============================================================
  tag-description-required:
    description: Global tags should have descriptions.
    severity: info
    given: $.tags[*]
    then:
      field: description
      function: truthy
  tag-title-case:
    description: Tag names should use Title Case.
    severity: warn
    given: $.tags[*].name
    then:
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9]+([ ][A-Z][a-zA-Z0-9]+)*$

  # ============================================================
  # PARAMETERS
  # ============================================================
  parameter-description-required:
    description: Every parameter must have a description.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Every parameter must have a schema with a type.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: schema
      function: truthy

  # ============================================================
  # REQUEST BODIES
  # ============================================================
  request-body-json-content:
    description: Request bodies should use application/json content type.
    severity: info
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      field: application/json
      function: truthy

  # ============================================================
  # RESPONSES
  # ============================================================
  response-success-required:
    description: Every operation must have a 2xx success response.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['204']
  response-401-recommended:
    description: Operations should include a 401 Unauthorized response.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy
  response-description-required:
    description: Every response must have a description.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then:
      field: description
      function: truthy

  # ============================================================
  # SCHEMAS — PROPERTY NAMING
  # ============================================================
  schema-properties-camelcase:
    description: Schema property names should use camelCase.
    severity: warn
    given: $.components.schemas[*].properties
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  schema-type-defined:
    description: Schemas must have a type defined.
    severity: error
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy
  schema-description-recommended:
    description: Top-level schemas should have descriptions.
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy

  # ============================================================
  # SECURITY
  # ============================================================
  security-global-defined:
    description: Global security must be defined.
    severity: error
    given: $
    then:
      field: security
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined in components.
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy

  # ============================================================
  # HTTP METHOD CONVENTIONS
  # ============================================================
  get-no-request-body:
    description: GET operations should not have a request body.
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations should not have a request body.
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy

  # ============================================================
  # GENERAL QUALITY
  # ============================================================
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].description
    then:
      function: length
      functionOptions:
        min: 1
  examples-encouraged:
    description: Schema properties should include example values.
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: example
      function: truthy
  microcks-extension-recommended:
    description: Operations should include x-microcks-operation for mock server compatibility.
    severity: info
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: x-microcks-operation
      function: truthy