Update documentation

barchart · Apr 17, 2024 · 2bd7f6f · 2bd7f6f
1 parent 17b313c
commit 2bd7f6f
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 31 deletions.
diff --git a/docs/content/api/components.md b/docs/content/api/components.md
@@ -32,7 +32,7 @@
 
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| value | <code>Object</code> |  | false |  |
+| value | <code>Object</code> | false | false |  |
 | value.code | <code>String</code> | false | false |  |
 | value.message | <code>String</code> | false | false |  |
 | children | <code>Array</code> | false | false |  |
@@ -62,7 +62,7 @@
 
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| value | <code>Object</code> |  | false |  |
+| value | <code>Object</code> | false | false |  |
 | value.code | <code>String</code> | false | false |  |
 | value.message | <code>String</code> | false | false |  |
 | children | <code>Array</code> | false | false |  |
@@ -92,7 +92,7 @@
 
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| value | <code>Object</code> |  | false |  |
+| value | <code>Object</code> | false | false |  |
 | value.code | <code>String</code> | false | false |  |
 | value.message | <code>String</code> | false | false |  |
 | children | <code>Array</code> | false | false |  |
@@ -122,7 +122,7 @@
 
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| value | <code>Object</code> |  | false |  |
+| value | <code>Object</code> | false | false |  |
 | value.code | <code>String</code> | false | false |  |
 | value.message | <code>String</code> | false | false |  |
 | children | <code>Array</code> | false | false |  |
@@ -147,12 +147,13 @@
 
 ### metadata :id=schemasmetadata
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| server | [<code>metadata-server</code>](#schemasmetadata-server) |  | false |  |
-| user | [<code>metadata-user</code>](#schemasmetadata-user) |  | false |  |
-| context | [<code>metadata-context</code>](#schemasmetadata-context) |  | false |  |
+| server | [<code>metadata-server</code>](#schemasmetadata-server) | false | false |  |
+| user | [<code>metadata-user</code>](#schemasmetadata-user) | false | false |  |
+| context | [<code>metadata-context</code>](#schemasmetadata-context) | false | false |  |
+
 
 **Example**:
 
@@ -177,11 +178,12 @@
 
 ### metadata-context :id=schemasmetadata-context
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | id | <code>String</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -194,14 +196,15 @@
 
 ### metadata-server :id=schemasmetadata-server
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | name | <code>String</code> | false | false |  |
 | description | <code>String</code> | false | false |  |
 | environment | <code>String</code> | false | false |  |
 | semver | <code>String</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -217,11 +220,12 @@
 
 ### metadata-user :id=schemasmetadata-user
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | id | <code>String</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -234,17 +238,18 @@
 
 ### watchlist :id=schemaswatchlist
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | id | <code>String</code> | false | false |  |
 | context | <code>String</code> | false | false |  |
 | name | <code>String</code> | false | false |  |
 | view | <code>String</code> | false | false |  |
-| entries | [<code>entries</code>](#schemasentries) |  | false |  |
-| preferences | [<code>preferences</code>](#schemaspreferences) |  | false |  |
+| entries | [<code>entries</code>](#schemasentries) | false | false |  |
+| preferences | [<code>preferences</code>](#schemaspreferences) | false | false |  |
 | user | <code>String</code> | false | false |  |
-| system | [<code>system</code>](#schemassystem) |  | false |  |
+| system | [<code>system</code>](#schemassystem) | false | false |  |
+
 
 **Example**:
 
@@ -281,13 +286,14 @@
 
 ### preferences :id=schemaspreferences
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| sorting | <code>Object</code> |  | false |  |
+| sorting | <code>Object</code> | false | false |  |
 | sorting.column | <code>String</code> | false | false |  |
 | sorting.desc | <code>Boolean</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -303,12 +309,13 @@
 
 ### system :id=schemassystem
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | sequence | <code>Integer</code> | false | false |  |
 | timestamp | <code>String</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -323,16 +330,31 @@
 ### entries :id=schemasentries
 **Type**: [<code>Array&lt;entry&gt;</code>](#schemasentry)
 
+**Example**:
+
+```json
+[
+  {
+    "symbol": "TSLA",
+    "notes": {
+      "property1": null,
+      "property2": null
+    }
+  }
+]
+```
+
 * * *
 
 ### entry :id=schemasentry
 **Type**: <code>Object</code>
-    
+
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
 | symbol | <code>String</code> | false | false |  |
 | notes | <code>Object</code> | false | false |  |
 
+
 **Example**:
 
 ```json
@@ -354,7 +376,7 @@
 >
 
 **Type**: http bearer
-    
+
 #### Headers
 | Name | Format | Example |
 | ---- | ------ | ------- |

diff --git a/docs/content/api/paths.md b/docs/content/api/paths.md
@@ -135,7 +135,7 @@
 | X-BARCHART-CLIENT-ID | <code>String</code> | false | false | An identifier for the connection (used to suppress WebSocket echo). |
 
 #### Request Body
-    
+
 **Content Type**: application/json
 
 **Type**: <code>Object</code>
@@ -146,7 +146,7 @@
 | context | <code>String</code> | true | false |  |
 | view | <code>String</code> | false | false |  |
 | entries | [<code>entries</code>](/content/api/components?id=schemasentries) | true | false |  |
-| preferences | [<code>preferences</code>](/content/api/components?id=schemaspreferences) |  | false |  |
+| preferences | [<code>preferences</code>](/content/api/components?id=schemaspreferences) | false | false |  |
 
 **Example**:
 
@@ -388,7 +388,7 @@
 | watchlist | <code>String</code> | true | false | The identifier of the watchlist. |
 
 #### Request Body
-    
+
 **Content Type**: application/json
 
 **Type**: <code>Object</code>
@@ -398,7 +398,7 @@
 | name | <code>String</code> | true | false |  |
 | view | <code>String</code> | false | false |  |
 | entries | [<code>entries</code>](/content/api/components?id=schemasentries) | true | false |  |
-| preferences | [<code>preferences</code>](/content/api/components?id=schemaspreferences) |  | false |  |
+| preferences | [<code>preferences</code>](/content/api/components?id=schemaspreferences) | false | false |  |
 
 **Example**:
 
@@ -500,7 +500,7 @@
 | watchlist | <code>String</code> | true | false | The identifier of the watchlist. |
 
 #### Request Body
-    
+
 **Content Type**: application/json
 
 **Type**: [<code>preferences</code>](/content/api/components?id=schemaspreferences)
@@ -588,14 +588,14 @@
 | watchlist | <code>String</code> | true | false | The identifier of the watchlist. |
 
 #### Request Body
-    
+
 **Content Type**: application/json
 
 **Type**: <code>Object</code>
 
 | Name | Type | Required | Nullable | Description |
 | ---- | ---- | -------- | -------- | ----------- |
-| entry | [<code>entry</code>](/content/api/components?id=schemasentry) |  | false |  |
+| entry | [<code>entry</code>](/content/api/components?id=schemasentry) | false | false |  |
 | index | <code>Integer</code> | false | false | The index at which the symbol will be inserted |
 
 **Example**:
@@ -768,7 +768,7 @@
 | symbol | <code>String</code> | true | false | The symbol to move. |
 
 #### Request Body
-    
+
 **Content Type**: application/json
 
 **Type**: <code>Object</code>

diff --git a/docs/content/release_notes.md b/docs/content/release_notes.md
@@ -1,5 +1,15 @@
 # Release Notes
 
+## 8.5.3
+**Bug Fixes**
+
+* Corrected `WatchlistGateway.addSymbol` function — the `index` parameter is now obeyed.
+
+**Technical Enhancements**
+
+* Updated the [`uuid`](https://github.com/uuidjs/uuid) package to the next major version.
+* Updated AWS CodeBuild integration to use Node.js version 20.
+
 ## 8.5.2
 **No Functional Changes**
 
@@ -102,7 +112,7 @@
 ## 7.0.0
 **Breaking Changes**
 
-* The mechanism for passing JSON Web Tokens to the ```WatchlistGateway``` has changed. Consumers are now required to provide ```JwtProvider``` instances instead of a ```RequestInterceptor``` instances. Here are the specifics:
+* The mechanism for passing JSON Web Tokens to the ```WatchlistGateway``` has changed. Consumers are now required to provide ```JwtProvider``` instances instead of ```RequestInterceptor``` instances. Here are the specifics:
   * The ```RequestInterceptor``` argument was replaced with a ```JwtProvider``` argument on static factory functions (e.g. ```WatchlistGateway.forProduction```).
   * The ```RequestInterceptor``` argument was removed from the ```WatchlistGateway``` constructor.
   * The ```WatchlistGateway.start``` function was renamed to ```WatchlistGateway.connect``` and now has a ```JwtProvider``` argument.

diff --git a/docs/content/sdk/lib-data.md b/docs/content/sdk/lib-data.md
@@ -41,7 +41,7 @@
 
 | Name | Type | Description |
 | --- | --- | --- |
-| symbol | <code>String</code> | <p>The unique identifier of the</p> |
+| symbol | <code>String</code> | <p>The unique identifier of the instrument (item).</p> |
 
 
 * * *

diff --git a/docs/content/sdk/lib-gateway.md b/docs/content/sdk/lib-gateway.md
@@ -336,7 +336,7 @@
 
 | Param | Type | Description |
 | --- | --- | --- |
-| protocol | <code>String</code> | <p>The protocol of the of the Watchlist web service (either http or https).</p> |
+| protocol | <code>String</code> | <p>The protocol of the Watchlist web service (either http or https).</p> |
 | host | <code>String</code> | <p>The hostname of the Watchlist web service.</p> |
 | port | <code>Number</code> | <p>The TCP port number of the Watchlist web service.</p> |
 | environment | <code>String</code> | <p>A description of the environment we're connecting to.</p> |