Skip to content

Commit

Permalink
Update vocdoni-api docs by commit cd62600
Browse files Browse the repository at this point in the history
  • Loading branch information
altergui authored and arabot-1 committed Aug 20, 2024
1 parent f760e85 commit f651f54
Showing 1 changed file with 36 additions and 15 deletions.
51 changes: 36 additions & 15 deletions swaggers/vocdoni-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ paths:
description: OK
tags:
- Accounts
description: Returns the count of total number of existing accounts
deprecated: true
description: |-
Returns the count of total number of existing accounts
(deprecated, in favor of /accounts which reports totalItems)
summary: Total number of accounts
'/accounts/page/{page}':
get:
Expand Down Expand Up @@ -146,8 +149,11 @@ paths:
description: Number of transaction sent and received for the account
tags:
- Accounts
deprecated: true
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, in favor of /chain/transfers?accountId=xxx which reports totalItems)
summary: Total number of sent and received transactions
'/accounts/{accountId}/transfers/page/{page}':
get:
Expand Down Expand Up @@ -243,7 +249,11 @@ paths:
description: OK
tags:
- Accounts
description: Returns the number of elections for an organization
deprecated: true
description: >-
Returns the number of elections for an organization
(deprecated, in favor of /elections?organizationId=xxx which reports totalItems)
summary: Count organization elections
'/accounts/{organizationId}/elections/page/{page}':
get:
Expand Down Expand Up @@ -1188,7 +1198,10 @@ paths:
description: Number of registered organizations
tags:
- Chain
description: Return the number of organizations
deprecated: true
description: |-
Return the number of organizations
(deprecated, in favor of /chain/organizations which reports totalItems)
summary: Count organizations
'/chain/organizations/filter/page/{page}':
post:
Expand Down Expand Up @@ -1335,7 +1348,10 @@ paths:
description: OK
tags:
- Chain
description: Returns the number of transactions
deprecated: true
description: |-
Returns the number of transactions
(deprecated, in favor of /chain/transactions which reports totalItems)
summary: Transactions count
'/chain/transactions/page/{page}':
get:
Expand Down Expand Up @@ -1589,7 +1605,13 @@ paths:
deprecated: true
description: "Returns a filtered list of elections. The filters have to be sent on the request body. The valid filters are: \n \n```json\n{\n \"organizationId\": \"hexString\",\n \"electionId\": \"hexString\",\n \"withResults\": false,\n \"status\": \"READY\",\n}\n```\n\n`electionId` can be partial. \n\nSee [elections list](elections-list)\n\n(deprecated, in favor of /elections?page=xxx&organizationId=xxx&status=xxx)\n"
requestBody:
$ref: '#/components/requestBodies/api.ElectionParams'
content:
application/json:
schema:
$ref: '#/components/schemas/api.ElectionParams'
description: >-
Filtered by partial organizationId, partial electionId, election status and with results available or not
required: true
summary: List elections (filtered)
'/elections/filter/page/{page}':
post:
Expand Down Expand Up @@ -1618,7 +1640,7 @@ paths:
schema:
$ref: '#/components/schemas/api.ElectionParams'
description: >-
Filtered by partial organizationId, partial electionId, election status and with results available or not
Filtered by exact organizationId, partial electionId, election status, results available or not, etc
required: true
summary: List elections (filtered)
/elections/id:
Expand Down Expand Up @@ -2116,15 +2138,6 @@ paths:
Transfer balance to another account. Needed the bearer token associated the account.
summary: Transfer tokens
components:
requestBodies:
api.ElectionParams:
content:
application/json:
schema:
$ref: '#/components/schemas/api.ElectionParams'
description: >-
Filtered by partial organizationId, partial electionId, election status and with results available or not
required: true
schemas:
api.Account:
properties:
Expand Down Expand Up @@ -2450,6 +2463,10 @@ components:
properties:
electionId:
type: string
endDateAfter:
type: string
endDateBefore:
type: string
finalResults:
type: boolean
limit:
Expand All @@ -2460,6 +2477,10 @@ components:
type: string
page:
type: integer
startDateAfter:
type: string
startDateBefore:
type: string
status:
type: string
withResults:
Expand Down

0 comments on commit f651f54

Please sign in to comment.