Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 22 Packages Projects Releases Wiki Activity
13,423 Commits 2 Branches 0 Tags
35c172dcfde83ecd01a141e2d3309a2f1a3cd34a
Commit Graph
171 Commits
Author SHA1 Message Date
Rachael Shaw f5720d38a4 Docs: Use consistent naming for parameter types (#21787) 
bool ➡️ boolean
list ➡️ array
 2024-09-03 14:40:58 -05:00
Noah Talerman 904234251f App deployment API endpoints are experimental (#21615) 
App deployment features are experimental features:
https://fleetdm.com/handbook/company/product-groups#experimental-features
 2024-09-03 12:33:09 -04:00
Noah Talerman aa952962b5 API design: Fleet MDM features depend on MDM name (#21279) 
API design for this bug: #18977 

Documentation story is here: 
- #20373
 2024-09-03 12:32:39 -04:00
Noah Talerman d44d675568 Fix API docs bug (#21263) 
Broken label's don't have an `id` (they've been deleted):
https://github.com/fleetdm/fleet/pull/21162#discussion_r1713715452
 2024-09-03 12:32:18 -04:00
Luke Heath b59918d8c4 Use consistent experimental wording in REST API docs (#21600) 2024-08-27 17:14:38 -04:00
Noah Talerman d3b3784620 Mark App Store apps API endpoints as experimental (#21379) 
API endpoints are associated with the following experimental features:
- #19447
- #18867 

Fleet's handbook
[here](https://fleetdm.com/handbook/company/product-groups#experimental-features):
![Screenshot 2024-08-16 at 1 25
33 PM](https://github.com/user-attachments/assets/e0c76309-aae3-4c2d-9685-5f046060115a)
 2024-08-17 11:20:06 -07:00
Mike ThomasEricNoah Talerman
 		2171544ad1 Docs quick reference optimization (#21331) 
This PR closes https://github.com/fleetdm/fleet/issues/21108

@noahtalerman, I double-checked all redirects, and they are working.
Clicking through the URLs in [this
spreadsheet](https://docs.google.com/spreadsheets/d/1djVynIMuJK4pT5ziJW12CluVqcaoxxnCLaBO3VXfAt4/edit?usp=sharing)
is a pretty quick way to go through them all. Note that "Audit logs" and
"Understanding host vitals" redirect to the contributor docs on GitHub,
so they will throw a 404 until this is merged.

Some new guides benefitted from a name change, so they make more sense
as stand-alone guides, and also so that we don't have to mess around
with more redirects later. Those name changes followed [this
convention](https://fleetdm.com/handbook/company/communications#headings-and-titles),
which was recently documented in the handbook.

Have fun!

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
 2024-08-16 15:30:31 -05:00
Noah Talerman 934c02a5c2 API design: Install App Store apps on iOS/iPadOS (#20892) 
API changes for the "Install App Store apps on iOS/iPadOS" story
(#19447)
 2024-08-16 10:33:24 -07:00
Noah Talerman 0fd892e296 API design: Ability to add software to "No Team" (#20489) 2024-08-09 12:54:09 -07:00
Marko Lisica 0a2a48b6d8 API design: Install Apple App Store apps on macOS (#19291) 2024-08-09 10:00:21 -07:00
Noah Talerman accfd7d4e8 API design: OS updates for iOS/iPadOS (#20460) 2024-08-09 09:59:31 -07:00
Noah Talerman 82532ec4d6 API reference docs: Parts of Get software are experimental (#21164) 
- We forgot to mark this endpoint as having experimental features
 2024-08-07 16:25:45 -07:00
Noah Talerman d5c9caa5b9 API reference docs: clarify profiles and labels (#21162) 
- Only one of either `labels_include_all` or `labels_exclude_any` can be
included in the request.
- Add missing labels `id` in `GET /configuration_profiles` and `GET
/configuration_profiles/:uuid`
 2024-08-07 16:25:31 -07:00
Noah Talerman dc24c43575 API docs cleanup (#21072) 
- Update sentence to be clearer
 2024-08-06 16:05:17 -07:00
RachelElysia 357dc91c42 Fleet docs: Add API validations to doc for patching app config (#20758) 2024-08-06 10:28:28 -04:00
Noah Talerman 0f41fc1a8d API design: Hide "Self-service" if there's no self-service software (#20908) 2024-08-02 12:49:20 -07:00
Marko Lisica 5820d028e0 API design: Improve host identifiers in the docs, CLI and API (#19752) 
API design for: #19127
 2024-08-01 11:11:07 -04:00
Noah Talerman 935f489397 Guide and API reference: Show iOS & iPadOS as supported platforms in the UI (#20746) 
Guide and API reference changes for the following story:
- #19319
 2024-07-26 16:04:35 -04:00
Marko LisicaandNoah Talerman 36c1b918d3 API design: Scope configuration profiles to hosts by excluding any label (#20614) 
API design for:  #17315

Old PR: #18844

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
 2024-07-26 12:32:02 +02:00
Noah Talerman b77f9070be API design: Add host's next scheduled maintenance window to "Get host" (#20745) 
API changes for the following story:
- #18554
 2024-07-25 18:28:24 -04:00
Noah Talerman 7195126ce6 API reference: Wipe iOS/iPadOS (#20766) 2024-07-25 15:26:13 -07:00
Marko Lisica 7ff93583e8 API changes: Increase timeout limit for scripts (#20650) 
API changes for:  #16645
 2024-07-25 18:25:48 -04:00
Noah Talerman 0a37118660 API design: Filters for fleetctl get mdm-commands (#20623) 
API design for:
-  #19143
 2024-07-25 18:13:49 -04:00
Marko Lisica e385f2c75a Mark software API endpoints as experimental (#20658) 
- Mark new API endpoints or API endpoints that were changed as part of
Fleet's first app management feature (#14921) as experimental.
- Call out what is experimental exactly (the endpoint or new keys/values) and
point to changes
 2024-07-24 18:35:57 -04:00
Rachael Shaw e4044c5d63 Documentation for query_report_cap config (#20414) 
- Add documentation for the `query_report_cap` config option. For #19600
 2024-07-15 14:10:34 -04:00
James Kane 4e0c447daa Add "exclude software" parameter to get host by identifier (#20133) 
For #19540

Just added the same "exclude_software" functionality that exists in "get
hosts" to the "get host by identifier" function.

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
 2024-07-11 15:48:15 -05:00
Tim Lee 812140a760 Add createdAt to Vulnerability responses (#20019) 2024-07-09 11:09:16 -06:00
Marko LisicaRachael ShawNoah TalermanMartin Angers
 		055145b7d3 API design: Software self-service (#20223) 
API design for:
- #17587

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
 2024-07-09 18:23:44 +02:00
Marko Lisica 606fa14ed4 Fix broken link (#20151) 
Link isn't working (org_setings)
 2024-07-03 16:29:10 -05:00
Marko Lisica 9299f303e7 List software API: Fix the typo (#20155) 
Fix the typo `GET /software/titles` > `available_for_install` param.
 2024-07-02 13:59:20 -05:00
Noah Talerman 0076148a79 Docs: GitOps reference (#19740) 
Docs for Fleet's best practice GitOps: #13643 (also #17043)
 2024-07-02 11:11:43 -04:00
Rachael Shaw dc9a94abfc REST API docs: fix a few "Modify configuration" parameter descriptions (#20137) 
Follow up from https://github.com/fleetdm/fleet/pull/20109: there were a
few descriptions that just said "body" because of some table rows with
an extra column I missed when merging in recent updates.
 2024-07-01 17:05:29 -05:00
Rachael Shaw 1c3448eb42 Update how we document the objects in the "Modify configuration" parameters (#20109) 
Since the "Modify config" parameters are mostly a bunch of different
objects, it's a bit unwieldy to document in one table. Trying out a new
format to see if it feels like the right way to document nested objects
in API parameters.
 2024-07-01 16:51:56 -05:00
Noah Talerman 93eb61057c API design: Find hosts with the most issues (#20122) 
API changes for the "Find hosts with the most issues" story
- #18115
 2024-07-01 16:06:21 -04:00
Noah TalermanandVictor Lyuboslavsky 5775f47a28 API design: Get unlock PIN immediately after locking macOS host (#20123) 
API changes for the "Get unlock PIN immediately after locking macOS
host" story (https://github.com/fleetdm/fleet/issues/19545)

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
 2024-07-01 13:45:01 -05:00
RachelElysia f26acee2e1 Fleet docs: Update config > sso settings documentation (#20092) 2024-06-28 13:42:14 -04:00
RachelElysia 077915eb38 Fleet docs: Update config > features documentation (#20087) 2024-06-28 13:32:57 -04:00
Eric e10b6c72c7 Docs: Update broken link in REST API documentation (#20060) 
Closes: https://github.com/fleetdm/fleet/issues/20041

Changes:
- Updated a link to a moved section in the scripts section of the REST
API documentation
 2024-06-27 18:31:45 -05:00
Rachael Shaw a59cfc00be 16961 API changes (#20049) 
API changes for #16961 

See https://github.com/fleetdm/fleet/pull/17609
 2024-06-27 09:52:48 -05:00
Victor Lyuboslavsky e3510cdcf6 Add exclude_software query param to hosts endpoint. (#19617) 
API docs change for #19348
 2024-06-20 08:06:46 -05:00
Noah Talerman a327aacdc4 REST API docs: Fix typo (#19729) 2024-06-13 13:43:17 -04:00
Marko LisicaandRachael Shaw f71819a673 API design: Webhooks for global activity feed (#19725) 
API design for: #14722

Co-authored-by: Rachael Shaw <r@rachael.wtf>
 2024-06-13 17:31:56 +02:00
Noah Talerman 80677d1dd0 REST API docs: Add policy (#19699) 
- Fix typo in descriptions
- Remove legacy/deprecated way of adding a policy
 2024-06-12 18:30:28 -04:00
Noah Talerman bac033e0d6 REST API docs: manual enrollment profile (#19593) 
- Clarify that the manual enrollment profile is unsigned
 2024-06-12 18:29:19 -04:00
Rachael ShawandNoah Talerman 5b4488c6b7 API docs: Update macos_settings and windows_settings format (#19476) 
Noticed several places where the structure of
`mdm.macos_settings.custom_settings` and
`mdm.windows_settings.custom_settings` didn't match the example response
for "Get configuration" (which I think is the most up-to-date).

(Will follow up and update the parameter descriptions for
`mdm.macos_settings.custom_settings`/`mdm.windows_settings.custom_settings`
to clarify they're objects with `path` and `labels` once
https://github.com/fleetdm/fleet/pull/19424 is merged.)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
 2024-06-12 15:45:26 -05:00
Rachael Shaw 77228ff433 Fleet configuration API docs: Document server_settings.enable_analytics (#19384) 
`server_settings.enable_analytics` was only documented in the "Get
configuration" endpoint and nowhere else. Added to "Modify
configuration" params and example response.
 2024-05-30 14:24:19 -05:00
Rachael Shaw 61f366fe3a #18187 API docs: AI-generated calendar description for policy remediation (#19383) 
Documents the new Fleet configuration setting:
`server_settings.ai_features_disabled`

For #18187
 2024-05-30 14:09:25 -05:00
Rachael Shaw 8daa61d963 #15605 API docs: Merge inherited & team queries/policies (#19375) 
New PR to avoid affecting PR open time KPI. See previous PR discussion
here: https://github.com/fleetdm/fleet/pull/17227
 2024-05-30 12:16:08 -05:00
Rachael Shaw 9afe9f3e0c #16989 API design: Settings to automatically delete activity (#19374) 
New PR to avoid affecting PR open time KPI. See draft PR for previous
discussion: https://github.com/fleetdm/fleet/pull/17809
 2024-05-30 12:07:38 -05:00
Noah Talerman 23e80f2ce4 API design: Deploy security agents to macOS, Windows, and Linux hosts (#19245) 
API changes for:
- #14921
 2024-05-23 17:07:07 -04:00