Package io.micronaut.openapi.annotation

Annotation Interface OpenAPIExtraSchema

@Repeatable(OpenAPIExtraSchemas.class) @Retention(SOURCE) @Documented @Target({PACKAGE,TYPE}) public @interface OpenAPIExtraSchema
With this annotation, you can specify extra schemas (unused in endpoints or other schemas) to final specification file. By default, all unused schemas will be removed from the final OpenAPI specification file.
Since:
6.12.0

  • Element Details

    • value

      Class<?>[] value
      Returns:
      Schema classes to include in generated Open API.
      Default:
      {}

    • classes

      @AliasFor(member="value") Class<?>[] classes
      Returns:
      Schema classes to include in generated Open API.
      Default:
      {}

    • classNames

      @AliasFor(member="value") String[] classNames
      Returns:
      Schema classes to include in generated Open API.
      Default:
      {}

    • excludeClasses

      Class<?>[] excludeClasses
      Returns:
      Schema classes annotated by OpenAPIExtraSchema and should be excluded.
      Default:
      {}

    • excludeClassNames

      String[] excludeClassNames
      Returns:
      Schema classes annotated by OpenAPIExtraSchema and should be excluded.
      Default:
      {}

    • packages

      String[] packages
      Returns:
      packages with extra schemas should be included. NOTE: Currently you can't use wildcard to include subpackages. Need to set every package in list
      Default:
      {}

    • excludePackages

      String[] excludePackages
      Returns:
      packages with extra schemas should be excluded.
      Default:
      {}