mirror of
https://github.com/discourse/discourse.git
synced 2026-08-11 02:59:07 +08:00
cd98d818dcThe shared JSON endpoint examples used to validate schemas with a
boolean
assertion and print one ad hoc hint to stdout. A failure was hard to act
on:
```
VALUE AT "/access_control": {"mandatory_acl" => {}}
POSSIBLE ISSUE W/: /access_control
expected: true
got: false
```
That output hid the real validator error, only showed the first failure,
and did not explain whether the response or schema needed to change.
Build a proper RSpec failure message from all JSONSchemer validation
results
instead. Each error now includes the issue, validator error, data path,
schema path, offending value, optional parent/details context, and a
concrete
suggested fix.
For unexpected properties:
```
JSON schema validation failed with 1 error:
1. Unexpected property at /access_control
Error: object property at `/access_control` is a disallowed additional property
Data path: /access_control
Schema path: /additionalProperties
Value:
{
"mandatory_acl": {}
}
Suggested fix: If this response/request field is intentional, add this entry
to the parent schema's `properties` object:
{
"access_control": {
"type": "object",
"additionalProperties": false,
"properties": {
"mandatory_acl": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"mandatory_acl"
]
}
}
If the field is always present, also add "access_control" to the parent
schema's `required` array.
```
For missing required properties, the message now groups missing keys and
shows
the response root plus validator details:
```
Missing required properties default_archetype, notification_types at root
Error: object at root is missing required properties: ...
Details:
{
"missing_keys": [
"default_archetype",
"notification_types"
]
}
Suggested fix: Add default_archetype, notification_types to the
response/request, or remove them from `required` at root schema.
```
For type mismatches, the message now points at the mismatched schema
node and
suggests an inferred replacement shape:
```
Error: value at `/access_control` is not an array
Data path: /access_control
Schema path: /properties/access_control
Value:
{
"mandatory_acl": {}
}
Suggested fix: Update the payload to match the documented `type`, or replace
the schema at /properties/access_control with:
{
"type": "object",
"additionalProperties": false,
"properties": {
"mandatory_acl": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"mandatory_acl"
]
}
```
|
||
|---|---|---|
| .. | ||
| schemas | ||
| shared | ||
| backups_spec.rb | ||
| badges_spec.rb | ||
| categories_spec.rb | ||
| groups_spec.rb | ||
| invites_spec.rb | ||
| multiple_invites_spec.rb | ||
| notifications_spec.rb | ||
| posts_spec.rb | ||
| private_messages_spec.rb | ||
| rate_limits_spec.rb | ||
| search_spec.rb | ||
| site_spec.rb | ||
| tags_spec.rb | ||
| topics_spec.rb | ||
| uploads_spec.rb | ||
| user_badges_spec.rb | ||
| users_spec.rb | ||
