googleapis / googleapis/google-api-nodejs-client

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

Open
#2,995 0 comments 0 reactions 0 assignees View on GitHub
priority: p3 type: feature request
Dominant language
TypeScript
Stars
12.3k
Forks
2k
Avg merge
1d 9h
Merged PRs (30d)
24

Description

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

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository’s schemas for the Android Management API and the referenced JSON Schema draft 7 and draft 2019-09 documentation. The work is done when fields that are read-only or deprecated are consistently represented with machine-readable readOnly or deprecated annotations rather than comments alone.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.