google-api-nodejs-client icon indicating copy to clipboard operation
google-api-nodejs-client copied to clipboard

The schema, not comments, should be the canonical place to find ‘readOnly’ and ‘deprecated’ status

Open joconor opened this issue 2 years ago • 0 comments

I’m working with the Android Management API and I notice that a couple fields have ‘readOnly’ status, but many fields that are read only are not so annotated. And there is no use of the ‘deprecated’ annotation at all anywhere in the schema. It’s great that these states are called out in the comments (well, better than nothing), the whole point of a json-schema is for all the attributes of an API be machine readable. Please consider making both ‘readOnly’ and ‘deprecated’ mandatory annotations in your schemas for fields that are read only or deprecated.

See https://json-schema.org/understanding-json-schema/reference/generic.html info about draft 7 and draft 2019-09

joconor avatar Jun 07 '22 14:06 joconor