Updating documentation
This commit is contained in:
parent
c99691fca5
commit
06b039dac4
|
@ -388,7 +388,20 @@ paths:
|
||||||
put:
|
put:
|
||||||
tags:
|
tags:
|
||||||
- Account
|
- Account
|
||||||
|
summary: Set a device's encrypted name
|
||||||
|
description: |
|
||||||
|
Sets the encrypted name for the specified device. Primary devices may change the name of any device associated
|
||||||
|
with their account, but linked devices may only change their own name. If no device ID is specified, then the
|
||||||
|
authenticated device's ID will be used.
|
||||||
operationId: setName
|
operationId: setName
|
||||||
|
parameters:
|
||||||
|
- name: deviceId
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "The ID of the device for which to set a name; if omitted,\
|
||||||
|
\ the authenticated device will be targeted for a name change"
|
||||||
|
format: byte
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
'*/*':
|
'*/*':
|
||||||
|
@ -396,10 +409,13 @@ paths:
|
||||||
$ref: '#/components/schemas/DeviceName'
|
$ref: '#/components/schemas/DeviceName'
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
default:
|
"204":
|
||||||
description: default response
|
description: Device name changed successfully
|
||||||
content:
|
"404":
|
||||||
'*/*': {}
|
description: No device found with the given ID
|
||||||
|
"403":
|
||||||
|
description: Not authorized to change the name of the device with the given
|
||||||
|
ID
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
/v1/accounts/whoami:
|
/v1/accounts/whoami:
|
||||||
|
@ -1890,8 +1906,9 @@ paths:
|
||||||
- KeyTransparency
|
- KeyTransparency
|
||||||
summary: Get the current value of the distinguished key
|
summary: Get the current value of the distinguished key
|
||||||
description: |
|
description: |
|
||||||
Enforced unauthenticated endpoint. The response contains the distinguished tree head to prove consistency
|
The response contains the distinguished tree head to prove consistency
|
||||||
against for future calls to `/search` and `/distinguished`.
|
against for future calls to `/search`, `/monitor`, and `/distinguished`.
|
||||||
|
Enforced unauthenticated endpoint.
|
||||||
operationId: getDistinguishedKey
|
operationId: getDistinguishedKey
|
||||||
parameters:
|
parameters:
|
||||||
- name: lastTreeHeadSize
|
- name: lastTreeHeadSize
|
||||||
|
@ -1921,10 +1938,10 @@ paths:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- KeyTransparency
|
- KeyTransparency
|
||||||
summary: Monitor the given search keys in the key transparency log
|
summary: Monitor the given identifiers in the key transparency log
|
||||||
description: |
|
description: |
|
||||||
Enforced unauthenticated endpoint. Return proofs proving that the log tree
|
Return proofs proving that the log tree has been constructed correctly in later entries for each of the given
|
||||||
has been constructed correctly in later entries for each of the given search keys .
|
identifiers. Enforced unauthenticated endpoint.
|
||||||
operationId: monitor
|
operationId: monitor
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
|
@ -1954,9 +1971,17 @@ paths:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- KeyTransparency
|
- KeyTransparency
|
||||||
summary: Search for the given search keys in the key transparency log
|
summary: Search for the given identifiers in the key transparency log
|
||||||
description: |
|
description: |
|
||||||
Enforced unauthenticated endpoint. Returns a response if all search keys exist in the key transparency log.
|
Returns a response if the ACI exists in the transparency log and its mapped value matches the provided
|
||||||
|
ACI identity key.
|
||||||
|
|
||||||
|
The username hash search response field is populated if it is found in the log and its mapped value matches
|
||||||
|
the provided ACI. The E164 search response is populated similarly, with some additional requirements:
|
||||||
|
- The account associated with the provided ACI must be discoverable by phone number.
|
||||||
|
- The provided unidentified access key must match the one on the account.
|
||||||
|
|
||||||
|
Enforced unauthenticated endpoint.
|
||||||
operationId: search
|
operationId: search
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
|
@ -1966,7 +1991,8 @@ paths:
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: All search key lookups were successful
|
description: The ACI was found and its mapped value matched the provided
|
||||||
|
ACI identity key
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
@ -1974,13 +2000,14 @@ paths:
|
||||||
"400":
|
"400":
|
||||||
description: Invalid request. See response for any available details.
|
description: Invalid request. See response for any available details.
|
||||||
"403":
|
"403":
|
||||||
description: At least one search key lookup to value mapping was invalid
|
description: The ACI was found but its mapped value did not match the provided
|
||||||
|
ACI identity key
|
||||||
"404":
|
"404":
|
||||||
description: At least one search key lookup did not find the key
|
description: The ACI was not found in the log
|
||||||
"429":
|
|
||||||
description: Rate-limited
|
|
||||||
"422":
|
"422":
|
||||||
description: Invalid request format
|
description: Invalid request format
|
||||||
|
"429":
|
||||||
|
description: Rate-limited
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -2172,15 +2199,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}:
|
||||||
|
@ -2305,6 +2332,8 @@ paths:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/AccountStaleDevices'
|
$ref: '#/components/schemas/AccountStaleDevices'
|
||||||
|
"428":
|
||||||
|
description: The sender should complete a challenge before proceeding
|
||||||
security:
|
security:
|
||||||
- authenticatedAccount: []
|
- authenticatedAccount: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -2419,15 +2448,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -2455,15 +2484,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -2491,15 +2520,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -2527,15 +2556,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3007,15 +3036,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3055,15 +3084,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3096,15 +3125,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3281,15 +3310,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3327,15 +3356,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -3426,15 +3455,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: []
|
||||||
- {}
|
- {}
|
||||||
|
@ -4667,16 +4696,17 @@ components:
|
||||||
type: string
|
type: string
|
||||||
description: The monitor response encoded in standard un-padded base64
|
description: The monitor response encoded in standard un-padded base64
|
||||||
format: byte
|
format: byte
|
||||||
KeyTransparencyMonitorRequest:
|
AciMonitor:
|
||||||
required:
|
required:
|
||||||
- aci
|
- commitmentIndex
|
||||||
- aciPositions
|
- positions
|
||||||
|
- value
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
aci:
|
value:
|
||||||
type: string
|
type: string
|
||||||
description: An identifier for an account based on the account's ACI
|
description: An identifier for an account based on the account's ACI
|
||||||
aciPositions:
|
positions:
|
||||||
type: array
|
type: array
|
||||||
description: A list of log tree positions maintained by the client for the
|
description: A list of log tree positions maintained by the client for the
|
||||||
aci search key.
|
aci search key.
|
||||||
|
@ -4685,10 +4715,21 @@ components:
|
||||||
description: A list of log tree positions maintained by the client for
|
description: A list of log tree positions maintained by the client for
|
||||||
the aci search key.
|
the aci search key.
|
||||||
format: int64
|
format: int64
|
||||||
e164:
|
commitmentIndex:
|
||||||
|
type: string
|
||||||
|
description: The commitment index derived from a previous search request
|
||||||
|
format: byte
|
||||||
|
E164Monitor:
|
||||||
|
required:
|
||||||
|
- commitmentIndex
|
||||||
|
- positions
|
||||||
|
- value
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
value:
|
||||||
type: string
|
type: string
|
||||||
description: The e164-formatted phone number to monitor
|
description: The e164-formatted phone number to monitor
|
||||||
e164Positions:
|
positions:
|
||||||
type: array
|
type: array
|
||||||
description: A list of log tree positions maintained by the client for the
|
description: A list of log tree positions maintained by the client for the
|
||||||
e164 search key.
|
e164 search key.
|
||||||
|
@ -4697,20 +4738,26 @@ components:
|
||||||
description: A list of log tree positions maintained by the client for
|
description: A list of log tree positions maintained by the client for
|
||||||
the e164 search key.
|
the e164 search key.
|
||||||
format: int64
|
format: int64
|
||||||
usernameHash:
|
commitmentIndex:
|
||||||
type: string
|
type: string
|
||||||
description: "The username hash to monitor, encoded in url-safe unpadded\
|
description: The commitment index derived from a previous search or monitor
|
||||||
\ base64."
|
request
|
||||||
format: byte
|
format: byte
|
||||||
usernameHashPositions:
|
KeyTransparencyMonitorRequest:
|
||||||
type: array
|
required:
|
||||||
description: A list of log tree positions maintained by the client for the
|
- aci
|
||||||
username hash search key.
|
- e164
|
||||||
items:
|
- lastDistinguishedTreeHeadSize
|
||||||
type: integer
|
- lastNonDistinguishedTreeHeadSize
|
||||||
description: A list of log tree positions maintained by the client for
|
- usernameHash
|
||||||
the username hash search key.
|
type: object
|
||||||
format: int64
|
properties:
|
||||||
|
aci:
|
||||||
|
$ref: '#/components/schemas/AciMonitor'
|
||||||
|
e164:
|
||||||
|
$ref: '#/components/schemas/E164Monitor'
|
||||||
|
usernameHash:
|
||||||
|
$ref: '#/components/schemas/UsernameHashMonitor'
|
||||||
lastNonDistinguishedTreeHeadSize:
|
lastNonDistinguishedTreeHeadSize:
|
||||||
type: integer
|
type: integer
|
||||||
description: The tree head size to prove consistency against.
|
description: The tree head size to prove consistency against.
|
||||||
|
@ -4719,28 +4766,56 @@ components:
|
||||||
type: integer
|
type: integer
|
||||||
description: The distinguished tree head size to prove consistency against.
|
description: The distinguished tree head size to prove consistency against.
|
||||||
format: int64
|
format: int64
|
||||||
usernameHashFieldsValid:
|
UsernameHashMonitor:
|
||||||
type: boolean
|
required:
|
||||||
e164VFieldsValid:
|
- commitmentIndex
|
||||||
type: boolean
|
- positions
|
||||||
|
- value
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
value:
|
||||||
|
type: string
|
||||||
|
description: "The username hash to monitor, encoded in url-safe unpadded\
|
||||||
|
\ base64."
|
||||||
|
format: byte
|
||||||
|
positions:
|
||||||
|
type: array
|
||||||
|
description: A list of log tree positions maintained by the client for the
|
||||||
|
username hash search key.
|
||||||
|
items:
|
||||||
|
type: integer
|
||||||
|
description: A list of log tree positions maintained by the client for
|
||||||
|
the username hash search key.
|
||||||
|
format: int64
|
||||||
|
commitmentIndex:
|
||||||
|
type: string
|
||||||
|
description: The commitment index derived from a previous search or monitor
|
||||||
|
request
|
||||||
|
format: byte
|
||||||
KeyTransparencySearchResponse:
|
KeyTransparencySearchResponse:
|
||||||
required:
|
required:
|
||||||
- aciSearchResponse
|
- aciSearchResponse
|
||||||
|
- fullTreeHead
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
fullTreeHead:
|
||||||
|
type: string
|
||||||
|
description: The `FullTreeHead` protobuf encoded in standard un-padded base64.
|
||||||
|
This should be used across all identifiers.
|
||||||
|
format: byte
|
||||||
aciSearchResponse:
|
aciSearchResponse:
|
||||||
type: string
|
type: string
|
||||||
description: The search response for the aci search key encoded in standard
|
description: The `TreeSearchResponse` protobuf for the ACI identifier encoded
|
||||||
un-padded base64
|
in standard un-padded base64
|
||||||
format: byte
|
format: byte
|
||||||
e164SearchResponse:
|
e164SearchResponse:
|
||||||
type: string
|
type: string
|
||||||
description: The search response for the e164 search key encoded in standard
|
description: The `TreeSearchResponse` protobuf for the E164 encoded in standard
|
||||||
un-padded base64
|
un-padded base64
|
||||||
format: byte
|
format: byte
|
||||||
usernameHashSearchResponse:
|
usernameHashSearchResponse:
|
||||||
type: string
|
type: string
|
||||||
description: The search response for the username hash search key encoded
|
description: The `TreeSearchResponse` protobuf for the username hash encoded
|
||||||
in standard un-padded base64
|
in standard un-padded base64
|
||||||
format: byte
|
format: byte
|
||||||
KeyTransparencySearchRequest:
|
KeyTransparencySearchRequest:
|
||||||
|
@ -4754,7 +4829,7 @@ components:
|
||||||
description: An identifier for an account based on the account's ACI
|
description: An identifier for an account based on the account's ACI
|
||||||
e164:
|
e164:
|
||||||
type: string
|
type: string
|
||||||
description: The e164-formatted phone number to look up
|
description: The E164-formatted phone number to look up
|
||||||
usernameHash:
|
usernameHash:
|
||||||
type: string
|
type: string
|
||||||
description: "The username hash to look up, encoded in web-safe unpadded\
|
description: "The username hash to look up, encoded in web-safe unpadded\
|
||||||
|
|
Loading…
Reference in New Issue