Skip to content

Commit

Permalink
Document the name property of hierarchy items
Browse files Browse the repository at this point in the history
These are mandatory, but were forgotten in the previous docs update.
  • Loading branch information
bstaletic committed Jun 13, 2024
1 parent bb99ee5 commit d51c886
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4650,6 +4650,21 @@ <h3 class="panel-title"><a name="/definitions/Hierarchy"></a>Hierarchy:
</div>
</section> </div>
</dd>
<dt data-property-name="name">
<span class="json-property-name">name:</span>

<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>

<span class="json-property-required"></span>
</dt>
<dd>
<p>The name of the symbol represented by the hierarchy item.</p>

<div class="json-inner-schema">

</div>
</dd>
<dt data-property-name="root_location">
<span class="json-property-name">root_location:</span>

Expand Down
5 changes: 5 additions & 0 deletions docs/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ definitions:
required:
- kind
- locations
- name
description: |-
An object returned, in a list, as a response to hierarchy requests.
The object may contain additional properties, which are used to identify
Expand Down Expand Up @@ -233,6 +234,10 @@ definitions:
type: array
items:
$ref: "#/defintions/Location"
name:
type: string
description: |-
The name of the symbol represented by the hierarchy item.
root_location:
type: object
description: |-
Expand Down

0 comments on commit d51c886

Please sign in to comment.