Skip to content

Commit

Permalink
api: all endpoints */count are now marked as deprecated on swagger docs
Browse files Browse the repository at this point in the history
  • Loading branch information
altergui committed Aug 20, 2024
1 parent 0be85ab commit fa960c6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
6 changes: 6 additions & 0 deletions api/accounts.go
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@ func (a *API) accountSetHandler(msg *apirest.APIdata, ctx *httprouter.HTTPContex
//
// @Summary Total number of accounts
// @Description Returns the count of total number of existing accounts
// @Deprecated
// @Description (deprecated, in favor of /accounts which reports totalItems)
// @Tags Accounts
// @Accept json
// @Produce json
Expand Down Expand Up @@ -414,6 +416,8 @@ func (a *API) accountElectionsListByStatusAndPageHandler(_ *apirest.APIdata, ctx
//
// @Summary Count organization elections
// @Description Returns the number of elections for an organization
// @Deprecated
// @Description (deprecated, in favor of /elections?organizationId=xxx which reports totalItems)
// @Tags Accounts
// @Accept json
// @Produce json
Expand Down Expand Up @@ -504,6 +508,8 @@ func (a *API) tokenFeesHandler(_ *apirest.APIdata, ctx *httprouter.HTTPContext)
//
// @Summary Total number of sent and received transactions
// @Description Returns the count of total number of sent and received transactions for an account. A transaction is a token transfer from one account to another existing account
// @Deprecated
// @Description (deprecated, in favor of /chain/transfers?accountId=xxx which reports totalItems)
// @Tags Accounts
// @Accept json
// @Produce json
Expand Down
4 changes: 4 additions & 0 deletions api/chain.go
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,8 @@ func (a *API) sendOrganizationList(ctx *httprouter.HTTPContext, params *Organiza
//
// @Summary Count organizations
// @Description Return the number of organizations
// @Deprecated
// @Description (deprecated, in favor of /chain/organizations which reports totalItems)
// @Tags Chain
// @Accept json
// @Produce json
Expand Down Expand Up @@ -928,6 +930,8 @@ func (a *API) chainBlockByHashHandler(_ *apirest.APIdata, ctx *httprouter.HTTPCo
//
// @Summary Transactions count
// @Description Returns the number of transactions
// @Deprecated
// @Description (deprecated, in favor of /chain/transactions which reports totalItems)
// @Tags Chain
// @Accept json
// @Produce json
Expand Down
2 changes: 1 addition & 1 deletion api/elections.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ func (a *API) enableElectionHandlers() error {
// @Accept json
// @Produce json
// @Param page path number true "Page"
// @Param body body ElectionParams true "Filtered by partial organizationId, partial electionId, election status and with results available or not"
// @Param body body ElectionParams true "Filtered by exact organizationId, partial electionId, election status, results available or not, etc"
// @Success 200 {object} ElectionsList
// @Router /elections/filter/page/{page} [post]
func (a *API) electionListByFilterAndPageHandler(msg *apirest.APIdata, ctx *httprouter.HTTPContext) error {
Expand Down

0 comments on commit fa960c6

Please sign in to comment.