Skip to content
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

proposing "warnings" for response meta #105

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

proposing "warnings" for response meta #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions framework/json/responses/sections/beaconResponseMeta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
},
"testMode": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/TestMode"
},
"warnings": {
"description": "A list of \"warnings\", _i.e._ messages from the beacon about potential problems such as request parameters that could not be parsed or the reasons for a mismatch between request and response granularity.",
"items": "string",
"type": "array"
}
},
"required": [
Expand Down
7 changes: 7 additions & 0 deletions framework/src/responses/sections/beaconResponseMeta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ properties:
$ref: ../../common/beaconCommonComponents.yaml#/definitions/TestMode
receivedRequestSummary:
$ref: ./beaconReceivedRequestSummary.yaml
warnings:
description: >-
A list of "warnings", _i.e._ messages from the beacon about potential
problems such as request parameters that could not be parsed or the reasons
for a mismatch between request and response granularity.
type: array
items: string
required:
- beaconId
- apiVersion
Expand Down