Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

chore: sync latest proto docs #245

Merged
merged 2 commits into from
Mar 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 17 additions & 14 deletions src/v2/doc/google/rpc/doc_status.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,25 @@
// to be loaded as the JS file.

/**
* The `Status` type defines a logical error model that is suitable for different
* programming environments, including REST APIs and RPC APIs. It is used by
* [gRPC](https://github.com/grpc). The error model is designed to be:
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
*
* - Simple to use and understand for most users
* - Flexible enough to meet unexpected needs
*
* # Overview
*
* The `Status` message contains three pieces of data: error code, error message,
* and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes if needed. The
* error message should be a developer-facing English message that helps
* developers *understand* and *resolve* the error. If a localized user-facing
* error message is needed, put the localized message in the error details or
* localize it in the client. The optional error details may contain arbitrary
* information about the error. There is a predefined set of error detail types
* in the package `google.rpc` that can be used for common error conditions.
* The `Status` message contains three pieces of data: error code, error
* message, and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes
* if needed. The error message should be a developer-facing English message
* that helps developers *understand* and *resolve* the error. If a localized
* user-facing error message is needed, put the localized message in the error
* details or localize it in the client. The optional error details may contain
* arbitrary information about the error. There is a predefined set of error
* detail types in the package `google.rpc` that can be used for common error
* conditions.
*
* # Language mapping
*
Expand Down Expand Up @@ -70,12 +71,14 @@
* be used directly after any stripping needed for security/privacy reasons.
*
* @property {number} code
* The status code, which should be an enum value of google.rpc.Code.
* The status code, which should be an enum value of
* google.rpc.Code.
*
* @property {string} message
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
* google.rpc.Status.details field, or localized
* by the client.
*
* @property {Object[]} details
* A list of messages that carry the error details. There is a common set of
Expand Down
5 changes: 3 additions & 2 deletions src/v2/doc/google/type/doc_date.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@
* is relative to the Proleptic Gregorian Calendar. The day may be 0 to
* represent a year and month where the day is not significant, e.g. credit card
* expiration date. The year may be 0 to represent a month and day independent
* of year, e.g. anniversary date. Related types are google.type.TimeOfDay
* and `google.protobuf.Timestamp`.
* of year, e.g. anniversary date. Related types are
* google.type.TimeOfDay and
* `google.protobuf.Timestamp`.
*
* @property {number} year
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
Expand Down
3 changes: 2 additions & 1 deletion src/v2/doc/google/type/doc_timeofday.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
/**
* Represents a time of day. The date and time zone are either not significant
* or are specified elsewhere. An API may chose to allow leap seconds. Related
* types are google.type.Date and `google.protobuf.Timestamp`.
* types are google.type.Date and
* `google.protobuf.Timestamp`.
*
* @property {number} hours
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
Expand Down
12 changes: 6 additions & 6 deletions synth.metadata
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"updateTime": "2019-02-20T12:12:56.680743Z",
"updateTime": "2019-02-27T12:12:35.233749Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.13",
"dockerImage": "googleapis/artman@sha256:5fd9aee1d82a00cebf425c8fa431f5457539562f5867ad9c54370f0ec9a7ccaa"
"version": "0.16.14",
"dockerImage": "googleapis/artman@sha256:f3d61ae45abaeefb6be5f228cda22732c2f1b00fb687c79c4bd4f2c42bb1e1a7"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "96cb68536cdb3c1d95c624ec0d32466cfd5fd882",
"internalRef": "234655328"
"sha": "29f098cb03a9983cc9cb15993de5da64419046f2",
"internalRef": "235621085"
}
},
{
"template": {
"name": "node_library",
"origin": "synthtool.gcp",
"version": "2019.1.16"
"version": "2019.2.26"
}
}
],
Expand Down