FAQ

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

    arazzo-info-description


    Formats: Severity:

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

    Why did this violation appear?

    info.description is missing or empty.

    Bad example

    arazzo: 1.0.1
    info:
      title: Read a pet
      version: '1.0'
    

    Good 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.
    

    How do I fix this violation?

    Describe what this set of workflows is for. Somebody (or some agent) is going to read it to decide whether this is the document they need.