FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    arazzo-validation-incomplete


    Formats: Severity:

    arazzo-validation-incomplete is vacuum being honest with you. It appears when a check could not run, at the location that went unchecked.

    It does not mean the workflow is wrong. It means vacuum can’t tell you it’s right.

    Why did this violation appear?

    Something stopped a static check from finishing. The message starts with the name of the check.

    Cause Example message
    Lookup disabled linked-target: source document is unavailable
    XPath selector-syntax: XPath dialect xpath-31 has no static parser
    Runtime conditions criterion-syntax: final condition syntax depends on runtime expression substitution
    External schemas input-schema-reference: external JSON Schema resource is not supplied
    Structural errors semantics: structural validation failed

    Example

    arazzo: 1.0.1
    info:
      title: Read a pet
      version: '1.0'
      description: Retrieve a pet from the API.
      summary: Read a pet.
    sourceDescriptions:
      - name: api
        url: api.yaml
        type: openapi
    workflows:
      - workflowId: readPet
        description: Retrieve a pet.
        summary: Read a pet.
        steps:
          - stepId: read
            description: Call the read operation.
            operationId: $sourceDescriptions.api.read
            successCriteria:
              - context: $response.body
                condition: /pet/name
                type: xpath
    

    vacuum has no static XPath parser, so that condition goes unchecked and you get a warning on it.

    How do I fix this violation?

    It depends on the cause.

    • Lookup disabled? Allow it, or point --base at a local copy of the sources.
    • Structural errors? Fix the arazzo-structure results and this goes away.
    • XPath or runtime-dependent conditions? There is nothing to fix. If you’re happy, ignore the result or turn the rule off.

    Make it fail the build

    Warnings don’t fail a lint run by default. If an unchecked workflow isn’t good enough for your pipeline, either lower the fail severity:

    vacuum lint workflows.yaml --fail-severity warn

    Or promote this one rule to an error.

    extends: [[vacuum:arazzo, recommended]]
    rules:
      arazzo-validation-incomplete: error