Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Commit c6cf5be

Browse files
committed
Add tag description for internal API
1 parent 094c69b commit c6cf5be

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

wallet/src/Cardano/Wallet/API/Internal.hs

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ import Cardano.Wallet.API.Response (APIResponse, ValidJSON)
1111
import Cardano.Wallet.API.Types
1212
import Cardano.Wallet.API.V1.Types (V1, Wallet, WalletImport)
1313

14-
type API = Tag "Internal" 'NoTagDescription :>
14+
type API = Tag "Internal" ('TagDescription
15+
"This section contains endpoints so-called 'Internal'. They are only\
16+
\ expected to be used by advanced users of the API (e.g. Daedalus) with\
17+
\ which there's a privileged communication channel. Backward-compatibility\
18+
\ or existence of these endpoints between versions is not guaranteed and\
19+
\ won't be enforced. Use at your own risks.")
20+
:>
1521
( "next-update"
1622
:> Summary "Version of the next update (404 if none)"
1723
:> Get '[ValidJSON] (APIResponse (V1 SoftwareVersion))

0 commit comments

Comments
 (0)