diff --git a/docs/content/api/components.md b/docs/content/api/components.md
index 348cf31..2990214 100644
--- a/docs/content/api/components.md
+++ b/docs/content/api/components.md
@@ -32,7 +32,7 @@
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| value | Object
| | false | |
+| value | Object
| false | false | |
| value.code | String
| false | false | |
| value.message | String
| false | false | |
| children | Array
| false | false | |
@@ -62,7 +62,7 @@
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| value | Object
| | false | |
+| value | Object
| false | false | |
| value.code | String
| false | false | |
| value.message | String
| false | false | |
| children | Array
| false | false | |
@@ -92,7 +92,7 @@
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| value | Object
| | false | |
+| value | Object
| false | false | |
| value.code | String
| false | false | |
| value.message | String
| false | false | |
| children | Array
| false | false | |
@@ -122,7 +122,7 @@
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| value | Object
| | false | |
+| value | Object
| false | false | |
| value.code | String
| false | false | |
| value.message | String
| false | false | |
| children | Array
| false | false | |
@@ -147,12 +147,13 @@
### metadata :id=schemasmetadata
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| server | [metadata-server
](#schemasmetadata-server) | | false | |
-| user | [metadata-user
](#schemasmetadata-user) | | false | |
-| context | [metadata-context
](#schemasmetadata-context) | | false | |
+| server | [metadata-server
](#schemasmetadata-server) | false | false | |
+| user | [metadata-user
](#schemasmetadata-user) | false | false | |
+| context | [metadata-context
](#schemasmetadata-context) | false | false | |
+
**Example**:
@@ -177,11 +178,12 @@
### metadata-context :id=schemasmetadata-context
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| id | String
| false | false | |
+
**Example**:
```json
@@ -194,7 +196,7 @@
### metadata-server :id=schemasmetadata-server
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| name | String
| false | false | |
@@ -202,6 +204,7 @@
| environment | String
| false | false | |
| semver | String
| false | false | |
+
**Example**:
```json
@@ -217,11 +220,12 @@
### metadata-user :id=schemasmetadata-user
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| id | String
| false | false | |
+
**Example**:
```json
@@ -234,17 +238,18 @@
### watchlist :id=schemaswatchlist
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| id | String
| false | false | |
| context | String
| false | false | |
| name | String
| false | false | |
| view | String
| false | false | |
-| entries | [entries
](#schemasentries) | | false | |
-| preferences | [preferences
](#schemaspreferences) | | false | |
+| entries | [entries
](#schemasentries) | false | false | |
+| preferences | [preferences
](#schemaspreferences) | false | false | |
| user | String
| false | false | |
-| system | [system
](#schemassystem) | | false | |
+| system | [system
](#schemassystem) | false | false | |
+
**Example**:
@@ -281,13 +286,14 @@
### preferences :id=schemaspreferences
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| sorting | Object
| | false | |
+| sorting | Object
| false | false | |
| sorting.column | String
| false | false | |
| sorting.desc | Boolean
| false | false | |
+
**Example**:
```json
@@ -303,12 +309,13 @@
### system :id=schemassystem
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| sequence | Integer
| false | false | |
| timestamp | String
| false | false | |
+
**Example**:
```json
@@ -323,16 +330,31 @@
### entries :id=schemasentries
**Type**: [Array<entry>
](#schemasentry)
+**Example**:
+
+```json
+[
+ {
+ "symbol": "TSLA",
+ "notes": {
+ "property1": null,
+ "property2": null
+ }
+ }
+]
+```
+
* * *
### entry :id=schemasentry
**Type**: Object
-
+
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
| symbol | String
| false | false | |
| notes | Object
| 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
index 1e26513..65f2012 100644
--- a/docs/content/api/paths.md
+++ b/docs/content/api/paths.md
@@ -135,7 +135,7 @@
| X-BARCHART-CLIENT-ID | String
| false | false | An identifier for the connection (used to suppress WebSocket echo). |
#### Request Body
-
+
**Content Type**: application/json
**Type**: Object
@@ -146,7 +146,7 @@
| context | String
| true | false | |
| view | String
| false | false | |
| entries | [entries
](/content/api/components?id=schemasentries) | true | false | |
-| preferences | [preferences
](/content/api/components?id=schemaspreferences) | | false | |
+| preferences | [preferences
](/content/api/components?id=schemaspreferences) | false | false | |
**Example**:
@@ -388,7 +388,7 @@
| watchlist | String
| true | false | The identifier of the watchlist. |
#### Request Body
-
+
**Content Type**: application/json
**Type**: Object
@@ -398,7 +398,7 @@
| name | String
| true | false | |
| view | String
| false | false | |
| entries | [entries
](/content/api/components?id=schemasentries) | true | false | |
-| preferences | [preferences
](/content/api/components?id=schemaspreferences) | | false | |
+| preferences | [preferences
](/content/api/components?id=schemaspreferences) | false | false | |
**Example**:
@@ -500,7 +500,7 @@
| watchlist | String
| true | false | The identifier of the watchlist. |
#### Request Body
-
+
**Content Type**: application/json
**Type**: [preferences
](/content/api/components?id=schemaspreferences)
@@ -588,14 +588,14 @@
| watchlist | String
| true | false | The identifier of the watchlist. |
#### Request Body
-
+
**Content Type**: application/json
**Type**: Object
| Name | Type | Required | Nullable | Description |
| ---- | ---- | -------- | -------- | ----------- |
-| entry | [entry
](/content/api/components?id=schemasentry) | | false | |
+| entry | [entry
](/content/api/components?id=schemasentry) | false | false | |
| index | Integer
| false | false | The index at which the symbol will be inserted |
**Example**:
@@ -768,7 +768,7 @@
| symbol | String
| true | false | The symbol to move. |
#### Request Body
-
+
**Content Type**: application/json
**Type**: Object
diff --git a/docs/content/release_notes.md b/docs/content/release_notes.md
index a3927f3..706b94b 100644
--- 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
index ec93f08..26b99ed 100644
--- a/docs/content/sdk/lib-data.md
+++ b/docs/content/sdk/lib-data.md
@@ -41,7 +41,7 @@
| Name | Type | Description |
| --- | --- | --- |
-| symbol | String
|
The unique identifier of the
| +| symbol |String
| The unique identifier of the instrument (item).
| * * * diff --git a/docs/content/sdk/lib-gateway.md b/docs/content/sdk/lib-gateway.md index c4c520a..0cddef1 100644 --- a/docs/content/sdk/lib-gateway.md +++ b/docs/content/sdk/lib-gateway.md @@ -336,7 +336,7 @@ | Param | Type | Description | | --- | --- | --- | -| protocol |String
| The protocol of the of the Watchlist web service (either http or https).
| +| protocol |String
| The protocol of the Watchlist web service (either http or https).
| | host |String
| The hostname of the Watchlist web service.
| | port |Number
| The TCP port number of the Watchlist web service.
| | environment |String
| A description of the environment we're connecting to.
|