Skip to content

docs: fix HTTP discovery endpoint response to match Rust implementation#2883

Merged
markphelps merged 1 commit intomainfrom
fix/http-discovery-docs-drift
Mar 30, 2026
Merged

docs: fix HTTP discovery endpoint response to match Rust implementation#2883
markphelps merged 1 commit intomainfrom
fix/http-discovery-docs-drift

Conversation

@markphelps
Copy link
Copy Markdown
Contributor

Summary

Fixes the GET / discovery endpoint documentation that drifted from the actual implementation after the Rust migration.

  • docs_url: Fixed value from /openapi.json to /docs
  • health_check_urlhealthcheck_url: Fixed key name (no underscore between "health" and "check")
  • Added missing fields: shutdown_url, predictions_idempotent_url, predictions_cancel_url
  • Training fields: Updated description to mention all three fields (trainings_url, trainings_idempotent_url, trainings_cancel_url) instead of just trainings_url

The source of truth is crates/coglet/src/transport/http/routes.rs lines 112-133.

Closes #2873

Update the GET / example response in docs/http.md to reflect the actual
fields returned by the coglet Rust server (routes.rs):

- Fix docs_url value: /openapi.json -> /docs
- Fix key name: health_check_url -> healthcheck_url
- Add missing fields: shutdown_url, predictions_idempotent_url,
  predictions_cancel_url
- Document all three training fields instead of just trainings_url

Closes #2873
@markphelps markphelps requested a review from a team as a code owner March 27, 2026 19:50
@markphelps markphelps merged commit a3f77e8 into main Mar 30, 2026
29 checks passed
@markphelps markphelps deleted the fix/http-discovery-docs-drift branch March 30, 2026 15:40
markphelps added a commit that referenced this pull request Mar 30, 2026
….com/replicate/cog into mp/fix/dict-list-output-schema-fixes

* 'mp/fix/dict-list-output-schema-fixes' of https://github.com/replicate/cog: (44 commits)
  bonk code reviews (#2892)
  fix: clarify env variable deny-list error message (#2813)
  fix: use atomic rename in setup_subprocess_double_fork test to prevent race condition (#2815)
  chore(deps): bump github.com/docker/cli (#2885)
  chore(deps): bump ureq from 3.2.0 to 3.3.0 in /crates (#2888)
  docs: fix HTTP discovery endpoint response to match Rust implementation (#2883)
  fix: support PEP 604 unions in File/Path coercion detection (#2878)
  fix: remove mise python venv config to silence warnings (#2879)
  refactor: extract homebrew tap into standalone reusable workflow (#2881)
  chore: 0.17.1 (#2877)
  review: replace string tags with FieldKind enum, add Debug derives, remove redundant test assertion (#2874)
  fix: app id in release workflow for homebrew tap (#2875)
  fix: don't coerce URL strings in str-typed inputs (regression #2868) (#2872)
  use GHCR mirror for cog-base images in integration tests (#2866)
  docs: improve documentation for input/output types (#2864)
  add workflow to mirror cog-base images from r8.im to GHCR (#2871)
  fix: bound fuzz tree size to prevent CI timeout in FuzzJSONSchema
  fix: guard against slice panic on single-char quoted strings in parseTypeFromString
  fix: address review issues in static schema generation
  Bump version to 0.17.0
  ...
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.

docs: HTTP discovery docs drift after Rust migration

1 participant