api-tools-0.9.0.0: DSL for generating API boilerplate and docs
Safe HaskellNone
LanguageHaskell2010

Data.API.Changes.Types

Synopsis

Changelog representation

data APIChangelog Source #

An API changelog, consisting of a list of versions with the changes from one version to the next. The versions must be in descending order (according to the Ord Version instance).

Constructors

ChangesUpTo VersionExtra [APIChange] APIChangelog

The changes from the previous version up to this version.

ChangesStart Version

The initial version

Instances

Instances details
Eq APIChangelog Source # 
Instance details

Defined in Data.API.Changes.Types

Show APIChangelog Source # 
Instance details

Defined in Data.API.Changes.Types

type MigrationTag = String Source #

Within the changelog, custom migrations are represented as strings, so we have less type-safety.

data VersionExtra Source #

Represents either a released version (with a version number) or the version under development, which is newer than any release

Constructors

Release Version 
DevVersion 

data UpdateTypePos Source #

Represents the positions in a type to apply an update

Instances

Instances details
Eq UpdateTypePos Source # 
Instance details

Defined in Data.API.Changes.Types

Show UpdateTypePos Source # 
Instance details

Defined in Data.API.Changes.Types

data UpdateDeclPos Source #

Represents the positions in a declaration to apply an update

Instances

Instances details
Eq UpdateDeclPos Source # 
Instance details

Defined in Data.API.Changes.Types

Show UpdateDeclPos Source # 
Instance details

Defined in Data.API.Changes.Types

data APITableChange Source #

Constructors

APIChange NormAPI APIChange (Map TypeName UpdateDeclPos)

An initial API, an APIChange and the positions in which to apply it

ValidateData NormAPI

Request to validate the dataset against the given API