-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Auto-generated IPFS HTTP API
--
-- Auto-generated IPFS HTTP API
@package ipfs-api
@version 0.1.0.0
module Network.IPFS.API.Types
-- | Workaround for the lack of client support of "servant-multipart"
data MultipartFormData
instance Servant.API.ContentTypes.Accept Network.IPFS.API.Types.MultipartFormData
instance Servant.API.ContentTypes.MimeRender Network.IPFS.API.Types.MultipartFormData Data.ByteString.Internal.ByteString
instance Servant.API.ContentTypes.MimeRender Network.IPFS.API.Types.MultipartFormData Data.ByteString.Lazy.Internal.ByteString
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText Data.ByteString.Internal.ByteString
-- | AUTOGENERATED
module Network.IPFS.API
-- | Add a file or directory to ipfs.
--
-- Response example:
--
--
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Bytes": "<int64>"
-- "Size": "<string>"
-- }
--
type ApiV0Add = "api" :> "v0" :> "add" :> ReqBody '[MultipartFormData] ByteString :> QueryParam "recursive" Bool :> QueryParam "quiet" Bool :> QueryParam "quieter" Bool :> QueryParam "silent" Bool :> QueryParam "progress" Bool :> QueryParam "trickle" Bool :> QueryParam "only-hash" Bool :> QueryParam "wrap-with-directory" Bool :> QueryParam "hidden" Bool :> QueryParam "chunker" Text :> QueryParam "pin" Bool :> QueryParam "raw-leaves" Bool :> QueryParam "nocopy" Bool :> QueryParam "fscache" Bool :> QueryParam "cid-version" Int :> QueryParam "hash" Text :> Post '[JSON] Value
-- | Show the current ledger for a peer.
--
-- Response example:
--
--
-- {
-- "Peer": "<string>"
-- "Value": "<float64>"
-- "Sent": "<uint64>"
-- "Recv": "<uint64>"
-- "Exchanged": "<uint64>"
-- }
--
type ApiV0BitswapLedger = "api" :> "v0" :> "bitswap" :> "ledger" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Trigger reprovider.
type ApiV0BitswapReprovide = "api" :> "v0" :> "bitswap" :> "reprovide" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Show some diagnostic information on the bitswap agent.
--
-- Response example:
--
--
-- {
-- "ProvideBufLen": "<int>"
-- "Wantlist": [
-- "<string>"
-- ]
-- "Peers": [
-- "<string>"
-- ]
-- "BlocksReceived": "<uint64>"
-- "DataReceived": "<uint64>"
-- "BlocksSent": "<uint64>"
-- "DataSent": "<uint64>"
-- "DupBlksReceived": "<uint64>"
-- "DupDataReceived": "<uint64>"
-- }
--
type ApiV0BitswapStat = "api" :> "v0" :> "bitswap" :> "stat" :> Post '[JSON] Value
-- | Remove a given block from your wantlist.
type ApiV0BitswapUnwant = "api" :> "v0" :> "bitswap" :> "unwant" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Show blocks currently on the wantlist.
--
-- Response example:
--
--
-- {
-- "Keys": [
-- "<string>"
-- ]
-- }
--
type ApiV0BitswapWantlist = "api" :> "v0" :> "bitswap" :> "wantlist" :> QueryParam "peer" Text :> Post '[JSON] Value
-- | Get a raw IPFS block.
type ApiV0BlockGet = "api" :> "v0" :> "block" :> "get" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Store input as an IPFS block.
--
-- Response example:
--
--
-- {
-- "Key": "<string>"
-- "Size": "<int>"
-- }
--
type ApiV0BlockPut = "api" :> "v0" :> "block" :> "put" :> ReqBody '[MultipartFormData] ByteString :> QueryParam "format" Text :> QueryParam "mhtype" Text :> QueryParam "mhlen" Int :> Post '[JSON] Value
-- | Remove IPFS block(s).
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Error": "<string>"
-- }
--
type ApiV0BlockRm = "api" :> "v0" :> "block" :> "rm" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "force" Bool :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Print information of a raw IPFS block.
--
-- Response example:
--
--
-- {
-- "Key": "<string>"
-- "Size": "<int>"
-- }
--
type ApiV0BlockStat = "api" :> "v0" :> "block" :> "stat" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Add default peers to the bootstrap list.
--
-- Response example:
--
--
-- {
-- "Peers": [
-- "<string>"
-- ]
-- }
--
type ApiV0BootstrapAddDefault = "api" :> "v0" :> "bootstrap" :> "add" :> "default" :> Post '[JSON] Value
-- | Show peers in the bootstrap list.
--
-- Response example:
--
--
-- {
-- "Peers": [
-- "<string>"
-- ]
-- }
--
type ApiV0BootstrapList = "api" :> "v0" :> "bootstrap" :> "list" :> Post '[JSON] Value
-- | Remove all peers from the bootstrap list.
--
-- Response example:
--
--
-- {
-- "Peers": [
-- "<string>"
-- ]
-- }
--
type ApiV0BootstrapRmAll = "api" :> "v0" :> "bootstrap" :> "rm" :> "all" :> Post '[JSON] Value
-- | Show IPFS object data.
type ApiV0Cat = "api" :> "v0" :> "cat" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "offset" Int :> QueryParam "length" Int :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List all available commands.
--
-- Response example:
--
--
-- {
-- "Name": "<string>"
-- "Subcommands": [
-- {
-- "Name": "<string>"
-- "Subcommands": [
-- {
-- "Name": "<string>"
-- "Subcommands": [
-- ...
-- ]
-- "Options": [
-- ...
-- ]
-- "showOpts": "<bool>"
-- }
-- ]
-- "Options": [
-- {
-- "Names": [
-- ...
-- ]
-- }
-- ]
-- "showOpts": "<bool>"
-- }
-- ]
-- "Options": [
-- {
-- "Names": [
-- "<string>"
-- ]
-- }
-- ]
-- "showOpts": "<bool>"
-- }
--
type ApiV0Commands = "api" :> "v0" :> "commands" :> QueryParam "flags" Bool :> Post '[JSON] Value
-- | Open the config file for editing in $EDITOR.
type ApiV0ConfigEdit = "api" :> "v0" :> "config" :> "edit" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Apply profile to config.
type ApiV0ConfigProfileApply = "api" :> "v0" :> "config" :> "profile" :> "apply" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Replace the config with file.
type ApiV0ConfigReplace = "api" :> "v0" :> "config" :> "replace" :> ReqBody '[MultipartFormData] ByteString :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Output config file contents.
type ApiV0ConfigShow = "api" :> "v0" :> "config" :> "show" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Get a dag node from ipfs.
type ApiV0DagGet = "api" :> "v0" :> "dag" :> "get" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Add a dag node to ipfs.
--
-- Response example:
--
--
-- {
-- "Cid": "<string>"
-- }
--
type ApiV0DagPut = "api" :> "v0" :> "dag" :> "put" :> ReqBody '[MultipartFormData] ByteString :> QueryParam "format" Text :> QueryParam "input-enc" Text :> QueryParam "pin" Bool :> QueryParam "hash" Text :> Post '[JSON] Value
-- | Resolve ipld block
--
-- Response example:
--
--
-- {
-- "Cid": "<string>"
-- "RemPath": "<string>"
-- }
--
type ApiV0DagResolve = "api" :> "v0" :> "dag" :> "resolve" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Query the DHT for all of the multiaddresses associated with a Peer ID.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtFindpeer = "api" :> "v0" :> "dht" :> "findpeer" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> Post '[JSON] Value
-- | Find peers in the DHT that can provide a specific value, given a key.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtFindprovs = "api" :> "v0" :> "dht" :> "findprovs" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> QueryParam "num-providers" Int :> Post '[JSON] Value
-- | Given a key, query the DHT for its best value.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtGet = "api" :> "v0" :> "dht" :> "get" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> Post '[JSON] Value
-- | Announce to the network that you are providing given values.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtProvide = "api" :> "v0" :> "dht" :> "provide" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> QueryParam "recursive" Bool :> Post '[JSON] Value
-- | Write a key/value pair to the DHT.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtPut = "api" :> "v0" :> "dht" :> "put" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> Post '[JSON] Value
-- | Find the closest Peer IDs to a given Peer ID by querying the DHT.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "Type": "<int>"
-- "Responses": [
-- {
-- "ID": "<string>"
-- "Addrs": [
-- "<object>"
-- ]
-- }
-- ]
-- "Extra": "<string>"
-- }
--
type ApiV0DhtQuery = "api" :> "v0" :> "dht" :> "query" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> Post '[JSON] Value
-- | Clear inactive requests from the log.
type ApiV0DiagCmdsClear = "api" :> "v0" :> "diag" :> "cmds" :> "clear" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Set how long to keep inactive requests in the log.
type ApiV0DiagCmdsSetTime = "api" :> "v0" :> "diag" :> "cmds" :> "set-time" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Print system diagnostic information.
type ApiV0DiagSys = "api" :> "v0" :> "diag" :> "sys" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Resolve DNS links.
--
-- Response example:
--
--
-- {
-- "Path": "<string>"
-- }
--
type ApiV0Dns = "api" :> "v0" :> "dns" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> Post '[JSON] Value
-- | List directory contents for Unix filesystem objects.
--
-- Response example:
--
--
-- {
-- "Arguments": {
-- "<string>": "<string>"
-- }
-- "Objects": {
-- "<string>": {
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- "Type": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- "Type": "<string>"
-- }
-- ]
-- }
-- }
-- }
--
type ApiV0FileLs = "api" :> "v0" :> "file" :> "ls" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Change the cid version or hash function of the root node of a given
-- path.
type ApiV0FilesChcid = "api" :> "v0" :> "files" :> "chcid" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "cid-version" Int :> QueryParam "hash" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Copy files into mfs.
type ApiV0FilesCp = "api" :> "v0" :> "files" :> "cp" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Flush a given path's data to disk.
type ApiV0FilesFlush = "api" :> "v0" :> "files" :> "flush" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List directories in the local mutable namespace.
--
-- Response example:
--
--
-- {
-- "Entries": [
-- {
-- "Name": "<string>"
-- "Type": "<int>"
-- "Size": "<int64>"
-- "Hash": "<string>"
-- }
-- ]
-- }
--
type ApiV0FilesLs = "api" :> "v0" :> "files" :> "ls" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "l" Bool :> Post '[JSON] Value
-- | Make directories.
type ApiV0FilesMkdir = "api" :> "v0" :> "files" :> "mkdir" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "parents" Bool :> QueryParam "cid-version" Int :> QueryParam "hash" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Move files.
type ApiV0FilesMv = "api" :> "v0" :> "files" :> "mv" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Read a file in a given mfs.
type ApiV0FilesRead = "api" :> "v0" :> "files" :> "read" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "offset" Int :> QueryParam "count" Int :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Remove a file.
type ApiV0FilesRm = "api" :> "v0" :> "files" :> "rm" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Display file status.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- "CumulativeSize": "<uint64>"
-- "Blocks": "<int>"
-- "Type": "<string>"
-- "WithLocality": "<bool>"
-- "Local": "<bool>"
-- "SizeLocal": "<uint64>"
-- }
--
type ApiV0FilesStat = "api" :> "v0" :> "files" :> "stat" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "format" Text :> QueryParam "hash" Bool :> QueryParam "size" Bool :> QueryParam "with-local" Bool :> Post '[JSON] Value
-- | Write to a mutable file in a given filesystem.
type ApiV0FilesWrite = "api" :> "v0" :> "files" :> "write" :> QueryParam' '[Required, Strict] "arg" Text :> ReqBody '[MultipartFormData] ByteString :> QueryParam "offset" Int :> QueryParam "create" Bool :> QueryParam "truncate" Bool :> QueryParam "count" Int :> QueryParam "raw-leaves" Bool :> QueryParam "cid-version" Int :> QueryParam "hash" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List blocks that are both in the filestore and standard block storage.
--
-- Response example:
--
--
-- {
-- "Ref": "<string>"
-- "Err": "<string>"
-- }
--
type ApiV0FilestoreDups = "api" :> "v0" :> "filestore" :> "dups" :> Post '[JSON] Value
-- | List objects in filestore.
--
-- Response example:
--
--
-- {
-- "Status": "<int32>"
-- "ErrorMsg": "<string>"
-- "Key": "<string>"
-- "FilePath": "<string>"
-- "Offset": "<uint64>"
-- "Size": "<uint64>"
-- }
--
type ApiV0FilestoreLs = "api" :> "v0" :> "filestore" :> "ls" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "file-order" Bool :> Post '[JSON] Value
-- | Verify objects in filestore.
--
-- Response example:
--
--
-- {
-- "Status": "<int32>"
-- "ErrorMsg": "<string>"
-- "Key": "<string>"
-- "FilePath": "<string>"
-- "Offset": "<uint64>"
-- "Size": "<uint64>"
-- }
--
type ApiV0FilestoreVerify = "api" :> "v0" :> "filestore" :> "verify" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "file-order" Bool :> Post '[JSON] Value
-- | Download IPFS objects.
type ApiV0Get = "api" :> "v0" :> "get" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "output" Text :> QueryParam "archive" Bool :> QueryParam "compress" Bool :> QueryParam "compression-level" Int :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Show ipfs node id info.
--
-- Response example:
--
--
-- {
-- "ID": "<string>"
-- "PublicKey": "<string>"
-- "Addresses": [
-- "<string>"
-- ]
-- "AgentVersion": "<string>"
-- "ProtocolVersion": "<string>"
-- }
--
type ApiV0Id = "api" :> "v0" :> "id" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "format" Text :> Post '[JSON] Value
-- | Create a new keypair
--
-- Response example:
--
--
-- {
-- "Name": "<string>"
-- "Id": "<string>"
-- }
--
type ApiV0KeyGen = "api" :> "v0" :> "key" :> "gen" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "type" Text :> QueryParam "size" Int :> Post '[JSON] Value
-- | List all local keypairs
--
-- Response example:
--
--
-- {
-- "Keys": [
-- {
-- "Name": "<string>"
-- "Id": "<string>"
-- }
-- ]
-- }
--
type ApiV0KeyList = "api" :> "v0" :> "key" :> "list" :> QueryParam "l" Bool :> Post '[JSON] Value
-- | Rename a keypair
--
-- Response example:
--
--
-- {
-- "Was": "<string>"
-- "Now": "<string>"
-- "Id": "<string>"
-- "Overwrite": "<bool>"
-- }
--
type ApiV0KeyRename = "api" :> "v0" :> "key" :> "rename" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "force" Bool :> Post '[JSON] Value
-- | Remove a keypair
--
-- Response example:
--
--
-- {
-- "Keys": [
-- {
-- "Name": "<string>"
-- "Id": "<string>"
-- }
-- ]
-- }
--
type ApiV0KeyRm = "api" :> "v0" :> "key" :> "rm" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "l" Bool :> Post '[JSON] Value
-- | Change the logging level.
--
-- Response example:
--
--
-- {
-- "Message": "<string>"
-- }
--
type ApiV0LogLevel = "api" :> "v0" :> "log" :> "level" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | List the logging subsystems.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0LogLs = "api" :> "v0" :> "log" :> "ls" :> Post '[JSON] Value
-- | Read the event log.
type ApiV0LogTail = "api" :> "v0" :> "log" :> "tail" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List directory contents for Unix filesystem objects.
--
-- Response example:
--
--
-- {
-- "Objects": [
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- "Type": "<int32>"
-- }
-- ]
-- }
-- ]
-- }
--
type ApiV0Ls = "api" :> "v0" :> "ls" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "headers" Bool :> QueryParam "resolve-type" Bool :> Post '[JSON] Value
-- | Mounts IPFS to the filesystem (read-only).
--
-- Response example:
--
--
-- {
-- "IPFS": "<string>"
-- "IPNS": "<string>"
-- "FuseAllowOther": "<bool>"
-- }
--
type ApiV0Mount = "api" :> "v0" :> "mount" :> QueryParam "ipfs-path" Text :> QueryParam "ipns-path" Text :> Post '[JSON] Value
-- | Publish IPNS names.
--
-- Response example:
--
--
-- {
-- "Name": "<string>"
-- "Value": "<string>"
-- }
--
type ApiV0NamePublish = "api" :> "v0" :> "name" :> "publish" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "resolve" Bool :> QueryParam "lifetime" Text :> QueryParam "ttl" Text :> QueryParam "key" Text :> Post '[JSON] Value
-- | Cancel a name subscription
--
-- Response example:
--
--
-- {
-- "Canceled": "<bool>"
-- }
--
type ApiV0NamePubsubCancel = "api" :> "v0" :> "name" :> "pubsub" :> "cancel" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Query the state of IPNS pubsub
--
-- Response example:
--
--
-- {
-- "Enabled": "<bool>"
-- }
--
type ApiV0NamePubsubState = "api" :> "v0" :> "name" :> "pubsub" :> "state" :> Post '[JSON] Value
-- | Show current name subscriptions
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0NamePubsubSubs = "api" :> "v0" :> "name" :> "pubsub" :> "subs" :> Post '[JSON] Value
-- | Resolve IPNS names.
--
-- Response example:
--
--
-- {
-- "Path": "<string>"
-- }
--
type ApiV0NameResolve = "api" :> "v0" :> "name" :> "resolve" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> QueryParam "nocache" Bool :> QueryParam "dht-record-count" Word :> QueryParam "dht-timeout" Text :> Post '[JSON] Value
-- | Output the raw bytes of an IPFS object.
type ApiV0ObjectData = "api" :> "v0" :> "object" :> "data" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Display the diff between two ipfs objects.
--
-- Response example:
--
--
-- {
-- "Changes": [
-- {
-- "Type": "<int>"
-- "Path": "<string>"
-- "Before": "<string>"
-- "After": "<string>"
-- }
-- ]
-- }
--
type ApiV0ObjectDiff = "api" :> "v0" :> "object" :> "diff" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "verbose" Bool :> Post '[JSON] Value
-- | Get and serialize the DAG node named by key.
--
-- Response example:
--
--
-- {
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- "Data": "<string>"
-- }
--
type ApiV0ObjectGet = "api" :> "v0" :> "object" :> "get" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Output the links pointed to by the specified object.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectLinks = "api" :> "v0" :> "object" :> "links" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "headers" Bool :> Post '[JSON] Value
-- | Create a new object from an ipfs template.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectNew = "api" :> "v0" :> "object" :> "new" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Add a link to a given object.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectPatchAddLink = "api" :> "v0" :> "object" :> "patch" :> "add-link" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "create" Bool :> Post '[JSON] Value
-- | Append data to the data segment of a dag node.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectPatchAppendData = "api" :> "v0" :> "object" :> "patch" :> "append-data" :> QueryParam' '[Required, Strict] "arg" Text :> ReqBody '[MultipartFormData] ByteString :> Post '[JSON] Value
-- | Remove a link from an object.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectPatchRmLink = "api" :> "v0" :> "object" :> "patch" :> "rm-link" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Set the data field of an IPFS object.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectPatchSetData = "api" :> "v0" :> "object" :> "patch" :> "set-data" :> QueryParam' '[Required, Strict] "arg" Text :> ReqBody '[MultipartFormData] ByteString :> Post '[JSON] Value
-- | Store input as a DAG object, print its key.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "Links": [
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Size": "<uint64>"
-- }
-- ]
-- }
--
type ApiV0ObjectPut = "api" :> "v0" :> "object" :> "put" :> ReqBody '[MultipartFormData] ByteString :> QueryParam "inputenc" Text :> QueryParam "datafieldenc" Text :> QueryParam "pin" Bool :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Get stats for the DAG node named by key.
--
-- Response example:
--
--
-- {
-- "Hash": "<string>"
-- "NumLinks": "<int>"
-- "BlockSize": "<int>"
-- "LinksSize": "<int>"
-- "DataSize": "<int>"
-- "CumulativeSize": "<int>"
-- }
--
type ApiV0ObjectStat = "api" :> "v0" :> "object" :> "stat" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Close active p2p listener.
type ApiV0P2pListenerClose = "api" :> "v0" :> "p2p" :> "listener" :> "close" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "all" Bool :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List active p2p listeners.
--
-- Response example:
--
--
-- {
-- "Listeners": [
-- {
-- "Protocol": "<string>"
-- "Address": "<string>"
-- }
-- ]
-- }
--
type ApiV0P2pListenerLs = "api" :> "v0" :> "p2p" :> "listener" :> "ls" :> QueryParam "headers" Bool :> Post '[JSON] Value
-- | Forward p2p connections to a network multiaddr.
type ApiV0P2pListenerOpen = "api" :> "v0" :> "p2p" :> "listener" :> "open" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Close active p2p stream.
type ApiV0P2pStreamClose = "api" :> "v0" :> "p2p" :> "stream" :> "close" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "all" Bool :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Dial to a p2p listener.
type ApiV0P2pStreamDial = "api" :> "v0" :> "p2p" :> "stream" :> "dial" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | List active p2p streams.
--
-- Response example:
--
--
-- {
-- "Streams": [
-- {
-- "HandlerID": "<string>"
-- "Protocol": "<string>"
-- "LocalPeer": "<string>"
-- "LocalAddress": "<string>"
-- "RemotePeer": "<string>"
-- "RemoteAddress": "<string>"
-- }
-- ]
-- }
--
type ApiV0P2pStreamLs = "api" :> "v0" :> "p2p" :> "stream" :> "ls" :> QueryParam "headers" Bool :> Post '[JSON] Value
-- | Pin objects to local storage.
--
-- Response example:
--
--
-- {
-- "Pins": [
-- "<string>"
-- ]
-- "Progress": "<int>"
-- }
--
type ApiV0PinAdd = "api" :> "v0" :> "pin" :> "add" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> QueryParam "progress" Bool :> Post '[JSON] Value
-- | List objects pinned to local storage.
--
-- Response example:
--
--
-- {
-- "Keys": {
-- "<string>": {
-- "Type": "<string>"
-- }
-- }
-- }
--
type ApiV0PinLs = "api" :> "v0" :> "pin" :> "ls" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "type" Text :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Remove pinned objects from local storage.
--
-- Response example:
--
--
-- {
-- "Pins": [
-- "<string>"
-- ]
-- }
--
type ApiV0PinRm = "api" :> "v0" :> "pin" :> "rm" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> Post '[JSON] Value
-- | Update a recursive pin
--
-- Response example:
--
--
-- {
-- "Pins": [
-- "<string>"
-- ]
-- }
--
type ApiV0PinUpdate = "api" :> "v0" :> "pin" :> "update" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "unpin" Bool :> Post '[JSON] Value
-- | Verify that recursive pins are complete.
--
-- Response example:
--
--
-- {
-- "Cid": "<string>"
-- "PinStatus": {
-- "Ok": "<bool>"
-- "BadNodes": [
-- {
-- "Cid": "<string>"
-- "Err": "<string>"
-- }
-- ]
-- }
-- }
--
type ApiV0PinVerify = "api" :> "v0" :> "pin" :> "verify" :> QueryParam "verbose" Bool :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Send echo request packets to IPFS hosts.
--
-- Response example:
--
--
-- {
-- "Success": "<bool>"
-- "Time": "<int64>"
-- "Text": "<string>"
-- }
--
type ApiV0Ping = "api" :> "v0" :> "ping" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "count" Int :> Post '[JSON] Value
-- | List subscribed topics by name.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0PubsubLs = "api" :> "v0" :> "pubsub" :> "ls" :> Post '[JSON] Value
-- | List peers we are currently pubsubbing with.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0PubsubPeers = "api" :> "v0" :> "pubsub" :> "peers" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Publish a message to a given pubsub topic.
type ApiV0PubsubPub = "api" :> "v0" :> "pubsub" :> "pub" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Subscribe to messages on a given topic.
--
-- Response example:
--
--
-- {
-- "Message": {
-- "From": [
-- "<uint8>"
-- ]
-- "Data": [
-- "<uint8>"
-- ]
-- "Seqno": [
-- "<uint8>"
-- ]
-- "TopicIDs": [
-- "<string>"
-- ]
-- "XXX_unrecognized": [
-- "<uint8>"
-- ]
-- }
-- }
--
type ApiV0PubsubSub = "api" :> "v0" :> "pubsub" :> "sub" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "discover" Bool :> Post '[JSON] Value
-- | List all local references.
--
-- Response example:
--
--
-- {
-- "Ref": "<string>"
-- "Err": "<string>"
-- }
--
type ApiV0RefsLocal = "api" :> "v0" :> "refs" :> "local" :> Post '[JSON] Value
-- | Remove repo lockfiles.
--
-- Response example:
--
--
-- {
-- "Message": "<string>"
-- }
--
type ApiV0RepoFsck = "api" :> "v0" :> "repo" :> "fsck" :> Post '[JSON] Value
-- | Perform a garbage collection sweep on the repo.
--
-- Response example:
--
--
-- {
-- "Key": "<string>"
-- "Error": "<string>"
-- }
--
type ApiV0RepoGc = "api" :> "v0" :> "repo" :> "gc" :> QueryParam "stream-errors" Bool :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Get stats for the currently used repo.
--
-- Response example:
--
--
-- {
-- "NumObjects": "<uint64>"
-- "RepoSize": "<uint64>"
-- "RepoPath": "<string>"
-- "Version": "<string>"
-- "StorageMax": "<uint64>"
-- }
--
type ApiV0RepoStat = "api" :> "v0" :> "repo" :> "stat" :> QueryParam "human" Bool :> Post '[JSON] Value
-- | Verify all blocks in repo are not corrupted.
--
-- Response example:
--
--
-- {
-- "Msg": "<string>"
-- "Progress": "<int>"
-- }
--
type ApiV0RepoVerify = "api" :> "v0" :> "repo" :> "verify" :> Post '[JSON] Value
-- | Show the repo version.
--
-- Response example:
--
--
-- {
-- "Version": "<string>"
-- }
--
type ApiV0RepoVersion = "api" :> "v0" :> "repo" :> "version" :> QueryParam "quiet" Bool :> Post '[JSON] Value
-- | Resolve the value of names to IPFS.
--
-- Response example:
--
--
-- {
-- "Path": "<string>"
-- }
--
type ApiV0Resolve = "api" :> "v0" :> "resolve" :> QueryParam' '[Required, Strict] "arg" Text :> QueryParam "recursive" Bool :> QueryParam "dht-record-count" Word :> QueryParam "dht-timeout" Text :> Post '[JSON] Value
-- | Shut down the ipfs daemon
type ApiV0Shutdown = "api" :> "v0" :> "shutdown" :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Show some diagnostic information on the bitswap agent.
--
-- Response example:
--
--
-- {
-- "ProvideBufLen": "<int>"
-- "Wantlist": [
-- "<string>"
-- ]
-- "Peers": [
-- "<string>"
-- ]
-- "BlocksReceived": "<uint64>"
-- "DataReceived": "<uint64>"
-- "BlocksSent": "<uint64>"
-- "DataSent": "<uint64>"
-- "DupBlksReceived": "<uint64>"
-- "DupDataReceived": "<uint64>"
-- }
--
type ApiV0StatsBitswap = "api" :> "v0" :> "stats" :> "bitswap" :> Post '[JSON] Value
-- | Print ipfs bandwidth information.
--
-- Response example:
--
--
-- {
-- "TotalIn": "<int64>"
-- "TotalOut": "<int64>"
-- "RateIn": "<float64>"
-- "RateOut": "<float64>"
-- }
--
type ApiV0StatsBw = "api" :> "v0" :> "stats" :> "bw" :> QueryParam "peer" Text :> QueryParam "proto" Text :> QueryParam "poll" Bool :> QueryParam "interval" Text :> Post '[JSON] Value
-- | Get stats for the currently used repo.
--
-- Response example:
--
--
-- {
-- "NumObjects": "<uint64>"
-- "RepoSize": "<uint64>"
-- "RepoPath": "<string>"
-- "Version": "<string>"
-- "StorageMax": "<uint64>"
-- }
--
type ApiV0StatsRepo = "api" :> "v0" :> "stats" :> "repo" :> QueryParam "human" Bool :> Post '[JSON] Value
-- | List interface listening addresses.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmAddrsListen = "api" :> "v0" :> "swarm" :> "addrs" :> "listen" :> Post '[JSON] Value
-- | List local addresses.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmAddrsLocal = "api" :> "v0" :> "swarm" :> "addrs" :> "local" :> QueryParam "id" Bool :> Post '[JSON] Value
-- | Open connection to a given address.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmConnect = "api" :> "v0" :> "swarm" :> "connect" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Close connection to a given address.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmDisconnect = "api" :> "v0" :> "swarm" :> "disconnect" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Add an address filter.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmFiltersAdd = "api" :> "v0" :> "swarm" :> "filters" :> "add" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | Remove an address filter.
--
-- Response example:
--
--
-- {
-- "Strings": [
-- "<string>"
-- ]
-- }
--
type ApiV0SwarmFiltersRm = "api" :> "v0" :> "swarm" :> "filters" :> "rm" :> QueryParam' '[Required, Strict] "arg" Text :> Post '[JSON] Value
-- | List peers with open connections.
--
-- Response example:
--
--
-- {
-- "Peers": [
-- {
-- "Addr": "<string>"
-- "Peer": "<string>"
-- "Latency": "<string>"
-- "Muxer": "<string>"
-- "Streams": [
-- {
-- "Protocol": "<string>"
-- }
-- ]
-- }
-- ]
-- }
--
type ApiV0SwarmPeers = "api" :> "v0" :> "swarm" :> "peers" :> QueryParam "verbose" Bool :> QueryParam "streams" Bool :> QueryParam "latency" Bool :> Post '[JSON] Value
-- | Import a tar file into ipfs.
--
-- Response example:
--
--
-- {
-- "Name": "<string>"
-- "Hash": "<string>"
-- "Bytes": "<int64>"
-- "Size": "<string>"
-- }
--
type ApiV0TarAdd = "api" :> "v0" :> "tar" :> "add" :> ReqBody '[MultipartFormData] ByteString :> Post '[JSON] Value
-- | Export a tar file from IPFS.
type ApiV0TarCat = "api" :> "v0" :> "tar" :> "cat" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
type ApiV0Update = "api" :> "v0" :> "update" :> QueryParam' '[Required, Strict] "arg" Text :> Stream 'POST 200 NoFraming PlainText (SourceIO ByteString)
-- | Show ipfs version information.
--
-- Response example:
--
--
-- {
-- "Version": "<string>"
-- "Commit": "<string>"
-- "Repo": "<string>"
-- "System": "<string>"
-- "Golang": "<string>"
-- }
--
type ApiV0Version = "api" :> "v0" :> "version" :> QueryParam "number" Bool :> QueryParam "commit" Bool :> QueryParam "repo" Bool :> QueryParam "all" Bool :> Post '[JSON] Value