spec-querystring-parameters

Enforces valid use of querystring parameters in a step.

Arazzo 1.1.0 adds the querystring parameter location, which passes the whole query string of a request as one value. A request has one query string, so a step cannot send two of them, or send one together with separate query parameters.

This rule checks the parameters of each step together with the parameters of its workflow, and reports:

• A second parameter with in: querystring.
• A parameter with in: query used together with a parameter with in: querystring.

A step parameter replaces the workflow parameter with the same name and in, so the rule does not count the replaced one. The rule skips a step that uses workflowId, because its parameters are the inputs of that workflow.

An example configuration:

rules:
  spec-querystring-parameters: error

Given the following configuration:

rules:
  spec-querystring-parameters: error

Example of an incorrect step that mixes querystring with query:

workflows:
  - workflowId: list-menu
    steps:
      - stepId: list-menu-items
        operationId: cafe-api.listMenuItems
        parameters:
          - in: querystring
            name: filters
            value: search=latte
          - in: query
            name: limit
            value: 1

Example of a correct step that passes the whole query string in one parameter:

workflows:
  - workflowId: list-menu
    steps:
      - stepId: list-menu-items
        operationId: cafe-api.listMenuItems
        parameters:
          - in: querystring
            name: filters
            value: search=latte&limit=1

• parameters-unique
• spec-querystring-parameters for OpenAPI

• Rule source