Skip to content

Commit

Permalink
Fix 'Get configuration and status' table (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
fboemer authored Dec 18, 2024
1 parent dd662f7 commit 8c05f72
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions Sources/PIRService/PIRService.docc/HTTPEndpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,8 @@ Path | `/config` | HTTP path.
Header | `Authorization` | The value will contain a private access token.
Header | `User-Agent` | Identifier for the user's OS type and version.
Header | `User-Identifier` | Pseudorandom identifier tied to a user.
Request Body | `ConfigRequest` | Serialized Protobuf message that list the use-cases that the system is interested in.
As of iOS 18.2, the client will set the `existing_config_ids` field.
Response | `ConfigResponse` | Serialized Protobuf message. The `ConfigResponse` contains the `configs` and `key_info` response fields.
As of iOS 18.2, the message may set `reuse_existing_config: true` instead of the `pirConfig` field, reducing the message size.
This indicates the client should use the config with id specified in `existing_config_ids`.
Request Body | `ConfigRequest` | Serialized Protobuf message that list the use-cases that the system is interested in. As of iOS 18.2, the client will set the `existing_config_ids` field.
Response | `ConfigResponse` | Serialized Protobuf message. The `ConfigResponse` contains the `configs` and `key_info` response fields. As of iOS 18.2, the message may set `reuse_existing_config: true` instead of the `pirConfig` field, reducing the message size. This indicates the client should use the config with id specified in `existing_config_ids`.
Response field | `configs` | Map from use case names to the corresponding configuration.
Response field | `key_info` | List of `KeyStatus` objects.

Expand Down

0 comments on commit 8c05f72

Please sign in to comment.