packages feed

cachix-api 1.14.0 → 1.15.0

raw patch · 6 files changed

+58/−2 lines, 6 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

+ Cachix.API.Pins: type API = "api" :> "v1" :> CachixAuth :> "cache" :> Capture "name" Text :> "pin" :> Get '[JSON] [Pin]
+ Cachix.Types.Pin: Pin :: Text -> UTCTime -> Keep -> PinRevision -> Pin
+ Cachix.Types.Pin: [createdOn] :: Pin -> UTCTime
+ Cachix.Types.Pin: [keep] :: Pin -> Keep
+ Cachix.Types.Pin: [lastRevision] :: Pin -> PinRevision
+ Cachix.Types.Pin: [name] :: Pin -> Text
+ Cachix.Types.Pin: data Pin
+ Cachix.Types.Pin: instance Control.DeepSeq.NFData Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance Data.Aeson.Types.FromJSON.FromJSON Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance Data.Aeson.Types.ToJSON.ToJSON Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance Data.OpenApi.Internal.Schema.ToSchema Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance Data.Swagger.Internal.Schema.ToSchema Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance GHC.Classes.Eq Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance GHC.Generics.Generic Cachix.Types.Pin.Pin
+ Cachix.Types.Pin: instance GHC.Show.Show Cachix.Types.Pin.Pin
+ Cachix.Types.PinCreate: instance Control.DeepSeq.NFData Cachix.Types.PinCreate.Keep
+ Cachix.Types.PinRevision: PinRevision :: Text -> Integer -> UTCTime -> [Text] -> Bool -> PinRevision
+ Cachix.Types.PinRevision: [artifacts] :: PinRevision -> [Text]
+ Cachix.Types.PinRevision: [createdOn] :: PinRevision -> UTCTime
+ Cachix.Types.PinRevision: [orphaned] :: PinRevision -> Bool
+ Cachix.Types.PinRevision: [revision] :: PinRevision -> Integer
+ Cachix.Types.PinRevision: [storePath] :: PinRevision -> Text
+ Cachix.Types.PinRevision: data PinRevision
+ Cachix.Types.PinRevision: instance Control.DeepSeq.NFData Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance Data.Aeson.Types.FromJSON.FromJSON Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance Data.Aeson.Types.ToJSON.ToJSON Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance Data.OpenApi.Internal.Schema.ToSchema Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance Data.Swagger.Internal.Schema.ToSchema Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance GHC.Classes.Eq Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance GHC.Generics.Generic Cachix.Types.PinRevision.PinRevision
+ Cachix.Types.PinRevision: instance GHC.Show.Show Cachix.Types.PinRevision.PinRevision

Files

CHANGELOG.md view
@@ -7,6 +7,10 @@  ## [Unreleased] +## [1.15.0] - 2026-11-16++- Add pin metadata types and a client definition for the existing pin listing endpoint.+ ## [1.14.0] - 2026-11-05  ### Added
cachix-api.cabal view
@@ -1,6 +1,6 @@ cabal-version:   2.2 name:            cachix-api-version:         1.14.0+version:         1.15.0 synopsis:        Servant HTTP API specification for https://cachix.org homepage:        https://github.com/cachix/cachix#readme bug-reports:     https://github.com/cachix/cachix/issues@@ -71,6 +71,7 @@     Cachix.API.Deploy.V1     Cachix.API.Deploy.V2     Cachix.API.Error+    Cachix.API.Pins     Cachix.API.Signing     Cachix.API.WebSocket.Client     Cachix.API.WebSocketSubprotocol@@ -89,7 +90,9 @@     Cachix.Types.NarInfoHash     Cachix.Types.NixCacheInfo     Cachix.Types.Permission+    Cachix.Types.Pin     Cachix.Types.PinCreate+    Cachix.Types.PinRevision     Cachix.Types.Servant     Cachix.Types.Session     Cachix.Types.SigningKeyCreate
+ src/Cachix/API/Pins.hs view
@@ -0,0 +1,13 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE TypeOperators #-}++-- | Client definition for the existing server pin listing endpoint.+module Cachix.API.Pins (API) where++import Cachix.API (CachixAuth)+import Cachix.Types.Pin (Pin)+import Protolude+import Servant.API++type API =+  "api" :> "v1" :> CachixAuth :> "cache" :> Capture "name" Text :> "pin" :> Get '[JSON] [Pin]
+ src/Cachix/Types/Pin.hs view
@@ -0,0 +1,17 @@+module Cachix.Types.Pin where++import qualified Cachix.Types.PinCreate as PinCreate+import qualified Cachix.Types.PinRevision as PinRevision+import Data.Aeson (FromJSON, ToJSON)+import qualified Data.OpenApi as OpenApi+import qualified Data.Swagger as Swagger+import Data.Time (UTCTime)+import Protolude++data Pin = Pin+  { name :: Text,+    createdOn :: UTCTime,+    keep :: PinCreate.Keep,+    lastRevision :: PinRevision.PinRevision+  }+  deriving (Show, Eq, Generic, NFData, FromJSON, ToJSON, Swagger.ToSchema, OpenApi.ToSchema)
src/Cachix/Types/PinCreate.hs view
@@ -6,7 +6,7 @@ import Protolude  data Keep = Days Int | Revisions Int | Forever-  deriving (Show, Eq, Generic, ToJSON, FromJSON, OpenApi.ToSchema)+  deriving (Show, Eq, Generic, NFData, ToJSON, FromJSON, OpenApi.ToSchema)  -- to support Keep with data constructor with arguments instance Swagger.ToSchema Keep where
+ src/Cachix/Types/PinRevision.hs view
@@ -0,0 +1,19 @@+module Cachix.Types.PinRevision where++import Data.Aeson (FromJSON, ToJSON)+import qualified Data.OpenApi as OpenApi+import qualified Data.Swagger as Swagger+import Data.Time (UTCTime)+import Protolude++data PinRevision = PinRevision+  { storePath :: Text,+    revision :: Integer,+    createdOn :: UTCTime,+    artifacts :: [Text],+    -- | True when the narinfo for this revision's store_hash has been+    -- deleted (Clear, GC). storePath then lacks the human-readable name+    -- suffix and the artifact links will 404.+    orphaned :: Bool+  }+  deriving (Show, Eq, Generic, NFData, FromJSON, ToJSON, Swagger.ToSchema, OpenApi.ToSchema)