Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 38 Packages Projects Releases Wiki Activity
15,489 Commits 2 Branches 0 Tags
d651a7ea498dfe72aa8882fac633bfeec229866e
Commit Graph
224 Commits
Author SHA1 Message Date
Rachael ShawMarko LisicaEugeneIan LittmanScott GressVictor LyuboslavskyNoah Talerman
 		33b481fdc8 Docs v4.63.0 (#26019) 
Documentation changes for 4.63.0

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
 2025-02-04 12:38:54 -06:00
Gabriel Hernandez 1c5f13589f fix 500 page when filtering by vulnerabilities on host software (#25816) 
For #25735

This is a fix for the 500 page appearing when filtering for vulnerable
software on the host details page.

Also adds some missing docs for vulnerable query param filter on `GET
hosts/:id/software` endpoint

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
 2025-01-29 12:09:28 +00:00
Jordan Wright d074ba2b48 Fix incorrect source in device mapping REST API docs (#25641) 
### Summary

This PR closes #25640 by fixing the incorrect `source` value in the
device mapping REST API docs.

The real value is `mdm_idp_accounts` which can be found
[here](https://github.com/fleetdm/fleet/blob/15ac79323858c7344677edd5eb01b9a0d548120f/server/fleet/hosts.go#L894).

### Test Plan

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.

I couldn't find any other references to `identity_provider`, so I think
these two were all of them.
 2025-01-24 16:32:03 -06:00
Konstantin Sykulev a1a43415d4 Removed filename from fleet maintained apps response (#25685) 
This field was never implemented

<img width="876" alt="Screenshot 2025-01-21 at 8 33 56 PM"
src="https://github.com/user-attachments/assets/8b110375-e2e2-4805-b42b-676a3030e9d8"
/>
 2025-01-22 18:00:54 -06:00
Rebecca Cowart fecc8bbc07 Update rest-api.md (#25670) 
Fixed typo - misspelling of "endpoint"
 2025-01-22 15:36:13 -06:00
Rebecca Cowart 289e66a568 Update rest-api.md (#25527) 
Added context to the `additional_info_filters` parameter.
 2025-01-16 16:12:11 -06:00
jacobshandlingandJacob Shandling 725ccf6ebc Docs: fix type (#25523) 
This parameter should be a string

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
 2025-01-16 15:52:37 -06:00
Noah Talerman 498ddca753 API reference: clarify 10k character limit for arbitrary scripts (#25470) 2025-01-15 15:14:29 -06:00
Rachael ShawMarko LisicaKonstantin SykulevGeorge KarrVictor LyuboslavskyIan LittmanNoah TalermanLucas Manuel RodriguezEric
 		378b404421 Documentation changes for v4.62.0 (#25315) 
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
 2025-01-09 18:04:34 -06:00
Rachael Shaw 4f68dca1a3 Docs: Update get host example response (#25313) 
Couple changes in advance of API design for #23235 (since certificates
will be available for macOS/iOS/iPadOS):
+ Update "Get host" example response to be a macOS host
+ Update "Get host by device token" example response to be a macOS host
& move weightier items to the bottom for readability
 2025-01-09 16:46:24 -06:00
Rachael Shaw d1a564e387 Docs: Update get host example (#25310) 
+ Update "Get host" example response to be a macOS host (in advance of
API design for #23235, since certificates will be available for
macOS/iOS/iPadOS)
+ Update formatting of "Get host by identifier" to move weightier items
to the bottom
 2025-01-09 15:52:34 -06:00
Rachael Shaw a80466a93c Docs: More readability improvements to "Get host" response (#25228) 
Moved weightier items to the bottom of the response and smaller items up
top.
 2025-01-07 17:17:51 -06:00
Rachael Shaw edbba87d08 API docs: Make "Get host" example response more readable (#25227) 
Moved software array further down in the response.
 2025-01-07 17:11:50 -06:00
Ian Littman 7053731354 Move invite API endpoint docs from Fleet configuration heading to user heading, add missing mfa_enabled fields on invite endpoints (#24986) 
For #24985. Also rewords rather verbose "these are authenticated
endpoints" descriptions for both subheadings.
 2024-12-24 13:49:43 -05:00
jacobshandlingandJacob Shandling 1a1ec72483 Docs: Add platform query param to GET queries API docs (#24999) 
Addresses #23061

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
 2024-12-23 14:40:24 -08:00
Noah Talerman e6b1f73846 API reference docs: Profiles & scripts in GET /config, PATCH /config,GET /teams/:id , and PATCH /teams/:id (#24972) 
Discovered this gap in API reference docs here:
https://github.com/fleetdm/fleet/issues/24789#issuecomment-2555549128
 2024-12-23 15:56:41 -05:00
Katheryn Satterlee d5ce6fa5d1 Clarify automation reset (#24884) 
Updated /automations/reset description to reflect that this endpoint
does not immediately trigger automations, but resets the status of hosts
so that they are seen as newly failing on the next automation run.
 2024-12-19 11:46:55 -06:00
Rachael ShawIan LittmanZach WassermanLucas Manuel RodriguezKonstantin SykulevMarko LisicaNoah Talerman
 		c4a2bb4d6b 4.61 documentation changes (#24833) 
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
 2024-12-17 15:39:24 -06:00
Eugene 039ea91f9b Capitalization fix & added :id information (#24643) 
Fixed capitalization of "Default response" and id information for
modiifying a package
 2024-12-12 12:50:49 -06:00
Eugene f1ea2360d2 Edit the "List activities" description. (#24562) 
Edited for length and clarity
 2024-12-11 17:33:56 -05:00
Noah TalermanandRachael Shaw 68f2d99b25 API reference docs: disk encryption is cross-platform (#24588) 
API reference doc changes for the following story:
- #22074

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-12-10 16:52:29 -06:00
Noah Talerman 8fe05fcf93 API reference: run script w/ team_id and script_name (#24484) 2024-12-10 13:39:24 -06:00
Ian Littman 4e27aebb5b Indicate that we show date only (not date and time) for build_date in version endpoint response (#24388) 
For #24293.
 2024-12-04 18:24:44 -05:00
Marko Lisica ad83e71e39 [API design] Custom OS settings: "include any label" option for custom target (#23647) 2024-12-03 18:17:42 -05:00
Brock WaltersandRachael Shaw f09d6fd797 Update rest-api.md (#24021) 
Added note to get Setup Experience section warning against setting
custom URL values in custom profile. This was tested by CSA &
customer-starchik.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-12-02 10:53:10 -06:00
Rachael Shaw 6fd3ebf4cf Docs v4.60.0 (#24197) 2024-11-27 15:21:16 -06:00
Rachael Shaw 249189fc0c Remove docs for #22464 (#23936) 
Missed this one when updating v4.59 docs branch: #22464 is still on the
drafting board.
 2024-11-18 18:08:55 -06:00
Rachael Shaw 2e779db0a8 Docs: v4.59.1 API changes (#23928) 
Bring in @lucasmrod's changes from
https://github.com/fleetdm/fleet/pull/23743
 2024-11-18 16:26:05 -06:00
RachelElysia 4f3bf6439e Docs: Update software status docs using old 'failed' value (#23848) 2024-11-18 09:04:32 -05:00
Rachael Shaw f5598e003c Docs v4.59.0 (#23693) 2024-11-12 11:05:45 -06:00
Victor Lyuboslavsky c4c1b65492 NDES REST API and config doc changes (#22968) 2024-11-12 11:05:33 -06:00
Rachael Shaw df6da8101f API docs: fix queries response formatting (#23698) 
Fix indentation
 2024-11-11 15:27:31 -06:00
Rachael Shaw 9585ca7d9a Docs: Fix formatting issues in API responses (#23692) 
+ Fixed some indentation
+ Added some missing commas and colons
+ Removed some duplicate keynames
 2024-11-11 14:08:14 -06:00
Sarah Gillespie 3ea68ae1e7 Update guide to puppet module (#23369) 2024-11-06 16:57:59 -06:00
Ian Littman 06ad3ecb6b Clarify OS update enforcement details in REST API docs (#23464) 
This applies some consistency fixes as well (e.g. noting that Mac/Win
enforcement requires MDM). Also removed mention of MDM on iOS/iPadOS
enforcement as if an iOS/iPadOS host is enrolled, it's enrolled via MDM.

See #21998
 2024-11-01 14:12:01 -05:00
Marko Lisica c381c301a0 Make file extensions lowercase (#23228) 
File extensions should be written in lowercase with . in front of the
extension (e.g. .exe, .pkg, etc).
 2024-10-25 14:35:32 -05:00
Ian Littman 4e38e8e5c5 s/urf-8/utf-8 on manual config profile download (#23169) 
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
 2024-10-24 09:54:24 -07:00
Harrison RavazzoloandRachael Shaw 3eb3d85ac8 Add a line to docu 'turn off mdm' is only available on macOS' (#23155) 
Add line indicating 'turn off mdm' is only available on macOS

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-10-23 17:53:37 -05:00
Marko Lisica 3c3e6d6d1a Add callout that software-related features are experimental (#23089) 2024-10-22 15:43:56 -05:00
Rachael Shaw 4cc3e3bb63 Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Noah Talerman 43060bfdc8 Reference docs: default timeout for scripts and software (#22908) 
- We made script timeouts configurable in this user story: #16645
- We added a default timeout for software in this bug: #22558
 2024-10-16 09:19:02 -04:00
Ian LittmanandRachael Shaw 841d8dcd86 Add warning on populate_software query for hosts list endpoint (#22945) 
#22291

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-10-15 16:49:21 -05:00
Katheryn Satterlee 3e44610200 Remove dead links (#22635) 
Removed dead links for os versions in 'hosts' endpoint list

# Checklist for submitter

Docs only change
 2024-10-04 14:28:37 -05:00
Marko Lisica c545495f60 API design: Self-service: Install Apple App Store apps on macOS (#22102) 
API design for:
- #19620
 2024-10-01 17:09:33 -04:00
Noah Talerman beec753a3f API docs: OTA enrollment profile (#22457) 
- Bring OTA enrollment profile endpoint into REST API docs
 2024-10-01 17:07:30 -04:00
Noah TalermanandRachael Shaw 0e22e4676e Add missing anchor link (#22427) 
Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-09-26 13:48:25 -05:00
Marko Lisica 8c705533ea Document packages_only flag for list software titles endpoint (#22390) 2024-09-25 16:17:38 -05:00
Dante Catalfamo d83ed46373 Add batch app store apps documentation (#21912) 2024-09-23 18:09:31 -05:00
Noah TalermanRachael ShawmostlikeleeTim LeeMarko LisicaIan LittmanLuke Heath
 		adf19c4527 Reference docs for v4.57.0 (#22319) 
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: mostlikelee <tim@mostlikelee.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Marko Lisica <markol.lisica@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
 2024-09-23 15:56:59 -05:00
Noah TalermanMartin AngersDante CatalfamoMarko LisicaGeorge KarrGabriel HernandezRachael Shaw
 		1677783064 GitOps & API design: Add multiple Apple Business Manager and Volume Purchasing Program connections (#21043) 
GitOps and API changes for the following story:
- #9956

DONE: 
- ~~Contributor API endpoints to support best practice GitOps (`fleetctl
gitops`) and backwards compatibility GitOps (`fleetctl apply`)~~
  - https://github.com/fleetdm/fleet/pull/21043#issuecomment-2338218929

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-09-20 12:21:52 -05:00