Skip to content

Commit 8148a34

Browse files
committed
Added license id to community api docs
Signed-off-by: rishabhjhs <ragarwal@progress.com>
1 parent 6f8dd10 commit 8148a34

File tree

2 files changed

+26
-14
lines changed

2 files changed

+26
-14
lines changed

content/chef_install_script.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,19 @@ Use the Chef install script to install packages on UNIX, Linux, and macOS system
9292
By default the script installs the latest available version of Chef Infra Client:
9393

9494
```bash
95-
curl -L https://chefdownload-community.chef.io/install.sh | sudo bash
95+
curl -L https://chefdownload-community.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash
9696
```
9797

9898
Use the `-P` option to specify a Chef application to install:
9999

100100
```bash
101-
curl -L https://chefdownload-community.chef.io/install.sh | sudo bash -s -- -P <PROJECT>
101+
curl -L https://chefdownload-community.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash -s -- -P <PROJECT>
102102
```
103103

104-
Replace `<PROJECT>` with the application you want to install.
104+
Replace:
105+
106+
- `<LICENSE_ID>` with your license ID
107+
- `<PROJECT>` with the application you want to install
105108

106109
For additional script install options, see the [script options](#script-options).
107110

@@ -112,15 +115,19 @@ On Windows systems, you can install Chef software using the Powershell install s
112115
By default the script installs the latest available version of Chef Infra Client:
113116

114117
```powershell
115-
. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install
118+
. { iwr -useb https://chefdownload-community.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install
116119
```
117120

121+
Replace `<LICENSE_ID>` with your license ID.
122+
118123
Use the `-project` option to specify a Chef application to install:
119124

120125
```powershell
121-
. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install -project <PROJECT>
126+
. { iwr -useb https://chefdownload-community.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install -project <PROJECT>
122127
```
123128

129+
Replace `<LICENSE_ID>` with your license ID.
130+
124131
For additional script install options, see the [script options](#script-options).
125132

126133
## Script options

content/download/community.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,45 +70,45 @@ Use `packages` to get a list of all packages for a particular product.
7070
By default, it returns packages for the latest version.
7171

7272
```plain
73-
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages
73+
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?license_id=<LICENSE_ID>
7474
```
7575

7676
You can specify a version number with the `v` query string to get packages for a particular product version.
7777

7878
```plain
79-
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?v=<VERSION_NUMBER>
79+
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?v=<VERSION_NUMBER>&license_id=<LICENSE_ID>
8080
```
8181

8282
### versions/all
8383

8484
Use `versions/all` to return a list of versions of a product.
8585

8686
```plain
87-
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/all
87+
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/all?license_id=<LICENSE_ID>
8888
```
8989

9090
### versions/latest
9191

9292
Use `versions/latest` to return the latest version of a product.
9393

9494
```plain
95-
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/latest
95+
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/latest?license_id=<LICENSE_ID>
9696
```
9797

9898
### metadata
9999

100100
The `metadata` endpoint returns data about a particular package of a Chef product.
101101

102102
```plain
103-
https://chefdownload-community.chef.io/stable/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
103+
https://chefdownload-community.chef.io/stable/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
104104
```
105105

106106
### download
107107

108108
The `download` endpoint downloads a particular package of a Chef product.
109109

110110
```plain
111-
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
111+
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
112112
```
113113

114114
## Parameters
@@ -120,6 +120,11 @@ The API accepts the following parameters in a query string.
120120

121121
A list of valid product keys can be found in the [Chef product matrix](https://github.com/chef/mixlib-install/blob/main/PRODUCT_MATRIX.md) or by using the [`products`](#products) endpoint.
122122

123+
`license_id`
124+
: Your license ID.
125+
126+
A license is required to download packages and retrieve package metadata with this API.
127+
123128
`eol`
124129
: Whether to include EOL versions of a product or EOL products in the response.
125130

@@ -174,7 +179,7 @@ This is a list of currently supported products that you can install with this AP
174179
To get the latest supported build of Chef Infra Client for Ubuntu 20.04, enter the following:
175180

176181
```plain
177-
https://chefdownload-community.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64
182+
https://chefdownload-community.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64&license_id=<LICENSE_ID>
178183
```
179184

180185
which will return something like:
@@ -191,11 +196,11 @@ version "14.15.6"
191196
To use cURL to download a package directly, enter the following:
192197

193198
```bash
194-
curl -LOJ 'https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>'
199+
curl -LOJ 'https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>'
195200
```
196201

197202
To use GNU Wget to download a package directly, enter the following:
198203

199204
```bash
200-
wget --content-disposition https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>
205+
wget --content-disposition https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>
201206
```

0 commit comments

Comments
 (0)