Class SchemaDocumentProperties


  • public final class SchemaDocumentProperties
    extends Object
    Api Schema Document Properties.
    • Constructor Detail

      • SchemaDocumentProperties

        public SchemaDocumentProperties()
    • Method Detail

      • value

        public String value()
        Get the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
        Returns:
        the value value.
      • withValue

        public SchemaDocumentProperties withValue​(String value)
        Set the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
        Parameters:
        value - the value value to set.
        Returns:
        the SchemaDocumentProperties object itself.
      • definitions

        public Object definitions()
        Get the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
        Returns:
        the definitions value.
      • withDefinitions

        public SchemaDocumentProperties withDefinitions​(Object definitions)
        Set the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
        Parameters:
        definitions - the definitions value to set.
        Returns:
        the SchemaDocumentProperties object itself.
      • components

        public Object components()
        Get the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
        Returns:
        the components value.
      • withComponents

        public SchemaDocumentProperties withComponents​(Object components)
        Set the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
        Parameters:
        components - the components value to set.
        Returns:
        the SchemaDocumentProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.