api(swagger): improve SIK docs

vocdoni · Aug 7, 2023 · d8e7f90 · d8e7f90
1 parent 9c49f11
commit d8e7f90
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/api/api.go b/api/api.go
@@ -39,6 +39,8 @@ import (
 //	@tag.description	Submit, get, and verify votes
 //	@tag.name			Wallet
 //	@tag.description	Operations for the wallets managed backend side
+//	@tag.name			SIK
+//	@tag.description	The Secret Identity Key (SIK) operations used on anonymous voting
 
 //	@schemes	https
 //	@host		api-dev.vocdoni.net

diff --git a/api/docs/descriptions/api.md b/api/docs/descriptions/api.md
@@ -7,6 +7,7 @@ You can review the API endpoints documentation in this section, the main entitie
 - [**Elections**](elections): Is a rule-set of options and requirements for creating a process in which people vote a series of options. To know more about the params of an election and its lifecycle go [here](../get-started/intro#23-elections). In this section you will find all information related to an election as its information, election keys, submitted votes & how to create a new election.
 - [**Censuses**](censuses): The census is a key component of any voting process. It specifies the set of users (identified by a public key or address) eligible for participating in an election. To understand more about the Censuses you can check [here](../get-started/intro#21-the-census). Here you will be able to get censuses information like the Merkle root, total weight & size, import/export the censuses and create new ones.
 - [**Votes**](votes): All the information related to the vote issued by a participant in a vote, you can check the validity of the vote, consult your information and send a vote.
+- [**SIK**](sik): The Secret Identity Key is a user-generated piece of information that proves the user's identity without revealing it. It is the hash of the user's address, the signature of a public message and an optional secret part. It is used to ensure anonymous voting. All registered accounts or anonymous voters must register a SIK, and they are all stored in a Merkle tree. The `/siks` endpoints help to generate a proof of membership, get the current valid SIK roots, or check if an account has a valid SIK.
 
 
 ### Errors