Updating documentation
This commit is contained in:
Documentation Updater
parent
2eab162f8c
commit
66d53cf6f0
|
|
@ -2005,6 +2005,11 @@ paths:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Donations
|
- Donations
|
||||||
|
summary: Redeem receipt
|
||||||
|
description: |
|
||||||
|
Redeem a receipt acquired from /v1/subscription/{subscriberId}/receipt_credentials to add a badge to the
|
||||||
|
account. After successful redemption, profile responses will include the corresponding badge (if configured as
|
||||||
|
visible) until the expiration time on the receipt.
|
||||||
operationId: redeemReceipt_1
|
operationId: redeemReceipt_1
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
|
|
@ -2013,11 +2018,14 @@ paths:
|
||||||
$ref: '#/components/schemas/RedeemReceiptRequest'
|
$ref: '#/components/schemas/RedeemReceiptRequest'
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
default:
|
"200":
|
||||||
description: default response
|
description: The receipt was redeemed
|
||||||
content:
|
"400":
|
||||||
application/json: {}
|
description: |
|
||||||
text/plain: {}
|
The provided presentation or receipt was invalid, or the receipt was already redeemed for a different account. A
|
||||||
|
specific error message suitable for logging will be included as text/plain body
|
||||||
|
"429":
|
||||||
|
description: Rate limited.
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/keepalive:
|
/v1/keepalive:
|
||||||
|
|
@ -2344,15 +2352,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/messages/uuid/{uuid}:
|
/v1/messages/uuid/{uuid}:
|
||||||
|
|
@ -2589,15 +2597,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2680,15 +2688,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -2716,15 +2724,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3137,15 +3145,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3185,15 +3193,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3226,15 +3234,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3411,15 +3419,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3457,15 +3465,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -3556,15 +3564,15 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
done:
|
|
||||||
type: boolean
|
|
||||||
cancelled:
|
|
||||||
type: boolean
|
|
||||||
completedExceptionally:
|
completedExceptionally:
|
||||||
type: boolean
|
type: boolean
|
||||||
numberOfDependents:
|
numberOfDependents:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
done:
|
||||||
|
type: boolean
|
||||||
|
cancelled:
|
||||||
|
type: boolean
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
|
@ -4973,11 +4981,15 @@ components:
|
||||||
properties:
|
properties:
|
||||||
receiptCredentialPresentation:
|
receiptCredentialPresentation:
|
||||||
type: string
|
type: string
|
||||||
format: byte
|
description: Presentation of a ZK receipt encoded in standard padded base64
|
||||||
visible:
|
visible:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
description: "If true, the corresponding badge should be visible on the\
|
||||||
|
\ profile"
|
||||||
primary:
|
primary:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
description: "if true, and the new badge is visible, it should be the primary\
|
||||||
|
\ badge on the profile"
|
||||||
WebSocketClient:
|
WebSocketClient:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue