Skip to content

chore: sync lichess-api submodule to 572cea5 (external engine docs fix) - #31

Merged
obazin merged 1 commit into
mainfrom
chore/lichess-api-sync-2026-07-25
Jul 26, 2026
Merged

chore: sync lichess-api submodule to 572cea5 (external engine docs fix)#31
obazin merged 1 commit into
mainfrom
chore/lichess-api-sync-2026-07-25

Conversation

@obazin

@obazin obazin commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Summary

Automated upstream sync of the vendored Lichess OpenAPI spec submodule (reference/lichess-api).

  • Old commit: 3033570 ("Update API version")
  • New commit: 572cea5 ("fix external engine docs inaccuracy")

There is exactly one upstream commit in this range, and it is documentation-only.

Spec changes detected

The upstream commit touches three External Engine tag files under doc/specs/tags/externalengine/:

File Change
api-external-engine-id-analyse.yaml Adds a blank line after the endpoint header line in the description (markdown formatting).
api-external-engine-work-id.yaml Adds a blank line after the endpoint header line in the description (markdown formatting).
api-external-engine-work.yaml Adds a blank line and corrects the prose from "registered with the given secret" to "registered with the given providerSecret".

No endpoints, request/response DTO fields, enums, error responses, or the API version were changed. In particular, the request-body schema of POST /api/external-engine/work already declared the field as providerSecret; only the surrounding description text had the wrong name.

Client impact

None required. The litchee external engine client (src/api/engine/external_engine.rs) already sends the correct field:

let body = serde_json::json!({ "providerSecret": provider_secret });

So the client already matches the corrected spec. This PR is limited to the submodule pointer bump so the vendored spec stays in lockstep with upstream.

Verification

Run in the project toolchain:

  • cargo fmt --check — clean
  • cargo clippy --all-targets --all-features -- -D warnings — clean
  • cargo test — all unit, integration, and doc tests pass

Generated by Claude Code

Sync vendored OpenAPI spec to upstream commit 572cea5 ("fix external
engine docs inaccuracy").

The single upstream commit is documentation-only:
- Adds blank lines after the endpoint header line in three external
  engine tag descriptions (markdown formatting).
- Corrects the prose in POST /api/external-engine/work to reference
  the `providerSecret` request field instead of `secret`.

No endpoints, DTO fields, enums, or error responses changed. The
request-body schema already used `providerSecret`, and the litchee
client already sends that field, so no client code changes are
required.
@obazin
obazin merged commit eeaa73a into main Jul 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant