Safe Haskell	None
Language	Haskell2010

Data.API.Changes.Types

Contents

Changelog representation

Synopsis

Changelog representation

type APIWithChangelog = (API, APIChangelog) Source #

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

Eq APIChangelog Source #
Methods (==) :: APIChangelog -> APIChangelog -> Bool # (/=) :: APIChangelog -> APIChangelog -> Bool #
Show APIChangelog Source #
Methods showsPrec :: Int -> APIChangelog -> ShowS # show :: APIChangelog -> String # showList :: [APIChangelog] -> ShowS #

data APIChange Source #

A single change within a changelog

Instances

Eq APIChange Source #
Methods (==) :: APIChange -> APIChange -> Bool # (/=) :: APIChange -> APIChange -> Bool #
Show APIChange Source #
Methods showsPrec :: Int -> APIChange -> ShowS # show :: APIChange -> String # showList :: [APIChange] -> ShowS #
PPLines APIChange Source #
Methods ppLines :: APIChange -> [String] Source #

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

Instances

Eq VersionExtra Source #
Methods (==) :: VersionExtra -> VersionExtra -> Bool # (/=) :: VersionExtra -> VersionExtra -> Bool #
Ord VersionExtra Source #
Methods compare :: VersionExtra -> VersionExtra -> Ordering # (<) :: VersionExtra -> VersionExtra -> Bool # (<=) :: VersionExtra -> VersionExtra -> Bool # (>) :: VersionExtra -> VersionExtra -> Bool # (>=) :: VersionExtra -> VersionExtra -> Bool # max :: VersionExtra -> VersionExtra -> VersionExtra # min :: VersionExtra -> VersionExtra -> VersionExtra #
Show VersionExtra Source #
Methods showsPrec :: Int -> VersionExtra -> ShowS # show :: VersionExtra -> String # showList :: [VersionExtra] -> ShowS #
PP VersionExtra Source #
Methods pp :: VersionExtra -> String Source #

showVersionExtra :: VersionExtra -> String Source #

data UpdateTypePos Source #

Represents the positions in a type to apply an update

Constructors

UpdateList UpdateTypePos
UpdateMaybe UpdateTypePos
UpdateNamed TypeName

Instances

Eq UpdateTypePos Source #
Methods (==) :: UpdateTypePos -> UpdateTypePos -> Bool # (/=) :: UpdateTypePos -> UpdateTypePos -> Bool #
Show UpdateTypePos Source #
Methods showsPrec :: Int -> UpdateTypePos -> ShowS # show :: UpdateTypePos -> String # showList :: [UpdateTypePos] -> ShowS #

data UpdateDeclPos Source #

Represents the positions in a declaration to apply an update

Constructors

UpdateHere (Maybe UpdateDeclPos)
UpdateRecord (Map FieldName (Maybe UpdateTypePos))
UpdateUnion (Map FieldName (Maybe UpdateTypePos))
UpdateType UpdateTypePos

Instances

Eq UpdateDeclPos Source #
Methods (==) :: UpdateDeclPos -> UpdateDeclPos -> Bool # (/=) :: UpdateDeclPos -> UpdateDeclPos -> Bool #
Show UpdateDeclPos Source #
Methods showsPrec :: Int -> UpdateDeclPos -> ShowS # show :: UpdateDeclPos -> String # showList :: [UpdateDeclPos] -> ShowS #

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

Instances

Eq APITableChange Source #
Methods (==) :: APITableChange -> APITableChange -> Bool # (/=) :: APITableChange -> APITableChange -> Bool #
Show APITableChange Source #
Methods showsPrec :: Int -> APITableChange -> ShowS # show :: APITableChange -> String # showList :: [APITableChange] -> ShowS #
PPLines APITableChange Source #
Methods ppLines :: APITableChange -> [String] Source #

ChAddType TypeName NormTypeDecl
ChDeleteType TypeName
ChRenameType TypeName TypeName
ChAddField TypeName FieldName APIType (Maybe DefaultValue)
ChDeleteField TypeName FieldName
ChRenameField TypeName FieldName FieldName
ChChangeField TypeName FieldName APIType MigrationTag
ChAddUnionAlt TypeName FieldName APIType
ChDeleteUnionAlt TypeName FieldName
ChRenameUnionAlt TypeName FieldName FieldName
ChAddEnumVal TypeName FieldName
ChDeleteEnumVal TypeName FieldName
ChRenameEnumVal TypeName FieldName FieldName
ChCustomType TypeName MigrationTag
ChCustomAll MigrationTag