Intention behind `properties` on the same level with `anyOf` #805

kean · 2021-12-18T21:16:15Z

kean
Dec 18, 2021

Hi,

I'm working on an OpenAPI code generator and I'm using GitHub's spec as a primary example. I've covered all of the paths and schemas except for the following construct where properties and anyOf are used on the same level (see operationId: gists/update):

requestBody:
  required: true
  content:
    application/json:
      schema:
        properties:
          description:
            description: Description of the gist
            example: Example Ruby script
            type: string
          files:
            description: Names of files to be updated
            example:
              hello.rb:
                content: blah
                filename: goodbye.rb
            type: object
            additionalProperties:
              type: object
              nullable: true
              properties:
                content:
                  description: The new content of the file
                  type: string
                filename:
                  description: The new filename for the file
                  type: string
                  nullable: true
              anyOf:
              - required:
                - content
              - required:
                - filename
              - type: object
                maxProperties: 0
        anyOf:
        - required:
          - description
        - required:
          - files
        type: object
        nullable: true

If I put this schema in Swagger Editor, it fails to produce a comprehensible result.

I'm not sure if that construct is allowed in OpenAPI. At least I couldn't find any examples of this outside of GitHub spec.

If you take a step back and think about the intention behind this schema, isn't it the same thing as the following:

requestBody:
  required: true
  content:
    application/json:
      schema:
        type: object
        properties:
          description:
            description: Description of the gist
            example: Example Ruby script
            type: string
            nullable: true
          files:
            description: Names of files to be updated
            example:
              hello.rb:
                content: blah
                filename: goodbye.rb
            type: object
            nullable: true
            additionalProperties:
              type: object
              properties:
                content:
                  description: The new content of the file
                  type: string
                filename:
                  description: The new filename for the file
                  type: string
              required:
                - content

It's a much simpler definition and this is what the code generator produces for me with the update schema:

public struct PatchRequest: Encodable {
    /// Description of the gist
    ///
    /// Example: "Example Ruby script"
    public var description: String?
    /// Names of files to be updated
    ///
    /// Example:
    ///
    /// {
    ///   "hello.rb" : {
    ///     "content" : "blah",
    ///     "filename" : "goodbye.rb"
    ///   }
    /// }
    public var files: [String: File]?

    public struct File: Encodable {
        /// The new content of the file
        public var content: String
        /// The new filename for the file
        public var filename: String?

        public init(content: String, filename: String? = nil) {
            self.content = content
            self.filename = filename
        }
    }

    public init(description: String? = nil, files: [String: File]? = nil) {
        self.description = description
        self.files = files
    }
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Intention behind `properties` on the same level with `anyOf` #805

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Intention behind properties on the same level with anyOf #805

Uh oh!

Uh oh!

kean Dec 18, 2021

Replies: 0 comments

Intention behind `properties` on the same level with `anyOf` #805

kean
Dec 18, 2021