Last updated

no-x-security-scheme-name-in-workflow

You must use scheme instead of schemeName when x-security is described on workflow level.

ArazzoCompatibility
1.x✅

API design principles

This is a Respect specific rule. Workflow does not have a direct connection to OpenAPI operation, so you can't reference schemeName inside x-security extension.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default: off.

An example configuration:

arazzoRules:
  no-x-security-scheme-name-in-workflow: error

Examples

Given the following configuration:

arazzoRules:
  no-x-security-scheme-name-in-workflow: error

Example of an entry:

workflows:
  - workflowId: workflowId
    x-security:
      - scheme:
          type: http
          scheme: basic
        values:
          username: test@example.com
          password: 123456
    steps:
      - stepId: step-without-openapi-operation-and-security-scheme-name
        x-operation:
          method: GET
          url: https://api.example.com/v1/users

Resources

 
Next page