Skip to content

add export endpoint documentation - #263

Open
rubinaga wants to merge 4 commits into
developfrom
add-export-api-endpoints
Open

add export endpoint documentation#263
rubinaga wants to merge 4 commits into
developfrom
add-export-api-endpoints

Conversation

@rubinaga

Copy link
Copy Markdown
Contributor

Adds REST API reference documentation for the TSV Export System, available starting in Landscape 26.10.

  • POST /computers/exports added to the Computers endpoints
  • POST /activities/exports added to the Activities endpoints
  • New exports.md page for the /exports management endpoints (list, get, cancel, download, delete)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 /exports job management (list/get/cancel/download/delete).
  • Documented new export initiation endpoints: POST /computers/exports and POST /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.

Comment thread docs/reference/api/rest-api-endpoints/computers.md Outdated
Comment thread docs/reference/api/rest-api-endpoints/exports.md
@rubinaga
rubinaga requested a review from YanisaHS June 22, 2026 13:31
@YanisaHS

YanisaHS commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

@rubinaga This shouldn't go into main though, right? (see our internal doc)

But if these endpoints aren't live yet / they won't be live until the next release, then develop

@rubinaga
rubinaga changed the base branch from main to develop June 29, 2026 12:06
@YanisaHS

Copy link
Copy Markdown
Collaborator

@rubinaga can this be merged?

@YanisaHS

Copy link
Copy Markdown
Collaborator

(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 develop, and anything specific to point releases would go in that version branch)

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.

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.

3 participants