Skip to content

chore: update responses #338

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
jpoehnelt merged 5 commits into from
May 18, 2022
Merged

chore: update responses #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d8fb23
chore: update responses
May 18, 2022
f44fade
chore: update outputs
May 18, 2022
b4eb50b
fix: update errors
May 18, 2022
917b405
fix: response
May 18, 2022
5d5925f
feat: fieldViolations
May 18, 2022
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
20 changes: 20 additions & 0 deletions dist/documentation/schemas/maps_http_schema_distancematrixresponse.html
View file
Open in desktop

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

1 change: 1 addition & 0 deletions dist/documentation/schemas/maps_http_schema_distancematrixresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
| <h4 id="DistanceMatrixResponse-origin_addresses" class="add-link schema-object-property-key"><code>origin_addresses</code></h4> | **required** | Array&lt;string&gt; | <div class="nonref-property-description"><p>An array of addresses as returned by the API from your original request. These are formatted by the geocoder and localized according to the language parameter passed with the request. This content is meant to be read as-is. Do not programatically parse the formatted addresses.</p></div> |
| <h4 id="DistanceMatrixResponse-rows" class="add-link schema-object-property-key"><code>rows</code></h4> | **required** | Array&lt;[DistanceMatrixRow](#DistanceMatrixRow "DistanceMatrixRow")&gt; | <div class="ref-property-description"><p>An array of elements, which in turn each contain a <code>status</code>, <code>duration</code>, and <code>distance</code> element.</p><p>See <a href="#DistanceMatrixRow">DistanceMatrixRow</a> for more information.</div> |
| <h4 id="DistanceMatrixResponse-status" class="add-link schema-object-property-key"><code>status</code></h4> | **required** | [DistanceMatrixStatus](#DistanceMatrixStatus "DistanceMatrixStatus") | <div class="ref-property-description"><p>Contains the status of the request, and may contain debugging information to help you track down why the request failed.</p><p>See <a href="#DistanceMatrixStatus">DistanceMatrixStatus</a> for more information.</div> |
| <h4 id="DistanceMatrixResponse-error_message" class="add-link schema-object-property-key"><code>error_message</code></h4> | optional | string | <div class="nonref-property-description"><p>A string containing the human-readable text of any errors encountered while the request was being processed.</p></div> |

<p style="text-align: right; font-size: smaller;">Generated from the <a class="gc-analytics-event" data-category="GMP" data-label="openapi-github" href="https://github.com/googlemaps/openapi-specification" title="Google Maps Platform OpenAPI Specification" class="external">OpenAPI specification</a>.
<a class="gc-analytics-event" data-category="GMP" data-label="openapi-github-maps-http-schema-distancematrixresponse" data-action="edit" style="margin-left: 5px;" href="https://github.com/googlemaps/openapi-specification/blob/main/specification/schemas/DistanceMatrixResponse.yml" title="Edit on GitHub"><span class="material-icons">edit</span> Edit</a>
Expand Down
82 changes: 63 additions & 19 deletions dist/documentation/schemas/maps_http_schema_errordetail.html
View file
Open in desktop

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

13 changes: 8 additions & 5 deletions dist/documentation/schemas/maps_http_schema_errordetail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
<!--- [START maps_http_schema_errordetail] -->
<h3 class="schema-object" id="ErrorDetail">ErrorDetail</h3>

| Field | Required | Type | Description |
| :------------------------------------------------------------------------------------------------- | ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4 id="ErrorDetail-message" class="add-link schema-object-property-key"><code>message</code></h4> | **required** | string | <div class="nonref-property-description"><p>A short description of the error.</p></div> |
| <h4 id="ErrorDetail-reason" class="add-link schema-object-property-key"><code>reason</code></h4> | **required** | string | <div class="nonref-property-description"><p>A reason for the error.</p><div class="notranslate">The allowed values include: `badRequest`, `dailyLimitExceeded`, `invalid`, `keyInvalid`, `notFound`, `parseError`, and `userRateLimitExceeded`</div></div> |
| <h4 id="ErrorDetail-domain" class="add-link schema-object-property-key"><code>domain</code></h4> | optional | string | <div class="nonref-property-description"><p>The domain in which the error occurred.</p><div class="notranslate">The allowed values include: `global`, `geolocation`, and `usageLimits`</div></div> |
| Field | Required | Type | Description |
| :----------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4 id="ErrorDetail-@type" class="add-link schema-object-property-key"><code>@type</code></h4> | optional | string | <div class="nonref-property-description"><p>The type of error.</p></div> |
| <h4 id="ErrorDetail-domain" class="add-link schema-object-property-key"><code>domain</code></h4> | optional | string | <div class="nonref-property-description"><p>The domain in which the error occurred.</p></div> |
| <h4 id="ErrorDetail-fieldViolations" class="add-link schema-object-property-key"><code>fieldViolations</code></h4> | optional | Array&lt;[FieldViolation](#FieldViolation "FieldViolation")&gt; | <div class="ref-property-description"><p>A list of field violations.</p><p>See <a href="#FieldViolation">FieldViolation</a> for more information.</div> |
| <h4 id="ErrorDetail-message" class="add-link schema-object-property-key"><code>message</code></h4> | optional | string | <div class="nonref-property-description"><p>A short description of the error.</p></div> |
| <h4 id="ErrorDetail-metadata" class="add-link schema-object-property-key"><code>metadata</code></h4> | optional | object | <div class="nonref-property-description"><p>Additional metadata about the error.</p></div> |
| <h4 id="ErrorDetail-reason" class="add-link schema-object-property-key"><code>reason</code></h4> | optional | string | <div class="nonref-property-description"><p>A reason for the error.</p></div> |

<h4 class="schema-object-example" id="ErrorDetail-example">Example</h4>

Expand Down
22 changes: 22 additions & 0 deletions dist/documentation/schemas/maps_http_schema_errorobject.html
View file
Open in desktop

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

1 change: 1 addition & 0 deletions dist/documentation/schemas/maps_http_schema_errorobject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| <h4 id="ErrorObject-code" class="add-link schema-object-property-key"><code>code</code></h4> | **required** | number | <div class="nonref-property-description"><p>This is the same as the HTTP status of the response.</p></div> |
| <h4 id="ErrorObject-errors" class="add-link schema-object-property-key"><code>errors</code></h4> | **required** | Array&lt;[ErrorDetail](#ErrorDetail "ErrorDetail")&gt; | <div class="ref-property-description"><p>A list of errors which occurred. Each error contains an identifier for the type of error and a short description.</p><p>See <a href="#ErrorDetail">ErrorDetail</a> for more information.</div> |
| <h4 id="ErrorObject-message" class="add-link schema-object-property-key"><code>message</code></h4> | **required** | string | <div class="nonref-property-description"><p>A short description of the error.</p></div> |
| <h4 id="ErrorObject-details" class="add-link schema-object-property-key"><code>details</code></h4> | optional | Array&lt;[ErrorDetail](#ErrorDetail "ErrorDetail")&gt; | <div class="ref-property-description"><p>Additional details about the error.</p><p>See <a href="#ErrorDetail">ErrorDetail</a> for more information.</div> |
| <h4 id="ErrorObject-status" class="add-link schema-object-property-key"><code>status</code></h4> | optional | string | <div class="nonref-property-description"><p>A status code that indicates the error type.</p></div> |

<p style="text-align: right; font-size: smaller;">Generated from the <a class="gc-analytics-event" data-category="GMP" data-label="openapi-github" href="https://github.com/googlemaps/openapi-specification" title="Google Maps Platform OpenAPI Specification" class="external">OpenAPI specification</a>.
Expand Down
12 changes: 11 additions & 1 deletion dist/documentation/schemas/maps_http_schema_errorresponse.html
View file
Open in desktop

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

12 changes: 11 additions & 1 deletion dist/documentation/schemas/maps_http_schema_errorresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ In the case of an error, a standard format error response body will be returned
"reason": "badRequest"
}
],
"status": "INVALID_ARGUMENT"
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "API_KEY_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "geolocation.googleapis.com"
}
}
]
}
}</pre>

Expand Down
83 changes: 83 additions & 0 deletions dist/documentation/schemas/maps_http_schema_fieldviolation.html
View file
Open in desktop

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

Loading