readOnly attribute not rendered as property metadata

[danilobuerger]

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.0.0
Which Swagger-UI version?	3.9.2
How did you install Swagger-UI?	NPM
Which browser & version?	Google Chrome, 63.0.3239.132 (Official Build) (64-bit)
Which operating system?	MacOS X 10.13.2

Demonstration API definition

openapi: 3.0.0
info:
  version: 1.0.0
  title: Test
paths:
  /plan:
    post:
      summary: Creates a Test
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Test'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Test'
components:
  schemas:
    SomeSchema:
      required:
        - hello
      properties:
        hello:
          type: string
    Test:
      required:
        - field1
        - field2
      properties:
        field1:
          type: string
        field2:
          allOf:
            - $ref: '#/components/schemas/SomeSchema'
          readOnly: true

Configuration (browser query string, constructor, config.yaml)

n.a.

Expected Behavior

Request Body Model should match Example value:

{
  "field1": "string"
}

Current Behavior

Request Body Model shows field2 as well:

It is not visible that this field is readOnly.

Possible Solution

Context

[scottohara]

Is this the same as #3445?

(if you expand the definition of field2 on the right hand side of the Model, does it show hello as a readOnly string field?)

[danilobuerger]

No

[scottohara]

OK, thanks.

I can see that field2 is showing as an object, but if I understand correctly, readOnly is typically set on properties of an object and not the object itself (but I could be wrong on this).

See here for some related discussion: OAI/OpenAPI-Specification#872

[danilobuerger]

I personally would expect that field2 doesn't even show up there so that the model matches the example value. But if we can only mark it as readOnly, it should, as the spec doesn't prohibit this.

[webron]

Updating the title to represent the issue. The readOnly information is missing both in the operations and the models section.

[nzav]

Any updates on this?

[stgiaf]

Facing the same issue in SwaggerHub as well. Any update?

[CameronGo]

This is a pretty significant issue, the fact that you cannot tell from the API documentation when an object is readOnly. Has there been any movement to address this?

[ChMThiel]

Any progress here? Only description will be rendered (and the ref) if allOf is used:

quantityScrap:
  allOf:
  - $ref: '#/components/schemas/Quantity'
  - description: Total scrapped quantity booked at any Workstep
    default: My Default
    readOnly: true

will lead to something like this (default/readOnly is not shown):