Skip to content

Validation message when oneOf fails for example(s) #1489

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

Jump to bottom
Closed
joeljons opened this issue Sep 12, 2017 · 1 comment · Fixed by #1985
Closed

Validation message when oneOf fails for example(s) #1489

joeljons opened this issue Sep 12, 2017 · 1 comment · Fixed by #1985
Labels
cat: validation epic: schema validation error quality P2 type: bug version: 3.x

Comments

@joeljons
Copy link

joeljons commented Sep 12, 2017 •
edited by webron
Loading

Q A
Bug or feature request? ¯\(ツ)/¯
Which Swagger/OpenAPI version? OAS3
Which Swagger-Editor version? 3.1.6
How did you install Swagger-Editor? -
Which broswer & version? Chrome
Which operating system? Windows

Demonstration API definition

openapi: 3.0.0
info:
  version: "validation"
  title: Spec with both example and examples
paths:
  /myPath:
    get:
      responses:
        '200':
          description: OK
          content:
            text/plain:
              example: sample response
              examples:
                foo:
                  value: anonther response

Expected Behavior

One error message that states that I can't have both example and examples in paths['/myPath'].get.responses['200'].content['text/plain']

Current Behavior

Three error messages there neither one of them nails the error description.
@shockey shockey added this to the Friday, November 10 milestone Nov 3, 2017
@shockey shockey removed this from the Friday, November 10 milestone Nov 17, 2017
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 9, 2019
@shockey
add clear not error message (for swagger-api#1489)
e744ba2
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 10, 2019
@shockey
add clear not error message (for swagger-api#1489)
3e0462b
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 11, 2019
@shockey
rewrite Response/Reference oneOf (for swagger-api#1489)
0305b5e
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 11, 2019
@shockey
add clear not error message (for swagger-api#1489)
e0306f9
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 11, 2019
@shockey
rewrite Response/Reference oneOf (for swagger-api#1489)
14f4c0b
@shockey shockey mentioned this issue Apr 12, 2019
Merged
17 tasks
@shockey
Copy link
Contributor

shockey commented Apr 12, 2019

I've opened a pull request (#1985) that will close this issue.

Here's what Swagger Editor reports with my changes:

Structural error at [...]200.content.text/plain
should not have both `example` and `examples`, as they are mutually exclusive

shockey added a commit to shockey/swagger-editor that referenced this issue Apr 17, 2019
@shockey
add clear not error message (for swagger-api#1489)
a24b47a
shockey added a commit to shockey/swagger-editor that referenced this issue Apr 17, 2019
@shockey
rewrite Response/Reference oneOf (for swagger-api#1489)
6d4f37a
shockey added a commit that referenced this issue Apr 18, 2019
@shockey
improvement: schema validation error quality, phase 2 (via #1985)
06a5ad2 
* adopt @webron's OpenAPI 3.0 schema from OAI/OpenAPI-Specification#1270

permalink: https://github.com/OAI/OpenAPI-Specification/blob/92e15eba1d4591ebfe8c11898c48241e72854381/schemas/v3.0/schema.yaml

* add ajv-errors

* address error messages for #1808's Swagger 2.0 example

clarifies the schema and adds custom error messages for unclear error conditions

* address error messages for #1808's OpenAPI 3.0 example

* restrict underlying JSON Schema `type` field to simple types only (for #1832)

* fix limitation in JSON Pointer conversion helper

* add clear `not` error message (for #1489)

* add additionalProperties message (for #1394)

* add ajv-keywords

* use `switch` to intelligently identify inline vs referenced content (for #1853)

* use `switch` to XOR `schema` and `content` (for #1853)

* use `switch` to pivot security scheme based on type

(for #1672)

* use switch to fall-through to inline security scheme validation (for #1672)

* rewrite more Reference oneOfs (for #1519)

* add custom message for `Schema.required` type error (for #1519)

* rewrite Response/Reference oneOf (for #1489)

* use switch in ParameterLocation validation (for #1797)

* define pivot key switches for SecurityDefinitions (for #1711)

* give helpful `format: uri` messages for SecurityDefinitions (for #1711)

* eliminate NonBodyParameter; pivot on `Parameter.in` with a switch (for #1511)

* oneOf -> switch for Parameters.items reference

* (for #1711)

* remove redundant semantic validator (for #1511)

* adjust wording of custom error message (for #1853)

* add regression tests for all related issues

* revert to expect@^1.20.2

* linter fixes

* fix messaging flaw for #1832

* improve messaging for #1394

* use literal key for `$ref` in Reference Object

* remove commented legacy data from OAS3 schema

* remove superfluous quotation marks

* normalize test case paths to `/`

* normalize openapi fields to 3.0.0

* drop unused `paths` information

* ensure clear errors for 3.0 Parameter style/content exclusivity

* add `required` assertions to switch statements that pivot on a key's value

this prevents false positives when the pivot key is missing entirely

* remove stray space
shockey added a commit to shockey/swagger-editor that referenced this issue May 23, 2019
@shockey
improvement: schema validation error quality, phase 2 (via swagger-ap…
a76cfbb 
…i#1985)

* adopt @webron's OpenAPI 3.0 schema from OAI/OpenAPI-Specification#1270

permalink: https://github.com/OAI/OpenAPI-Specification/blob/92e15eba1d4591ebfe8c11898c48241e72854381/schemas/v3.0/schema.yaml

* add ajv-errors

* address error messages for swagger-api#1808's Swagger 2.0 example

clarifies the schema and adds custom error messages for unclear error conditions

* address error messages for swagger-api#1808's OpenAPI 3.0 example

* restrict underlying JSON Schema `type` field to simple types only (for swagger-api#1832)

* fix limitation in JSON Pointer conversion helper

* add clear `not` error message (for swagger-api#1489)

* add additionalProperties message (for swagger-api#1394)

* add ajv-keywords

* use `switch` to intelligently identify inline vs referenced content (for swagger-api#1853)

* use `switch` to XOR `schema` and `content` (for swagger-api#1853)

* use `switch` to pivot security scheme based on type

(for swagger-api#1672)

* use switch to fall-through to inline security scheme validation (for swagger-api#1672)

* rewrite more Reference oneOfs (for swagger-api#1519)

* add custom message for `Schema.required` type error (for swagger-api#1519)

* rewrite Response/Reference oneOf (for swagger-api#1489)

* use switch in ParameterLocation validation (for swagger-api#1797)

* define pivot key switches for SecurityDefinitions (for swagger-api#1711)

* give helpful `format: uri` messages for SecurityDefinitions (for swagger-api#1711)

* eliminate NonBodyParameter; pivot on `Parameter.in` with a switch (for swagger-api#1511)

* oneOf -> switch for Parameters.items reference

* (for swagger-api#1711)

* remove redundant semantic validator (for swagger-api#1511)

* adjust wording of custom error message (for swagger-api#1853)

* add regression tests for all related issues

* revert to expect@^1.20.2

* linter fixes

* fix messaging flaw for swagger-api#1832

* improve messaging for swagger-api#1394

* use literal key for `$ref` in Reference Object

* remove commented legacy data from OAS3 schema

* remove superfluous quotation marks

* normalize test case paths to `/`

* normalize openapi fields to 3.0.0

* drop unused `paths` information

* ensure clear errors for 3.0 Parameter style/content exclusivity

* add `required` assertions to switch statements that pivot on a key's value

this prevents false positives when the pivot key is missing entirely

* remove stray space
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cat: validation epic: schema validation error quality P2 type: bug version: 3.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

improvement: schema validation error quality, phase 2 shockey/swagger-editor
3 participants
@webron @shockey @joeljons