Updating documentation

This commit is contained in:
Documentation Updater 2024-12-27 23:50:47 +00:00
parent 1d63384de9
commit 85d2ea9eef
1 changed files with 69 additions and 83 deletions

View File

@ -75,20 +75,6 @@ paths:
security: security:
- authenticatedAccount: [] - authenticatedAccount: []
/v1/accounts/me: /v1/accounts/me:
get:
tags:
- Account
operationId: getMe
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIdentityResponse'
deprecated: true
security:
- authenticatedAccount: []
delete: delete:
tags: tags:
- Account - Account
@ -562,6 +548,8 @@ paths:
put: put:
tags: tags:
- Account - Account
summary: Sets whether the account should be discoverable by phone number in
the directory.
operationId: setPhoneNumberDiscoverability operationId: setPhoneNumberDiscoverability
requestBody: requestBody:
content: content:
@ -570,10 +558,8 @@ paths:
$ref: '#/components/schemas/PhoneNumberDiscoverabilityRequest' $ref: '#/components/schemas/PhoneNumberDiscoverabilityRequest'
required: true required: true
responses: responses:
default: "204":
description: default response description: The setting was successfully updated.
content:
application/json: {}
security: security:
- authenticatedAccount: [] - authenticatedAccount: []
/v1/archives/upload/form: /v1/archives/upload/form:
@ -3851,71 +3837,6 @@ components:
type: string type: string
description: The url-safe base64-encoded encrypted username to be stored description: The url-safe base64-encoded encrypted username to be stored
for username links for username links
AccountIdentityResponse:
type: object
properties:
uuid:
type: string
description: the account identifier for this account
format: uuid
number:
type: string
description: the phone number associated with this account
pni:
type: string
description: the account identifier for this account's phone-number identity
format: uuid
usernameHash:
type: string
description: "a hash of this account's username, if set"
format: byte
usernameLinkHandle:
type: string
description: "this account's username link handle, if set"
format: uuid
storageCapable:
type: boolean
description: whether any of this account's devices support storage
entitlements:
$ref: '#/components/schemas/Entitlements'
BackupEntitlement:
type: object
properties:
backupLevel:
type: integer
description: The backup level of the account
format: int64
expirationSeconds:
type: integer
description: "When the backup entitlement expires, in number of seconds\
\ since epoch"
format: int64
description: "If present, the backup level set via /v1/archives/redeem-receipt"
BadgeEntitlement:
type: object
properties:
id:
type: string
description: The badge id
visible:
type: boolean
description: Whether the badge is currently configured to be visible
expirationSeconds:
type: integer
description: "When the badge expires, in number of seconds since epoch"
format: int64
description: Active badges added via /v1/donation/redeem-receipt
Entitlements:
type: object
properties:
badges:
type: array
description: Active badges added via /v1/donation/redeem-receipt
items:
$ref: '#/components/schemas/BadgeEntitlement'
backup:
$ref: '#/components/schemas/BackupEntitlement'
description: entitlements for this account and their current expirations
TurnToken: TurnToken:
type: object type: object
properties: properties:
@ -4068,6 +3989,71 @@ components:
description: A handle that can be included in username links to retrieve description: A handle that can be included in username links to retrieve
the stored encrypted username the stored encrypted username
format: uuid format: uuid
AccountIdentityResponse:
type: object
properties:
uuid:
type: string
description: the account identifier for this account
format: uuid
number:
type: string
description: the phone number associated with this account
pni:
type: string
description: the account identifier for this account's phone-number identity
format: uuid
usernameHash:
type: string
description: "a hash of this account's username, if set"
format: byte
usernameLinkHandle:
type: string
description: "this account's username link handle, if set"
format: uuid
storageCapable:
type: boolean
description: whether any of this account's devices support storage
entitlements:
$ref: '#/components/schemas/Entitlements'
BackupEntitlement:
type: object
properties:
backupLevel:
type: integer
description: The backup level of the account
format: int64
expirationSeconds:
type: integer
description: "When the backup entitlement expires, in number of seconds\
\ since epoch"
format: int64
description: "If present, the backup level set via /v1/archives/redeem-receipt"
BadgeEntitlement:
type: object
properties:
id:
type: string
description: The badge id
visible:
type: boolean
description: Whether the badge is currently configured to be visible
expirationSeconds:
type: integer
description: "When the badge expires, in number of seconds since epoch"
format: int64
description: Active badges added via /v1/donation/redeem-receipt
Entitlements:
type: object
properties:
badges:
type: array
description: Active badges added via /v1/donation/redeem-receipt
items:
$ref: '#/components/schemas/BadgeEntitlement'
backup:
$ref: '#/components/schemas/BackupEntitlement'
description: entitlements for this account and their current expirations
MismatchedDevices: MismatchedDevices:
type: object type: object
properties: properties: