docs(readme): complete the public API surface table#17
Merged
Conversation
The 'Public API at a glance' table was missing four routes that
exist in the controllers and pyfly's actuator:
* ``GET /api/v1/jobs`` -- the filtered + paginated job listing
(handlers/jobs/list_jobs.py). Filters: ``status``,
``bbox_refine_status``, ``idempotency_key``, ``created_after`` /
``created_before``, ``limit``, ``offset``.
* ``GET /actuator/health/liveness`` and
``GET /actuator/health/readiness`` -- the Kubernetes probes the
deployment doc already references.
* ``GET /openapi.json`` -- the machine-readable spec the
``task openapi`` shortcut downloads.
Also groups the table by purpose (Extraction / Jobs / Service
metadata / Actuator) and enriches the existing rows with the
filter / long-poll details that callers need to know up front
(``wait_for_bboxes`` query param on ``/jobs/{id}/result``;
the cancel constraint on ``DELETE /jobs/{id}``). Full request /
response shapes still live in ``docs/api-reference.md``.
A short RFC 7807 hint follows the table so readers know error
bodies are ``application/problem+json``.
ancongui
added a commit
that referenced
this pull request
May 31, 2026
The 'Public API at a glance' table was missing four routes that
exist in the controllers and pyfly's actuator:
* ``GET /api/v1/jobs`` -- the filtered + paginated job listing
(handlers/jobs/list_jobs.py). Filters: ``status``,
``bbox_refine_status``, ``idempotency_key``, ``created_after`` /
``created_before``, ``limit``, ``offset``.
* ``GET /actuator/health/liveness`` and
``GET /actuator/health/readiness`` -- the Kubernetes probes the
deployment doc already references.
* ``GET /openapi.json`` -- the machine-readable spec the
``task openapi`` shortcut downloads.
Also groups the table by purpose (Extraction / Jobs / Service
metadata / Actuator) and enriches the existing rows with the
filter / long-poll details that callers need to know up front
(``wait_for_bboxes`` query param on ``/jobs/{id}/result``;
the cancel constraint on ``DELETE /jobs/{id}``). Full request /
response shapes still live in ``docs/api-reference.md``.
A short RFC 7807 hint follows the table so readers know error
bodies are ``application/problem+json``.
Co-authored-by: ancongui <andres.contreras@soon.es>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 'Public API at a glance' table was missing four routes that exist in the controllers and pyfly's actuator:
GET /api/v1/jobs— the filtered + paginated job listing (list_jobsquery handler). Filters:status,bbox_refine_status,idempotency_key,created_after/created_before,limit,offset.GET /actuator/health/livenessandGET /actuator/health/readiness— the Kubernetes probes the deployment doc already references.GET /openapi.json— the machine-readable spec thetask openapishortcut downloads.Also groups the table by purpose (Extraction / Jobs / Service metadata / Actuator) and enriches the existing rows with the filter and long-poll details callers need up front (
wait_for_bboxesquery param on/jobs/{id}/result; the cancel constraint onDELETE /jobs/{id}). Full request / response shapes still live indocs/api-reference.md.A short RFC 7807 hint follows the table so readers know error bodies are
application/problem+json.Test plan
pytest tests/unit— 268 passed (docs-only change).docs/api-reference.mdto confirm the README table now matches the controllers.