Skip to content

Commit 7f3c0dd

Browse files
committed
Address review comments: update method name to configRequirements/read
1 parent f936127 commit 7f3c0dd

File tree

6 files changed

+30
-14
lines changed

6 files changed

+30
-14
lines changed

codex-rs/app-server-protocol/src/protocol/common.rs

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,9 @@ client_request_definitions! {
197197
response: v2::ConfigWriteResponse,
198198
},
199199

200-
RequirementList => "requirements/list" {
200+
ConfigRequirementsRead => "configRequirements/read" {
201201
params: #[ts(type = "undefined")] #[serde(skip_serializing_if = "Option::is_none")] Option<()>,
202-
response: v2::RequirementListResponse,
202+
response: v2::ConfigRequirementsReadResponse,
203203
},
204204

205205
GetAccount => "account/read" {
@@ -716,6 +716,22 @@ mod tests {
716716
Ok(())
717717
}
718718

719+
#[test]
720+
fn serialize_config_requirements_read() -> Result<()> {
721+
let request = ClientRequest::ConfigRequirementsRead {
722+
request_id: RequestId::Integer(1),
723+
params: None,
724+
};
725+
assert_eq!(
726+
json!({
727+
"method": "configRequirements/read",
728+
"id": 1,
729+
}),
730+
serde_json::to_value(&request)?,
731+
);
732+
Ok(())
733+
}
734+
719735
#[test]
720736
fn serialize_account_login_api_key() -> Result<()> {
721737
let request = ClientRequest::LoginAccount {

codex-rs/app-server-protocol/src/protocol/v2.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ pub struct Requirements {
464464
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
465465
#[serde(rename_all = "camelCase")]
466466
#[ts(export_to = "v2/")]
467-
pub struct RequirementListResponse {
467+
pub struct ConfigRequirementsReadResponse {
468468
/// Null if no requirements are configured (e.g. no requirements.toml/MDM entries).
469469
pub requirements: Option<Requirements>,
470470
}

codex-rs/app-server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Example (from OpenAI's official VSCode extension):
8888
- `config/read` — fetch the effective config on disk after resolving config layering.
8989
- `config/value/write` — write a single config key/value to the user's config.toml on disk.
9090
- `config/batchWrite` — apply multiple config edits atomically to the user's config.toml on disk.
91-
- `requirements/list` — fetch the loaded requirements allow-lists from `requirements.toml` and/or MDM (or `null` if none are configured).
91+
- `configRequirements/read` — fetch the loaded requirements allow-lists from `requirements.toml` and/or MDM (or `null` if none are configured).
9292

9393
### Example: Start or resume a thread
9494

codex-rs/app-server/src/codex_message_processor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,8 @@ impl CodexMessageProcessor {
510510
| ClientRequest::ConfigBatchWrite { .. } => {
511511
warn!("Config request reached CodexMessageProcessor unexpectedly");
512512
}
513-
ClientRequest::RequirementList { .. } => {
514-
warn!("RequirementList request reached CodexMessageProcessor unexpectedly");
513+
ClientRequest::ConfigRequirementsRead { .. } => {
514+
warn!("ConfigRequirementsRead request reached CodexMessageProcessor unexpectedly");
515515
}
516516
ClientRequest::GetAccountRateLimits {
517517
request_id,

codex-rs/app-server/src/config_api.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ use crate::error_code::INVALID_REQUEST_ERROR_CODE;
33
use codex_app_server_protocol::ConfigBatchWriteParams;
44
use codex_app_server_protocol::ConfigReadParams;
55
use codex_app_server_protocol::ConfigReadResponse;
6+
use codex_app_server_protocol::ConfigRequirementsReadResponse;
67
use codex_app_server_protocol::ConfigValueWriteParams;
78
use codex_app_server_protocol::ConfigWriteErrorCode;
89
use codex_app_server_protocol::ConfigWriteResponse;
910
use codex_app_server_protocol::JSONRPCErrorError;
10-
use codex_app_server_protocol::RequirementListResponse;
1111
use codex_app_server_protocol::Requirements;
1212
use codex_app_server_protocol::SandboxMode;
1313
use codex_core::config::ConfigService;
@@ -42,17 +42,17 @@ impl ConfigApi {
4242
self.service.read(params).await.map_err(map_error)
4343
}
4444

45-
pub(crate) async fn requirement_list(
45+
pub(crate) async fn config_requirements_read(
4646
&self,
47-
) -> Result<RequirementListResponse, JSONRPCErrorError> {
47+
) -> Result<ConfigRequirementsReadResponse, JSONRPCErrorError> {
4848
let requirements = self
4949
.service
5050
.read_requirements()
5151
.await
5252
.map_err(map_error)?
5353
.map(map_requirements_toml_to_api);
5454

55-
Ok(RequirementListResponse { requirements })
55+
Ok(ConfigRequirementsReadResponse { requirements })
5656
}
5757

5858
pub(crate) async fn write_value(

codex-rs/app-server/src/message_processor.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,11 @@ impl MessageProcessor {
158158
ClientRequest::ConfigBatchWrite { request_id, params } => {
159159
self.handle_config_batch_write(request_id, params).await;
160160
}
161-
ClientRequest::RequirementList {
161+
ClientRequest::ConfigRequirementsRead {
162162
request_id,
163163
params: _,
164164
} => {
165-
self.handle_requirement_list(request_id).await;
165+
self.handle_config_requirements_read(request_id).await;
166166
}
167167
other => {
168168
self.codex_message_processor.process_request(other).await;
@@ -217,8 +217,8 @@ impl MessageProcessor {
217217
}
218218
}
219219

220-
async fn handle_requirement_list(&self, request_id: RequestId) {
221-
match self.config_api.requirement_list().await {
220+
async fn handle_config_requirements_read(&self, request_id: RequestId) {
221+
match self.config_api.config_requirements_read().await {
222222
Ok(response) => self.outgoing.send_response(request_id, response).await,
223223
Err(error) => self.outgoing.send_error(request_id, error).await,
224224
}

0 commit comments

Comments
 (0)