Skip to content

Commit

Permalink
Merge pull request #82 from akamai/release/v3.1.3
Browse files Browse the repository at this point in the history
Release/v3.1.3
  • Loading branch information
piotrpio authored Feb 22, 2022
2 parents 73d8c89 + 0eb6796 commit 479a659
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# RELEASE NOTES

## 3.1.3 (Feb 22, 2022)

#### IMPROVEMENTS:
* Update various dependencies

#### BUG FIXES
* Bump axios to 0.26.0 to get rid of vulnerability in [follow-redirects](https://security.snyk.io/vuln/SNYK-JS-FOLLOWREDIRECTS-2396346)

## 3.1.2 (Nov 3, 2021)

#### NOTES:
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ You can find the most up-to-date package in [NPM](https://www.npmjs.com/package/

> __IMPORTANT:__ Akamai will not maintain the `edgegrid` package in NPM going forward.
## Installation
## Install

`npm install --save akamai-edgegrid`

## Example

### Credentials

To use Akamai APIs you must first register and authorize a set of credentials through [Control Center](https://control.akamai.com). You can find more information on creating and authorizing credentials at [Authenticate with EdgeGrid](https://developer.akamai.com/getting-started/edgegrid).
Before you begin, you need to [Create authentication credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) in [Control Center](https://control.akamai.com).

### .edgerc authentication

Expand Down Expand Up @@ -95,9 +95,14 @@ eg.auth({
console.log(body);
});
```

This is an example of an API call to [List groups in your property](https://developer.akamai.com/api/core_features/property_manager/v1.html#getgroups). Change the `path` element to reference an endpoint in any of the [Akamai APIs](https://developer.akamai.com/api).

### Headers

Headers for the request must be supplied in an object as name-value pairs. You do not need to supply form-data headers or content lengths - that will cause authentication headers on the API.
Enter request headers as name-value pairs in an object.

> **NOTE:** You don't need to include the `Content-Type` and `Content-Length` headers. The authentication layer adds these values.
```javascript
eg.auth({
Expand All @@ -111,8 +116,7 @@ eg.auth({

### Body data

The request `body` can be provided as either an object or as a POST data formed string.

You can provide the request `body` as either an object or as a POST data form string.

```javascript
// Object
Expand All @@ -128,8 +132,7 @@ eg.auth({

### Query string parameters

Query string parameters must be supplied in an object as name-value pairs and
passed to the `auth` method under the `qs` property.
When entering query parameters use the `qs` property under the `auth` method. Set up the parameters as name-value pairs in a object.

```javascript
eg.auth({
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "akamai-edgegrid",
"version": "3.1.2",
"version": "3.1.3",
"description": "Authentication handler for the Akamai OPEN EdgeGrid Authentication scheme in Node.js",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 479a659

Please sign in to comment.