Skip to content

Commit cb36ff1

Browse files
committed
Document the name property of hierarchy items
These are mandatory, but were forgotten in the previous docs update.
1 parent 6d12f5c commit cb36ff1

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/index.html

+15
Original file line numberDiff line numberDiff line change
@@ -4650,6 +4650,21 @@ <h3 class="panel-title"><a name="/definitions/Hierarchy"></a>Hierarchy:
46504650
</div>
46514651
</section> </div>
46524652
</dd>
4653+
<dt data-property-name="name">
4654+
<span class="json-property-name">name:</span>
4655+
4656+
<span class="json-property-type">string</span>
4657+
<span class="json-property-range" title="Value limits"></span>
4658+
4659+
<span class="json-property-required"></span>
4660+
</dt>
4661+
<dd>
4662+
<p>The name of the symbol represented by the hierarchy item.</p>
4663+
4664+
<div class="json-inner-schema">
4665+
4666+
</div>
4667+
</dd>
46534668
<dt data-property-name="root_location">
46544669
<span class="json-property-name">root_location:</span>
46554670

docs/openapi.yml

+5
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ definitions:
195195
required:
196196
- kind
197197
- locations
198+
- name
198199
description: |-
199200
An object returned, in a list, as a response to hierarchy requests.
200201
The object may contain additional properties, which are used to identify
@@ -233,6 +234,10 @@ definitions:
233234
type: array
234235
items:
235236
$ref: "#/defintions/Location"
237+
name:
238+
type: string
239+
description: |-
240+
The name of the symbol represented by the hierarchy item.
236241
root_location:
237242
type: object
238243
description: |-

0 commit comments

Comments
 (0)