add export endpoint documentation - #263
Conversation
There was a problem hiding this comment.
Pull request overview
Adds REST API reference documentation for the TSV Export System introduced in Landscape 26.10, covering export creation for computers/activities and export job management endpoints.
Changes:
- Added a new REST API reference page documenting
/exportsjob management (list/get/cancel/download/delete). - Documented new export initiation endpoints:
POST /computers/exportsandPOST /activities/exports. - Updated documentation spellcheck wordlist to include “TSV/tsv”.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference/api/rest-api-endpoints/exports.md | New page documenting export job management endpoints under /exports. |
| docs/reference/api/rest-api-endpoints/computers.md | Adds POST /computers/exports documentation and fixes punctuation in an existing note. |
| docs/reference/api/rest-api-endpoints/activities.md | Adds POST /activities/exports documentation. |
| docs/.custom_wordlist.txt | Adds TSV/tsv to custom dictionary. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@rubinaga This shouldn't go into But if these endpoints aren't live yet / they won't be live until the next release, then |
|
@rubinaga can this be merged? |
|
(responding to the standup discussion) If this is going in 26.10 only, not the point release, let's leave the PR open, and it can be merged after the point release. Ideally we'd have a specific branch for changes like that (i.e., presumably this change would still go in We're also planning to version the docs likely this cycle (in roadmap) or next if it doesn't make the cut. How we release will need to be revisited at that time anyway. |
Adds REST API reference documentation for the TSV Export System, available starting in Landscape 26.10.
POST /computers/exportsadded to the Computers endpointsPOST /activities/exportsadded to the Activities endpointsexports.mdpage for the /exports management endpoints (list, get, cancel, download, delete)