@Schema(
        name = "Liquibase Changelog",
        description = "This is the interface description to the changelog table as described in the liquibase documentation"
)
public interface ChangeLog {
    @Schema(
            title = "Id",
            description = "Value from the changeset id attribute.",
            required = true,
            maxLength = 255
    )
    @NotNull
    @Size(max = 255)
    /**
     * @return Value from the changeset id attribute.
     */
    String getId();

    /**
     * @return Value from the changeset author attribute.
     */
    @Schema(
            title = "Author",
            description = "Value from the changeset author attribute.",
            required = true,
            maxLength = 255
    )
    @Size(max = 255)
    String getAuthor();

    /**
     * Path to the changelog. This may be an absolute path or a relative path depending on how the changelog was passed
     * to Liquibase. For best results, it should be a relative path. The logicalFilePath attribute can be used on the
     * changelog or on individual changesets.
     *
     * @return Path to the changelog.
     */
    @Schema(
            title = "Path to the changelog",
            description = "Path to the changelog. This may be an absolute path or a relative path depending on how " +
                    "the changelog was passed to Liquibase. For best results, it should be a relative path. The " +
                    "logicalFilePath attribute can be used on the changelog or on individual changesets.",
            required = true,
            maxLength = 255
    )    @Size(max = 255)
    @NotNull
    String getFilename();

    /**
     * @return Date/time of when the changeset was executed. Used with {@link #getExecutionOrder()} to determine
     * rollback order.
     */
    @Schema(
            title = "Execution Date",
            description = "Date/time of when the changeset was executed. Used with {@link #getExecutionOrder()} to " +
                    "determine rollback order.",
            required = true,
            pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}(Z|(+|-)\\d{2}:\\d{2})$",
            maxLength = 255
    )
    @NotNull
    @Size(max = 255)
    OffsetDateTime getExecutionDate();

    /**
     * <p>Order that the changesets were executed. Used in addition to {@link #getExecutionDate()} to ensure order
     * is correct even when the databases datetime supports poor resolution.</p>
     *
     * <p><b>NOTE:</b> The values are only guaranteed to be increasing within an individual update run. There are times
     * where they will restart at zero.</p>
     *
     * @return Order that the changesets were executed.
     */
    @Schema(
            title = "Execution Order",
            description = "Order that the changesets were executed. Used in addition to the Execution Date to " +
                    "ensure order is correct even when the databases datetime supports poor resolution. NOTE: The " +
                    "values are only guaranteed to be increasing within an individual update run. There are times " +
                    "where they will restart at zero.",
            required = true,
            minimum = "0"
    )
    int getExecutionOrder();

    /**
     * Description of how the changeset was executed.
     *
     * @return Description of how the changeset was executed.
     */
    @NotNull
    ExecType getExecutionType();

    /**
     * Checksum of the changeset when it was executed. Used on each run to ensure there have been no unexpected changes
     * to changesets in the changelog file.
     *
     * @return Checksum of the changeset when it was executed.
     */
    @Schema(
            title = "MD5 Sum",
            description = "Checksum of the changeset when it was executed. Used on each run to ensure there have " +
                    "been no unexpected changes to changesets in the changelog file.",
            required = true,
            minLength = 32,
            maxLength = 35
    )
    @NotNull
    @Size(max = 35)
    String getMd5Sum();

    /**
     * @return Short auto-generated human-readable description of changeset
     */
    @Schema(
            title = "Description",
            description = "Short auto-generated human-readable description of changeset.",
            required = true,
            minLength = 1,
            maxLength = 255
    )
    @NotNull
    @Size(max = 255)
    String getDescription();

    /**
     * @return Value from the changeset comment attribute.
     */
    @Schema(
            title = "Comments",
            description = "Value from the changeset comment attribute.",
            required = true,
            maxLength = 255
    )
    @Size(max = 255)
    String getComments();

    /**
     * @return Tracks which changeset correspond to tag operations.
     */
    @Schema(
            title = "Tag",
            description = "Tracks which changeset correspond to tag operations.",
            maxLength = 255
    )
    @Size(max = 255)
    String getTag();

    /**
     * @return Version of Liquibase used to execute the changeset.
     */
    @Schema(
            title = "Liquibase Version",
            description = "Version of Liquibase used to execute the changeset.",
            required = true,
            maxLength = 255
    )
    @NotNull
    @Size(max = 20)
    String getLiquibaseVersion();

    /**
     * @return Context(s) used to execute the changeset.
     */
    @Schema(
            title = "Context(s)",
            description = "Context(s) used to execute the changeset.",
            maxLength = 255
    )
    @Size(max = 255)
    String getContexts();

    /**
     * @return Label(s) used to execute the changeset.
     */
    @Schema(
            title = "Label(s)",
            description = "Label(s) used to execute the changeset.",
            maxLength = 255
    )
    @Size(max = 255)
    String getLabels();

    /**
     * @return changesets deployed together will have the same unique identifier.
     */
    @Schema(
            title = "Deployment Id",
            description = "changesets deployed together will have the same unique identifier.",
            required = true,
            maxLength = 10
    )
    @NotNull
    @Size(max = 10)
    String getDeploymentId();


    /**
     * The liquibase execution type.
     *
     * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
     * @since 3.0.0  2023-01-19
     */
    @Schema(
            title = "Execution Type",
            description = "Description of how the changeset was executed.",
            required = true,
            enumeration = {"EXECUTED","FAILED","SKIPPED","RERAN","MARK_RAN"}
    )
    enum ExecType {
        EXECUTED, FAILED, SKIPPED, RERAN, MARK_RAN
    }
}