aeson-schemas-1.2.0: src/Data/Aeson/Schema/Key.hs

{-|
Module      :  Data.Aeson.Schema.Key
Maintainer  :  Brandon Chinn <brandon@leapyear.io>
Stability   :  experimental
Portability :  portable

Defines a SchemaKey.
-}

module Data.Aeson.Schema.Key
  ( SchemaKey(..)
  , fromSchemaKey
  ) where

-- | A key in a JSON object schema.
data SchemaKey
  = NormalKey String
  | PhantomKey String
    -- ^ A key that doesn't actually exist in the object, but whose content should be parsed from
    -- the current object.
  deriving (Show)

fromSchemaKey :: SchemaKey -> String
fromSchemaKey (NormalKey key) = key
fromSchemaKey (PhantomKey key) = key