Skip to content

beta: Beta OpenAPI file replicated from Notehub commit 31e1632 #522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

beta: Beta OpenAPI file replicated from Notehub commit 31e1632 #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
208b76b
beta: Beta OpenAPI file replicated from Notehub commit 31e1632
blues-hub-automation[bot] Jun 16, 2026
e84dbc9
Update project version to 6.4.0-beta.7 [skip ci]
github-actions[bot] Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"licenseName": "MIT",
"moduleName": "NotehubJs",
"npmRepository": "https://registry.npmjs.org",
"projectVersion": "6.4.0",
"projectVersion": "6.4.0-beta.7",
"sourceFolder": "src",
"usePromises": true
}
12 changes: 6 additions & 6 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1316,7 +1316,7 @@ paths:
get:
operationId: GetDeviceJourneys
description: |
Get the list of journeys for a device, derived from `_track.qo` events. Returns journey metadata only (no event payloads). Capped at 100 most recent journeys; `has_more` is true when the cap is hit.
Get the list of journeys for a device, derived from events whose body contains `journey` and `jcount` fields. Returns journey metadata only (no event payloads). Capped at 100 most recent journeys; `has_more` is true when the cap is hit.
parameters:
- $ref: '#/components/parameters/projectOrProductUIDParam'
- $ref: '#/components/parameters/deviceUIDParam'
Expand All @@ -1342,15 +1342,15 @@ paths:
format: date-time
journey_id:
description: |
Identifier of the journey, taken from the `journey` field on `_track.qo` events. This value is itself a Unix timestamp marking the start of the journey.
Identifier of the journey, taken from the numeric `journey` field in the event body. This value is itself a Unix timestamp marking the start of the journey.
type: integer
format: int64
start_date:
description: Earliest event time within the journey.
type: string
format: date-time
total_events:
description: The number of _track.qo events in the journey.
description: The number of events in the journey.
type: integer
format: int64
required:
Expand All @@ -1375,14 +1375,14 @@ paths:
get:
operationId: GetDeviceJourney
description: |
Get a single journey for a device along with its `_track.qo` events. The events array is paginated via `pageSize` / `pageNum`; use `journey.has_more` to detect additional pages.
Get a single journey for a device along with its events. The events array is paginated via `pageSize` / `pageNum`; use `journey.has_more` to detect additional pages.
parameters:
- $ref: '#/components/parameters/projectOrProductUIDParam'
- $ref: '#/components/parameters/deviceUIDParam'
- name: journeyID
in: path
description: |
Identifier of the journey, taken from the `journey` field on `_track.qo` events (a Unix timestamp marking the start of the journey).
Identifier of the journey, taken from the numeric `journey` field in the event body (a Unix timestamp marking the start of the journey).
required: true
schema:
type: integer
Expand All @@ -1402,7 +1402,7 @@ paths:
type: string
format: date-time
journey:
description: Paginated `_track.qo` events for the journey.
description: Paginated events for the journey.
type: object
properties:
events:
Expand Down