-
Notifications
You must be signed in to change notification settings - Fork 32
Different ErrorInfo schemes in CAMARA_common.yaml and event-subscription-template.yaml #500
Copy link
Copy link
Closed
Labels
correctioncorrection in documentationcorrection in documentation
Description
Problem description
Commonalities/artifacts/camara-cloudevents/event-subscription-template.yaml
Lines 247 to 262 in 4141f4e
| ErrorInfo: | |
| type: object | |
| required: | |
| - status | |
| - code | |
| - message | |
| properties: | |
| status: | |
| type: integer | |
| description: HTTP response status code | |
| code: | |
| type: string | |
| description: Code given to this error | |
| message: | |
| type: string | |
| description: Detailed error description |
vs
Commonalities/artifacts/CAMARA_common.yaml
Lines 46 to 61 in 4141f4e
| ErrorInfo: | |
| type: object | |
| required: | |
| - message | |
| - status | |
| - code | |
| properties: | |
| message: | |
| type: string | |
| description: A human readable description of what the event represent | |
| status: | |
| type: integer | |
| description: HTTP response status code | |
| code: | |
| type: string | |
| description: Friendly Code to describe the error |
Expected behavior
Both files are using the same schema definition for ErrorInfo
Alternative solution
Ignore as the two definitions are equivalent. Maybe address in a later release.
Additional context
Found as raised by validation script in webRTC:
🟡 Medium: Schema Consistency
- Description: Schema
ErrorInfodiffers between files- Location:
webrtc-events-subscription.yaml vs webrtc-call-handling.yaml- Fix: Ensure
ErrorInfoschema is identical across all files
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
correctioncorrection in documentationcorrection in documentation