Interface JsonSchemaMapper

  • All Known Implementing Classes:
    OpenApiJsonSchemaMapper

    public interface JsonSchemaMapper
    Updates a schema builder before converting a shape to a schema.
    • Method Detail

      • getOrder

        default byte getOrder()
        Gets the sort order of the plugin from -128 to 127.

        Plugins are applied according to this sort order. Lower values are executed before higher values (for example, -128 comes before 0, comes before 127). Plugins default to 0, which is the middle point between the minimum and maximum order values.

        Returns:
        Returns the sort order, defaulting to 0.
      • updateSchema

        Schema.Builder updateSchema​(Shape shape,
                                    Schema.Builder schemaBuilder,
                                    JsonSchemaConfig config)
        Updates a schema builder.
        Parameters:
        shape - Shape used for the conversion.
        schemaBuilder - Schema builder to update.
        config - JSON Schema config.
        Returns:
        Returns an updated schema builder.