Skip to content

Commit 2203443

Browse files
authored
feat: Adds editorial summary (one-liners) to the reference docs. (#388)
Change-Id: I3e79a5e8da522e2bfd6b33d27b1402e07907c3a3
1 parent 0766409 commit 2203443

6 files changed

Lines changed: 135 additions & 6 deletions

File tree

dist/documentation/schemas/maps_http_schema_placeeditorialsummary.html

Lines changed: 88 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--- This is a generated file, do not edit! -->
2+
<!--- [START maps_http_schema_placeeditorialsummary] -->
3+
<h3 class="schema-object" id="PlaceEditorialSummary">PlaceEditorialSummary</h3>
4+
5+
Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
6+
7+
| Field | Required | Type | Description |
8+
| :------------------------------------------------------------------------------------------------------------- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
9+
| <h4 id="PlaceEditorialSummary-language" class="add-link schema-object-property-key"><code>language</code></h4> | optional | string | <div class="nonref-property-description"><p>The language of the previous fields. May not always be present.</p></div> |
10+
| <h4 id="PlaceEditorialSummary-overview" class="add-link schema-object-property-key"><code>overview</code></h4> | optional | string | <div class="nonref-property-description"><p>A medium-length textual summary of the place.</p></div> |
11+
12+
<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>.
13+
<a class="gc-analytics-event" data-category="GMP" data-label="openapi-github-maps-http-schema-placeeditorialsummary" data-action="edit" style="margin-left: 5px;" href="https://github.com/googlemaps/openapi-specification/blob/main/specification/schemas/PlaceEditorialSummary.yml" title="Edit on GitHub"><span class="material-icons">edit</span> Edit</a>
14+
<a class="gc-analytics-event" data-category="GMP" data-label="openapi-github-maps-http-schema-placeeditorialsummary" data-action="bug" style="margin-left: 5px;" href="https://github.com/googlemaps/openapi-specification/issues/new?assignees=&labels=type%3A+bug%2C+triage+me&template=bug_report.md&title=[schemas] Bug - PlaceEditorialSummary" title="File bug for schemas on GitHub"><span class="material-icons">bug_report</span> Report bug</a>
15+
</p>
16+
17+
<!--- [END maps_http_schema_placeeditorialsummary] -->

specification/parameters/places/fields.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,8 @@ description: |
3131
3232
**Atmosphere**
3333
34-
The Atmosphere category includes the following fields: `curbside_pickup`, `delivery`, `dine_in`, `price_level`, `rating`, `review`, `takeout`, `user_ratings_total`.
34+
The Atmosphere category includes the following fields: `curbside_pickup`, `delivery`, `dine_in`, `editorial_summary`, `price_level`, `rating`, `review`, `takeout`, `user_ratings_total`.
3535
36-
<aside class="note"><strong>Note: </strong><code>curbside_pickup</code>, <code>delivery</code>,
37-
<code>dine_in</code>, and <code>takeout</code> are only supported for Place Details requests.
38-
</aside>
39-
4036
schema:
4137
type: array
4238
items:
@@ -59,4 +55,3 @@ examples:
5955
all:
6056
value:
6157
- "*"
62-

specification/schemas/Place.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ properties:
4242
dine_in:
4343
description: Specifies if the business supports indoor or outdoor seating options.
4444
type: boolean
45+
editorial_summary:
46+
description: Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
47+
$ref: "./PlaceEditorialSummary.yml"
4548
formatted_address:
4649
description: |
4750
A string containing the human-readable address of this place.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Copyright 2021 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
type: object
16+
title: PlaceEditorialSummary
17+
description: Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
18+
properties:
19+
overview:
20+
description: A medium-length textual summary of the place.
21+
type: string
22+
language:
23+
description: The language of the previous fields. May not always be present.
24+
type: string

specification/schemas/_index.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ PlaceAutocompleteStructuredFormat:
135135
$ref: "./PlaceAutocompleteStructuredFormat.yml"
136136
PlaceAutocompleteTerm:
137137
$ref: "./PlaceAutocompleteTerm.yml"
138+
PlaceEditorialSummary:
139+
$ref: "./PlaceEditorialSummary.yml"
138140
PlacePhoto:
139141
$ref: "./PlacePhoto.yml"
140142
PlaceOpeningHours:

0 commit comments

Comments
 (0)