SwaggerEditor@next: false positive in linting JSON Schema

[quizwedge]

Q&A (please complete the following information)

• OS: macOS
• Browser: Chrome
• Version: 111.0.5563.110
• Method of installation: None. This is at https://editor-next.swagger.io/
• Swagger-UI version: Unknown
• Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

Example Swagger/OpenAPI definition:

openapi: 3.0.3
info:
  title: Test
  version: 1.0.0
components:
  schemas:
    ObjectOne:
      type: object
      properties:
        propertyOne:
          type: string
    ObjectTwo:
      type: object
      properties:
        propertyTwo:
          type: string
paths:
  /test:
    post:
      requestBody: 
        content:
          application/json:
            schema: 
              oneOf:
                - $ref: '#/components/schemas/ObjectOne'
                - $ref: '#/components/schemas/ObjectTwo'
        required: true
      responses:
        '204':
          description: Successful operation

Swagger-UI configuration options:
None

Describe the bug you're encountering

The editor shows an error on line 23 saying, "oneOf must be a non-empty array of schemas" but it is an array of schemas.

To reproduce...

Steps to reproduce the behavior:

1. Go to https://editor-next.swagger.io/.
2. Enter the YAML above.
3. See error.

Expected behavior

No errors or warnings.

Screenshots

[char0n]

@quizwedge,

Thanks for reporting this. I'm transferring this issue under swagger-editor repo.

[dennewbie]

I have the same issue

[diegorendon]

I have the same issue too.
It also happens with allOf.

[jmo927]

Same issue with anyOf, allOf, and oneOf

[char0n]

Underlying issue is swagger-api/apidom#2481

JSON Schemas needs to be consolidated within the apidom-ls package.

[xdubx]

Same here.

openapi: 3.0.0
servers:
  - url: "http://localhost:3000/api/v1"
    variables: {}
info:
  description: Test
  version: 1.0.0
  title: Test
paths:
  /pets:
    patch:
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/Cat'
                - $ref: '#/components/schemas/Dog'
      responses:
        '200':
          description: Updated
components:
  schemas:
    Dog:
      type: object
      properties:
        bark:
          type: boolean
        breed:
          type: string
          enum: [Dingo, Husky, Retriever, Shepherd]
    Cat:
      type: object
      properties:
        hunts:
          type: boolean
        age:
          type: integer

Line	Description
15	oneOf must be a non-empty array of schemas

From the example https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/#anyof

[Brunnn]

Any updates on this? this is stopping me from using the api-dom validator github action, because my definition is right, but the workflow just throws those "errors"...

"responses": {
  "200": {
      "description": "Ok",
      "content": {
          "application/json": {
              "schema": {
                  "allOf": [
                      {
                          "$ref": "#/components/schemas/CursorPaginationBase"
                      },
                      {
                          "properties": {
                              "data": {
                                  "type": "array",
                                  "items": {
                                      "$ref": "#/components/schemas/ProductResource"
                                  }
                              }
                          },
                          "type": "object"
                      }
                  ]
              }
          }
      }
  },

[char0n]

It looks like the main issue is with allOf, oneOf and anyOf keywords. I'll try to see if I can provide a quick bug fix for those (without doing all the lengthy consolidation effort).

[goors]

This makes problem in generator as well. If there is an error such as this, $ref properties will not be generated (swift5).

For example, in some model, among other stuff, I have:

"Text": {
     "type": "string"
},
"Data": {
    "type": "string"
},
"Level": {
    "nullable": true,
    "oneOf": [
         {
               "$ref": "#/components/schemas/UserAdventureLevel"
         }
     ]
}

Generator will ignore that $ref, and it will only generate properties before or after.

[char0n]

@goors, if by generator you're referring to the swagger-codegen please create an issue at that repo.

[frantuma]

fixed by swagger-api/apidom#2987

[Brunnn]

Is this really fixed? I've tested on https://editor-next.swagger.io/ the example usage of the oneOf presented in the docs:

openapi: "3.0.0"
info:
  title: Simple API overview
  version: 2.0.0
paths:
  /pets:
    patch:
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/Cat'
                - $ref: '#/components/schemas/Dog'
      responses:
        '200':
          description: Updated
components:
  schemas:
    Dog:
      type: object
      properties:
        bark:
          type: boolean
        breed:
          type: string
          enum: [Dingo, Husky, Retriever, Shepherd]
    Cat:
      type: object
      properties:
        hunts:
          type: boolean
        age:
          type: integer

Still giving the same error:

[char0n]

@Brunnn It's been fixed but haven't been released and deployed yet. ETA for release/deploy today/tommorow.

[char0n]

Released in https://github.com/swagger-api/swagger-editor/releases/tag/v5.0.0-alpha.72

[char0n]

@Brunnn are you able to use api-dom validator github action now?

[Brunnn]

Yes, its working perfect now! Thanks @char0n.