googleapis / googleapis/google-api-nodejs-client
The schema, not comments, should be the canonical place to find ‘readOnly’ and ‘deprecated’ status
- 主要言語
- TypeScript
- スター
- 12.2k
- フォーク
- 2k
- 平均マージ
- 1日 9時間
- マージ済み PR(30日)
- 24
説明
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
コントリビューションガイド
調査の方向性
まず、Android Management API のリポジトリ内のスキーマと、参照されている JSON Schema draft 7 および draft 2019-09 のドキュメントを確認します。読み取り専用または非推奨のフィールドが、コメントだけではなく、機械可読な readOnly または deprecated アノテーションで一貫して表現されるようになれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- json
- 領域
- api
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100