Skip to content

Define report schema in more detail #29

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

Merged
phev8 merged 8 commits into from
Dec 22, 2025
Merged

Define report schema in more detail #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4fb9077
Define report schema in more detail
kschneider84 Dec 18, 2025
e2a7195
adjust required report parameter in management API
kschneider84 Dec 18, 2025
2db9aea
Adjust report schema of management API zu participant API
kschneider84 Dec 18, 2025
d2d7407
fix typo
kschneider84 Dec 19, 2025
caa4359
Add modifiedAt to report attributes
kschneider84 Dec 19, 2025
e03c6ac
Change responseID to not required
kschneider84 Dec 19, 2025
d596aff
add additonalProperties attribute
kschneider84 Dec 22, 2025
7efb892
fix syntax bug
kschneider84 Dec 22, 2025
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
4 changes: 4 additions & 0 deletions content/docs/participant-management/reports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ A "report" is a data entry for a participant with the following fields in the da
type: 'number',
required: true,
},
modifiedAt: {
description: 'Date-time format of the last modification of the report',
type: 'string'
},
data: {
description: 'Optional list of key/value data points attached to the report',
type: 'Array<ReportDataItem> (optional)',
Expand Down
30 changes: 16 additions & 14 deletions public/openapi/management-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@
"properties": {
"id": {
"type": "string",
"description": "ObjectID"
"description": "MongoDB ObjectID as hex string"
},
"key": {
"type": "string"
Expand All @@ -815,7 +815,8 @@
"type": "string"
},
"timestamp": {
"type": "integer"
"type": "integer",
"description": "Unix timestamp"
},
"modifiedAt": {
"type": "string",
Expand All @@ -824,26 +825,27 @@
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
"$ref": "#/components/schemas/ReportData"
}
}
},
"additionalProperties": false,
"description": "Report object"
"description": "Report object",
"required": [
"key",
"participantID",
"timestamp"
]
},
"ReportData": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"dtype": {
"type": "string"
}
"key": { "type": "string" },
"value": { "type": "string" },
"dtype": {
"type": "string",
"enum": ["date", "float", "int", "string", "rawMessage", "keyList"]
}
},
"additionalProperties": false
Comment thread
kschneider84 marked this conversation as resolved.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
Expand Down
63 changes: 60 additions & 3 deletions public/openapi/participant-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3619,7 +3619,21 @@
"PaginationInfos": {
"type": "object",
"description": "Pagination information",
"additionalProperties": true
"properties": {
"totalCount": {
"type": "integer"
},
"currentPage": {
"type": "integer"
},
"totalPages": {
"type": "integer"
},
"pageSize": {
"type": "integer"
}
},
"additionalProperties": false
},
"SubmissionHistory": {
"type": "object",
Expand All @@ -3628,8 +3642,51 @@
},
"Report": {
"type": "object",
"description": "report object",
"additionalProperties": true
"description": "Report object",
"properties": {
"id": {
"type": "string",
"description": "MongoDB ObjectID as hex string"
},
"key": {
"type": "string"
},
"participantID": {
"type": "string"
},
Comment thread
kschneider84 marked this conversation as resolved.
"responseID": {
"type": "string"
},
"timestamp": {
"type": "integer",
"description": "Unix timestamp"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": { "type": "string" },
"value": { "type": "string" },
"dtype": {
"type": "string",
"enum": ["date", "float", "int", "string", "rawMessage", "keyList"]
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
"additionalProperties": false
}
}
Comment thread
kschneider84 marked this conversation as resolved.
},
"required": [
"key",
"participantID",
"timestamp"
],
"additionalProperties": false
},
"Participant": {
"type": "object",
Expand Down