Skip to content
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

Jump to bottom

fix: update request headers, formatting, and jsdoc #616

Merged
merged 1 commit into from May 10, 2019
Merged

fix: update request headers, formatting, and jsdoc #616

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions .kokoro/lint.sh
View file
Open in desktop
Expand Up @@ -23,9 +23,11 @@ cd $(dirname $0)/..
npm install

# Install and link samples
cd samples/
npm link ../
npm install
cd ..
if [ -f samples/package.json ]; then
cd samples/
npm link ../
npm install
cd ..
fi

npm run lint
16 changes: 9 additions & 7 deletions .kokoro/samples-test.sh
View file
Open in desktop
Expand Up @@ -31,12 +31,14 @@ if [ -f .kokoro/pre-samples-test.sh ]; then
set -x
fi

npm install
if [ -f samples/package.json ]; then
npm install

# Install and link samples
cd samples/
npm link ../
npm install
cd ..
# Install and link samples
cd samples/
npm link ../
npm install
cd ..

npm run samples-test
npm run samples-test
fi
12 changes: 10 additions & 2 deletions .kokoro/test.sh
View file
Open in desktop
Expand Up @@ -22,6 +22,14 @@ cd $(dirname $0)/..

npm install
npm test
./node_modules/nyc/bin/nyc.js report

bash $KOKORO_GFILE_DIR/codecov.sh
COVERAGE_NODE=10
if npx check-node-version@3.3.0 --silent --node $COVERAGE_NODE; then
NYC_BIN=./node_modules/nyc/bin/nyc.js
if [ -f "$NYC_BIN" ]; then
$NYC_BIN report
fi
bash $KOKORO_GFILE_DIR/codecov.sh
else
echo "coverage is only reported for Node $COVERAGE_NODE"
fi
6 changes: 2 additions & 4 deletions dev/src/v1/doc/google/firestore/admin/v1/doc_field.js
View file
Open in desktop
Expand Up @@ -55,8 +55,7 @@
* explicitly remove all indexes for this field, specify an index config
* with an empty list of indexes.
*
* This object should have the same structure as [IndexConfig]{@link
* google.firestore.admin.v1.IndexConfig}
* This object should have the same structure as [IndexConfig]{@link google.firestore.admin.v1.IndexConfig}
*
* @typedef Field
* @memberof google.firestore.admin.v1
Expand All @@ -71,8 +70,7 @@ const Field = {
* @property {Object[]} indexes
* The indexes supported for this field.
*
* This object should have the same structure as [Index]{@link
* google.firestore.admin.v1.Index}
* This object should have the same structure as [Index]{@link google.firestore.admin.v1.Index}
*
* @property {boolean} usesAncestorConfig
* Output only.
Expand Down
15 changes: 5 additions & 10 deletions dev/src/v1/doc/google/firestore/admin/v1/doc_firestore_admin.js
View file
Open in desktop
Expand Up @@ -25,8 +25,7 @@
* @property {Object} index
* The composite index to create.
*
* This object should have the same structure as [Index]{@link
* google.firestore.admin.v1.Index}
* This object should have the same structure as [Index]{@link google.firestore.admin.v1.Index}
*
* @typedef CreateIndexRequest
* @memberof google.firestore.admin.v1
Expand Down Expand Up @@ -68,8 +67,7 @@ const ListIndexesRequest = {
* @property {Object[]} indexes
* The requested indexes.
*
* This object should have the same structure as [Index]{@link
* google.firestore.admin.v1.Index}
* This object should have the same structure as [Index]{@link google.firestore.admin.v1.Index}
*
* @property {string} nextPageToken
* A page token that may be used to request another page of results. If blank,
Expand Down Expand Up @@ -119,15 +117,13 @@ const DeleteIndexRequest = {
* @property {Object} field
* The field to be updated.
*
* This object should have the same structure as [Field]{@link
* google.firestore.admin.v1.Field}
* This object should have the same structure as [Field]{@link google.firestore.admin.v1.Field}
*
* @property {Object} updateMask
* A mask, relative to the field. If specified, only configuration specified
* by this field_mask will be updated in the field.
*
* This object should have the same structure as [FieldMask]{@link
* google.protobuf.FieldMask}
* This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
*
* @typedef UpdateFieldRequest
* @memberof google.firestore.admin.v1
Expand Down Expand Up @@ -188,8 +184,7 @@ const ListFieldsRequest = {
* @property {Object[]} fields
* The requested fields.
*
* This object should have the same structure as [Field]{@link
* google.firestore.admin.v1.Field}
* This object should have the same structure as [Field]{@link google.firestore.admin.v1.Field}
*
* @property {string} nextPageToken
* A page token that may be used to request another page of results. If blank,
Expand Down
15 changes: 5 additions & 10 deletions dev/src/v1/doc/google/firestore/admin/v1/doc_index.js
View file
Open in desktop
Expand Up @@ -35,8 +35,7 @@
* all collections descended from a specific document, specified at query
* time, and that have the same collection id as this index.
*
* The number should be among the values of [QueryScope]{@link
* google.firestore.admin.v1.QueryScope}
* The number should be among the values of [QueryScope]{@link google.firestore.admin.v1.QueryScope}
*
* @property {Object[]} fields
* The fields supported by this index.
Expand All @@ -51,15 +50,13 @@
* For single field indexes, this will always be exactly one entry with a
* field path equal to the field path of the associated field.
*
* This object should have the same structure as [IndexField]{@link
* google.firestore.admin.v1.IndexField}
* This object should have the same structure as [IndexField]{@link google.firestore.admin.v1.IndexField}
*
* @property {number} state
* Output only.
* The serving state of the index.
*
* The number should be among the values of [State]{@link
* google.firestore.admin.v1.State}
* The number should be among the values of [State]{@link google.firestore.admin.v1.State}
*
* @typedef Index
* @memberof google.firestore.admin.v1
Expand All @@ -82,14 +79,12 @@ const Index = {
* Indicates that this field supports ordering by the specified order or
* comparing using =, <, <=, >, >=.
*
* The number should be among the values of [Order]{@link
* google.firestore.admin.v1.Order}
* The number should be among the values of [Order]{@link google.firestore.admin.v1.Order}
*
* @property {number} arrayConfig
* Indicates that this field supports operations on `array_value`s.
*
* The number should be among the values of [ArrayConfig]{@link
* google.firestore.admin.v1.ArrayConfig}
* The number should be among the values of [ArrayConfig]{@link google.firestore.admin.v1.ArrayConfig}
*
* @typedef IndexField
* @memberof google.firestore.admin.v1
Expand Down
12 changes: 4 additions & 8 deletions dev/src/v1/doc/google/firestore/v1/doc_common.js
View file
Open in desktop
Expand Up @@ -45,8 +45,7 @@ const DocumentMask = {
* When set, the target document must exist and have been last updated at
* that time.
*
* This object should have the same structure as [Timestamp]{@link
* google.protobuf.Timestamp}
* This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}
*
* @typedef Precondition
* @memberof google.firestore.v1
Expand All @@ -62,14 +61,12 @@ const Precondition = {
* @property {Object} readOnly
* The transaction can only be used for read operations.
*
* This object should have the same structure as [ReadOnly]{@link
* google.firestore.v1.ReadOnly}
* This object should have the same structure as [ReadOnly]{@link google.firestore.v1.ReadOnly}
*
* @property {Object} readWrite
* The transaction can be used for both read and write operations.
*
* This object should have the same structure as [ReadWrite]{@link
* google.firestore.v1.ReadWrite}
* This object should have the same structure as [ReadWrite]{@link google.firestore.v1.ReadWrite}
*
* @typedef TransactionOptions
* @memberof google.firestore.v1
Expand Down Expand Up @@ -99,8 +96,7 @@ const TransactionOptions = {
* Reads documents at the given time.
* This may not be older than 60 seconds.
*
* This object should have the same structure as [Timestamp]{@link
* google.protobuf.Timestamp}
* This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}
*
* @typedef ReadOnly
* @memberof google.firestore.v1
Expand Down
24 changes: 8 additions & 16 deletions dev/src/v1/doc/google/firestore/v1/doc_document.js
View file
Open in desktop
Expand Up @@ -57,8 +57,7 @@
* recreated. It can also be compared to values from other documents and
* the `read_time` of a query.
*
* This object should have the same structure as [Timestamp]{@link
* google.protobuf.Timestamp}
* This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}
*
* @property {Object} updateTime
* Output only. The time at which the document was last changed.
Expand All @@ -67,8 +66,7 @@
* monotonically with each change to the document. It can also be
* compared to values from other documents and the `read_time` of a query.
*
* This object should have the same structure as [Timestamp]{@link
* google.protobuf.Timestamp}
* This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}
*
* @typedef Document
* @memberof google.firestore.v1
Expand All @@ -84,8 +82,7 @@ const Document = {
* @property {number} nullValue
* A null value.
*
* The number should be among the values of [NullValue]{@link
* google.protobuf.NullValue}
* The number should be among the values of [NullValue]{@link google.protobuf.NullValue}
*
* @property {boolean} booleanValue
* A boolean value.
Expand All @@ -102,8 +99,7 @@ const Document = {
* Precise only to microseconds. When stored, any additional precision is
* rounded down.
*
* This object should have the same structure as [Timestamp]{@link
* google.protobuf.Timestamp}
* This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}
*
* @property {string} stringValue
* A string value.
Expand All @@ -125,23 +121,20 @@ const Document = {
* @property {Object} geoPointValue
* A geo point value representing a point on the surface of Earth.
*
* This object should have the same structure as [LatLng]{@link
* google.type.LatLng}
* This object should have the same structure as [LatLng]{@link google.type.LatLng}
*
* @property {Object} arrayValue
* An array value.
*
* Cannot directly contain another array value, though can contain an
* map which contains another array.
*
* This object should have the same structure as [ArrayValue]{@link
* google.firestore.v1.ArrayValue}
* This object should have the same structure as [ArrayValue]{@link google.firestore.v1.ArrayValue}
*
* @property {Object} mapValue
* A map value.
*
* This object should have the same structure as [MapValue]{@link
* google.firestore.v1.MapValue}
* This object should have the same structure as [MapValue]{@link google.firestore.v1.MapValue}
*
* @typedef Value
* @memberof google.firestore.v1
Expand All @@ -157,8 +150,7 @@ const Value = {
* @property {Object[]} values
* Values in the array.
*
* This object should have the same structure as [Value]{@link
* google.firestore.v1.Value}
* This object should have the same structure as [Value]{@link google.firestore.v1.Value}
*
* @typedef ArrayValue
* @memberof google.firestore.v1
Expand Down