Skip to content

Commit 5779bd7

Browse files
committed
Update docs
1 parent f666014 commit 5779bd7

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

docs/api.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# How to use the Evergreen API
22

3+
!!! warning
4+
5+
**The Evergreen API is provided free of charge - please don't abuse it**. The API is currently provided by the free tier of Cloudflare Workers which provides up to 100,000 total requests per day. The API is intended for development purposes only and not for use with distributed endpoints.
6+
7+
If you encounter issues or would prefer to ensure data is only sourced from the application vendor, use `Get-EvergreenApp`.
8+
39
Evergreen's difference to other methods of finding and installing applications, is that Evergreen queries only official vendor sources when you use `Get-EvergreenApp`. This ensures that the information returned can be trusted because it comes from the vendor and is not crowd sourced.
410

511
Evergreen supports [an API](https://evergreen-api.stealthpuppy.com/) that returns the same application version information as `Get-EvergreenApp`. The API supports the same applications as the Evergreen module because data is sourced via the module. The API runs on Cloudflare Workers with data that is updated every 8 hours.
@@ -8,9 +14,6 @@ Full documentation for the API is available here: [evergreen-api](https://app.sw
814

915
Data that is returned by the Evergreen API can be viewed at the [Evergreen App Tracker](https://stealthpuppy.com/apptracker/).
1016

11-
!!! attention "Attention"
12-
Support for the Evergreen API is provided as a best effort. The API is currently provided by the free tier of Cloudflare Workers which provides up to 100,000 requests per day. If you encounter issues or would prefer to ensure data is only sourced from the application vendor, use `Get-EvergreenApp`.
13-
1417
## Usage
1518

1619
In its current version, the API has only two endpoints that return data in JSON format - `/apps`, `/app/{appName}`. In PowerShell, the API can be queried with `Invoke-RestMethod`.

docs/endpoints.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ Application Endpoints Ports
5555
MicrosoftEdge {edgeupdates.microsoft.com, www.microsoft.com} {443}
5656
```
5757

58-
## Using Get-EvergreenEndpoint
58+
## Using Get-EvergreenEndpointFromApi
5959

60-
`Get-EvergreenEndpoint` can be used to simplify usage of the API, by returning all endpoints used by Evergreen in a single object. Running `Get-EvergreenEndpoint` with no parameters, will return a complete list of endpoints and ports used for all applications.
60+
`Get-EvergreenEndpointFromApi` can be used to simplify usage of the API, by returning all endpoints used by Evergreen in a single object. Running `Get-EvergreenEndpointFromApi` with no parameters, will return a complete list of endpoints and ports used for all applications.
6161

6262
```powershell
63-
PS C:\> Get-EvergreenEndpoint
63+
PS C:\> Get-EvergreenEndpointFromApi
6464
6565
Application Endpoints Ports
6666
----------- --------- -----
@@ -76,10 +76,10 @@ AdobeAcrobatReaderDC {acrobat.adobe.com, rdc.adobe.io, ardownload2.adobe.com}
7676
AdobeBrackets {brackets.io, api.github.com, github.com} {80, 443}
7777
```
7878

79-
`Get-EvergreenEndpoint` can return endpoints for a single application or an array of with the `-Name` parameter. In the example below `Get-EvergreenEndpoint` is used to return the endpoints and ports for the Microsoft Teams and Microsoft Edge endpoints.
79+
`Get-EvergreenEndpointFromApi` can return endpoints for a single application or an array of with the `-Name` parameter. In the example below `Get-EvergreenEndpointFromApi` is used to return the endpoints and ports for the Microsoft Teams and Microsoft Edge endpoints.
8080

8181
```powershell
82-
PS C:\> Get-EvergreenEndpoint -Name "MicrosoftTeams", "MicrosoftEdge"
82+
PS C:\> Get-EvergreenEndpointFromApi -Name "MicrosoftTeams", "MicrosoftEdge"
8383
8484
Application Endpoints Ports
8585
----------- --------- -----
@@ -89,19 +89,19 @@ MicrosoftTeams {config.teams.microsoft.com, www.microsoft.com, statics.teams.cdn
8989

9090
### Return a simple list of all endpoints
9191

92-
The output of `Get-EvergreenEndpoint` can be filtered to create a simple list of all unique endpoint URLs. The command below will generate an array of URLs that can then be used for an allow list of all endpoints required by Evergreen.
92+
The output of `Get-EvergreenEndpointFromApi` can be filtered to create a simple list of all unique endpoint URLs. The command below will generate an array of URLs that can then be used for an allow list of all endpoints required by Evergreen.
9393

9494
```powershell
95-
PS C:\> Get-EvergreenEndpoint | Select-Object -ExpandProperty "Endpoints" -Unique
95+
PS C:\> Get-EvergreenEndpointFromApi | Select-Object -ExpandProperty "Endpoints" -Unique
9696
```
9797

9898
### Convert output to CSV
9999

100-
The code below can be used to convert the output from `Get-EvergreenEndpoint` to a file in CSV format. The file will include the application name, endpoints URLs in a comma separated list, and ports in a comma separated list.
100+
The code below can be used to convert the output from `Get-EvergreenEndpointFromApi` to a file in CSV format. The file will include the application name, endpoints URLs in a comma separated list, and ports in a comma separated list.
101101

102102
```powershell
103103
$Path = "./Endpoints.csv"
104-
Get-EvergreenEndpoint | ForEach-Object {
104+
Get-EvergreenEndpointFromApi | ForEach-Object {
105105
[PSCustomObject]@{
106106
Application = $_.Application
107107
Endpoints = $_.Endpoints -join ","

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ nav:
146146
- Evergreen API:
147147
- How to use the Evergreen API: api.md
148148
- List endpoints used by Evergreen: endpoints.md
149+
- Changelog: changelog.md
149150
- Resources:
150151
- Troubleshooting: troubleshoot.md
151152
- Known issues: issues.md
152-
- Changelog: changelog.md
153153
- Module help:
154154
- en-US:
155155
- about_Evergreen: help/en-US/about_Evergreen.md

0 commit comments

Comments
 (0)