"nullable" cannot be used without "type" linter error

[sonasingh46]

The oas3-valid-media-example linter complains about using nullable type when using allOf. I am using the below example schema:

openapi: 3.0.1
info:
  title: User API
  description: The User API allows managing users.
  version: 0.1.0
paths:
  /api/v1/user:
    patch:
      summary: Patch User
      operationId: patchUser
      requestBody:
        description: Patch user body
        required: true
        content:
          application/json:
            example:
              Name: test
            schema:
              $ref: "#/components/schemas/PatchRequest"
      responses:
        "200":
          description: The patched user.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Name"

components:
  schemas:
    Name:
      type: string
      description: Name of the user.
      maxLength: 255
      minLength: 1

    ID:
      type: string
      description: ID of the user.
      maxLength: 255
      minLength: 1

    PatchRequest:
      description: Patch user
      allOf:
        - $ref: "#/components/schemas/Name"
        - $ref: "#/components/schemas/ID"
      minProperties: 1
      nullable: true

Why does the linter complain while using nullable:true ? Also, when i remove the example from the spec, the error goes away. I am using this code generator https://github.com/deepmap/oapi-codegen and it generates the code as expected and works fine.

[jamietanna]

Is the PatchRequest meant to be an object (i.e. with the keys id and/or name), or is it expected that it's just a string?

The code generated via oapi-codegen shows it as type PatchRequest = string but I'm not sure if that's right based on the intent?

[sonasingh46]

With the current given schema it generates the following. It does not generate type PatchRequest = string.

// ID ID of the user.
type ID string

// Name Name of the user.
type Name string

// PatchRequest defines model for PatchRequest.
type PatchRequest struct {
	// Embedded struct due to allOf(#/components/schemas/Name)
	Name `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/ID)
	ID `yaml:",inline"`
}

And if I add nullable:true to the following :

  schemas:
    Name:
      type: string
      description: Name of the user.
      maxLength: 255
      minLength: 1
      nullable: true
      
    ID:
      type: string
      description: ID of the user.
      maxLength: 255
      minLength: 1
      nullable: true

The spectral lint complains as below:

 16:21    error  oas3-valid-media-example  "example" property type must be string                         paths./api/v1/user.patch.requestBody.content.application/json.example