Skip to content

Clarify adapter header documentation #1818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rwjblue merged 1 commit into from
Mar 20, 2014
Merged

Clarify adapter header documentation #1818

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions packages/ember-data/lib/adapters/rest_adapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,10 @@ var forEach = Ember.ArrayPolyfills.forEach;

### Headers customization

Some APIs require HTTP headers, e.g. to provide an API key. An array of
headers can be added to the adapter which are passed with every request:
Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary
headers can be set as key/value pairs on the `RESTAdapter`'s `headers`
object and Ember Data will send them along with each ajax request.


```js
DS.RESTAdapter.reopen({
Expand All @@ -99,6 +101,20 @@ var forEach = Ember.ArrayPolyfills.forEach;
});
```

`headers` can also be used as a computed property to support dynamic
headers.

```js
App.ApplicationAdapter = DS.RESTAdapter.extend({
headers: function() {
return {
"API_KEY": this.get("session.authToken"),
"ANOTHER_HEADER": "Some header value"
};
}.property("session.authToken")
});
```

@class RESTAdapter
@constructor
@namespace DS
Expand Down Expand Up @@ -138,8 +154,9 @@ var RESTAdapter = Adapter.extend({
*/

/**
Some APIs require HTTP headers, e.g. to provide an API key. An array of
headers can be added to the adapter which are passed with every request:
Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary
headers can be set as key/value pairs on the `RESTAdapter`'s `headers`
object and Ember Data will send them along with each ajax request.

```javascript
DS.RESTAdapter.reopen({
Expand Down