FAQ

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

    asyncApiDocument


    asyncApiDocument is an AsyncAPI-specific function for vacuum rules.

    What does it validate?

    Emits document build errors collected from the AsyncAPI parser and resolver.

    Options

    The built-in document rules pass resolved to choose resolved or unresolved document validation.

    Result behavior

    Document validation errors are reported at the document root so they appear as normal lint results.

    Example ruleset configuration

    rules:
      example-asyncapidocument:
        description: Validate AsyncAPI document build errors.
        severity: error
        formats: [asyncapi3]
        given: $
        then:
          function: asyncApiDocument
    

    Used by


    View Function Source