Skip to content

Commit bbd2936

Browse files
committed
docs(rest-api-client): update SI-8 spec to reflect removed delete() method
1 parent 7af17b3 commit bbd2936

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/issues/open/1969-1938-si-8-eliminate-unwraps-from-rest-api-client.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The calls fall into two categories:
3737
These are real failure points — network errors, URL parsing failures, etc. They must return `Result`:
3838

3939
1. **11 public `ApiHttpClient` methods** — thin wrappers that delegate to fallible `*_result()` counterparts but `.unwrap()` the result.
40-
2. **`post_empty()`, `post_form()`, `delete()`** (private) — same wrapper-with-unwrap pattern.
40+
2. **`post_empty()`, `post_form()`** (private) — same wrapper-with-unwrap pattern.
4141
3. **`get()` (pub method on `ApiHttpClient`)** — same pattern.
4242
4. **`get()` (pub free function)** — thin wrapper around `get_result()`.
4343
5. **`get_request()` (pub on `ApiHttpClient`)** — calls `base_url()` which already returns `Result`.
@@ -56,7 +56,7 @@ These are provably infallible operations where a descriptive `expect` message is
5656

5757
- Change all panicking public `ApiHttpClient` methods to return `Result<Response, ClientError>` instead of `Response`.
5858
- Update all caller sites across the repository (contract tests, E2E tests, integration tests) to handle the new `Result` return types.
59-
- Change helper functions (`post_empty`, `post_form`, `delete`, `get`, `get_request`, `get()`) to return `Result`.
59+
- Change helper functions (`post_empty`, `post_form`, `get`, `get_request`, `get()`) to return `Result`.
6060
- Replace bare `.unwrap()` with `.expect("infallible: ...")` in `headers_with_request_id()`, `headers_with_auth_token()`, and `get_request_with_query_result()` auth token inserts.
6161
- Update issue spec and documentation.
6262

@@ -97,4 +97,5 @@ These are provably infallible operations where a descriptive `expect` message is
9797

9898
| Date | Event |
9999
| ---------- | ------------------ |
100-
| 2026-06-30 | Draft spec created |
100+
| 2026-06-30 | Spec drafted |
101+
| 2026-06-30 | Spec moved to open |

0 commit comments

Comments
 (0)