Skip to content

signals deletion: rename type managed_agent → agent, simplify descriptions - #1

Closed
aupadhyay-shark wants to merge 1 commit into
satyambhalla:satyam/fi-609-signals-deletion-openapifrom
aupadhyay-shark:fi-609-fix-deletion-type-agent
Closed

aupadhyay-shark wants to merge 1 commit into
satyambhalla:satyam/fi-609-signals-deletion-openapifrom
aupadhyay-shark:fi-609-fix-deletion-type-agent

Conversation

@aupadhyay-shark

Copy link
Copy Markdown

Summary

Align the deletion spec with the live prod API and match the existing export endpoint style.

Changes

  • Type rename: managed_agent → agent in all enums, examples, descriptions, and curl samples. The prod API now returns "type": "agent" (cthulhu#180125).
  • Simpler descriptions: Shortened operation descriptions to match the export endpoints — short paragraphs, no tables.
  • 9 files touched, net -34 lines.

Validation

  • make bundle ✅
  • make lint — 0 errors (6 pre-existing warnings on main)
  • All endpoints tested on prod: POST (202/200), GET (200/404), LIST with pagination — 13/13 pass

In sync with

Tracking: FI-609

Made with Cursor

…tions

- Rename enum value managed_agent → agent in models, examples, and responses
  to match the live prod API (cthulhu#180125).
- Simplify operation descriptions to match the export endpoint style:
  short paragraphs, no tables in description blocks.
- make bundle + make lint: 0 errors.

Co-authored-by: Cursor <cursoragent@cursor.com>
satyambhalla added a commit that referenced this pull request Oct 9, 2026
Adopt the shorter, table-free style from #1 to match
the export endpoints, and note that deletion_id is a ULID.

Keep the facts that product docs also state: the Harness Runtime
Environment Config ID note on agent_id, waiting for an agent deletion to
finish before re-enabling signals, data staying hidden after a failed
job and retrying by resending, inference deletions covering only earlier
requests, export files not being deleted, the 429 active-job limit, and
newest-first list ordering.

Co-authored-by: aupadhyay-shark <aupadhyay@digitalocean.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@satyambhalla

Copy link
Copy Markdown
Owner

Thanks @aupadhyay-shark! I folded this into digitalocean#1260 in 2ebdc56 (with you as co-author) instead of merging. This branch conflicts with 8ec2b3b, which had already made the same managed_agent → agent rename.

Taken from this PR: the shorter, table-free descriptions matching the export endpoints, the ULID note on deletion_id, and the shorter field and response wording.

Kept, in the same short style, because the existing Signals spec or product-docs#6787 relies on them:

  • "For Harness Runtime, this is the Environment Config ID." on both agent_id fields. Add Signals API endpoints to OpenAPI spec (FI-610) digitalocean/openapi#1253's review added this, and every other Signals agent_id has it.
  • agent deletions: data is hidden and collection is disabled immediately, even if the job fails; wait until the job is complete before re-enabling signals.
  • inference deletions only cover requests made before the deletion.
  • To retry a failed job, send the same request again. Earlier export files are not deleted.
  • The 429 active-job limit, "newest first" on list, and that end_cursor is present only when there are more results.

make bundle and make lint still show 0 errors.

RohithSangati pushed a commit to digitalocean/openapi that referenced this pull request Oct 9, 2026
* Add Signals data deletion endpoints to OpenAPI spec (FI-609)

Document the three Signals data deletion endpoints:

  - POST /v1/signals/deletions               (create deletion job)
  - GET  /v1/signals/deletions               (list deletion jobs)
  - GET  /v1/signals/deletions/{deletion_id} (get deletion job)

Create returns 202 for a new job and 200 when an active job for the
same target is reused. type and team_id are required; agent_id is
required for managed_agent and must be omitted for inference. Create
requires the signals:delete scope; get and list use signals:read.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Align Signals deletion spec with product docs and #1253 conventions

- Describe deletion types in terms of agents (Harness Runtime Environment
  Config ID) and Serverless Inference, matching the existing Signals spec.
- List what is deleted as sessions, dialogues, and signal reports, and note
  that earlier export files are not removed, matching product docs.
- Document consent being disabled for managed_agent deletions and that
  inference deletions only cover data collected before the request.
- Drop the internal error text from examples and use well-formed cursors.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Rename Signals deletion type managed_agent to agent

signals-api now accepts and returns type "agent" (cthulhu#180125), and
doctl#2021 and godo#1152 use the same name. Also document that a failed
agent deletion keeps the data hidden and collection disabled, and that
retrying means submitting the request again, matching product docs.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Simplify Signals deletion descriptions

Adopt the shorter, table-free style from satyambhalla#1 to match
the export endpoints, and note that deletion_id is a ULID.

Keep the facts that product docs also state: the Harness Runtime
Environment Config ID note on agent_id, waiting for an agent deletion to
finish before re-enabling signals, data staying hidden after a failed
job and retrying by resending, inference deletions covering only earlier
requests, export files not being deleted, the 429 active-job limit, and
newest-first list ordering.

Co-authored-by: aupadhyay-shark <aupadhyay@digitalocean.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: aupadhyay-shark <aupadhyay@digitalocean.com>
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.

2 participants