Merge pull request #728 from google/dvanderb-update-batch-docs

Update batch documentation
google · Apr 6, 2021 · e296cd6 · e296cd6 · jhoneDoe993 · Feb 4, 2022
2 parents 2370756 + 52fa020
commit e296cd6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 149 deletions.
diff --git a/docs/batch.md b/docs/batch.md
@@ -7,12 +7,12 @@ The JavaScript client library supports batching HTTP requests to make multiple A
 The JavaScript client library defines an object called `Batch`. You can start by instantiating this object:
 
 ```js
-var batch = gapi.client.newBatch();
+const batch = gapi.client.newBatch();
 ```
 
 ## Adding requests to the batch
 
-Use the `Batch` object's [`add`](reference.md#----gapiclientbatchaddrequestopt_params--) method to add individual HTTP requests. The `add` method supports one optional parameter:
+Use the `Batch` object's [`add`](reference.md#----gapiclientbatchaddrequestopt_params--) method to add individual HTTP requests. Only requests created via [discovery](discovery.md) should be added to a batch. The `add` method supports one optional parameter:
 
 <table>
  <colgroup>
@@ -49,19 +49,18 @@ Use the `Batch` object's [`add`](reference.md#----gapiclientbatchaddrequestopt_p
 Example:
 
 ```js
-var searchRequest = function(name) {
- return gapi.client.request({
- 'path': 'plus/v1/people',
- 'params': {'query': name}
- });
-};
-var searchAlvin = searchRequest('Alvin');
-var searchSimon = searchRequest('Simon');
+const getMe = gapi.client.people.people.get({
+ 'resourceName': 'people/me'
+});
+
+const getYou = gapi.client.people.people.get({
+ 'resourceName': 'people/you'
+});
 
 // Adding just the request
-batch.add(searchAlvin);
+batch.add(getMe);
 // Adding the request with an ID
-batch.add(searchSimon, {'id': 'searchSimon'});
+batch.add(getYou, {'id': 'getYou'});
 ```
 
 ## Executing a batch

diff --git a/samples/httpBatch.html b/samples/httpBatch.html