shirren/json-api-lib

JSON API Spec serialization library for Haskell

json-api-lib's Issues

A collection of 1 ResourcefulEntity renders a singleton resource instead of a list.

toResourceData converts a list of 1 resourceful entities to a Singleton resource this can lead to odd behaviour in apps when requesting collections even if the collection contains a single item. The proposal is that we always send back a collection regardless of the number of items in the collection.

Simple function to construct a Resource with no Meta or Links

Links and Meta are optional when calling the mkDocument function. Can we have a simpler function to help with reasoning that just takes the instance of ToJSON.

`mkMeta` expects `Object` but gets `HashMap`

json-api-lib/src/Network/JSONApi/Meta.hs

Line 74 in 16064fb

mkMeta obj = Meta $ HM.singleton (typeName obj) (toJSON obj)

throws an error:

src/Network/JSONApi/Meta.hs:74:21: error:
    • Couldn't match type: HashMap
                             Text aeson-2.0.3.0:Data.Aeson.Types.Internal.Value
                     with: Data.Aeson.KeyMap.KeyMap
                             aeson-2.0.3.0:Data.Aeson.Types.Internal.Value
      Expected: Object
        Actual: HashMap
                  Text aeson-2.0.3.0:Data.Aeson.Types.Internal.Value
    • In the second argument of ‘($)’, namely
        ‘singleton (typeName obj) (toJSON obj)’
      In the expression: Meta $ singleton (typeName obj) (toJSON obj)
      In an equation for ‘mkMeta’:
          mkMeta obj = Meta $ singleton (typeName obj) (toJSON obj)
   |
74 | mkMeta obj = Meta $ HM.singleton (typeName obj) (toJSON obj)
   |                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

I made a fork and a fix (but I also had to modify cabal file).