FAQ

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

    arazzo-info-summary


    Formats: Severity:

    arazzo-info-summary checks that the document’s info object has a summary.

    Why did this violation appear?

    info.summary is missing or empty.

    Bad example

    arazzo: 1.0.1
    info:
      title: Read a pet
      version: '1.0'
      description: Workflows for finding and reading pets from the pet store API.
    

    Good example

    arazzo: 1.0.1
    info:
      title: Read a pet
      version: '1.0'
      summary: Find and read pets.
      description: Workflows for finding and reading pets from the pet store API.
    

    How do I fix this violation?

    Add a short one-line summary. It’s a hint, so if you don’t want it, turn it off.