Skip to main content

Added Support for Read-Only and Write-Only Field Properties in API Portal

· 2 min read

​ We have added support of read-only and write-only properties in the API Developer Portal. The read-only and write-only tags have been changed to Response Only and Request Only respectively.

Details

What does Response Only mean?

Declaring the property as Response Only means that it may be sent as a part of the response but should not be sent as part of the request. If the Response Only property is marked as true and is in the required list, the specified action takes effect on the response only.

What does Request Only mean?

Declaring the property as Request Only means that it may be sent as a part of the request but should not be sent as a part of the response. If the Request Only property is marked as true and is in the required list, the specified action takes effect on the request only.

note

A property MUST NOT be marked true for both Response Only and Request Only.

What's Changed?

API Code Playground

On the API Code Playground, the Response Only properties are hidden. This basically means that the property that is marked as Response Only will not be visible in the Playground.

API Code Playground

Models/Fields Reference Page

On the Models/Fields reference in the API Portal, the Response Only and Request Only tags indicate the user about the field in the model as either Response Only or Request Only.

Request Only:

Request Only

Response Only:

Response Only