googleapis / googleapis/google-api-nodejs-client
The schema, not comments, should be the canonical place to find ‘readOnly’ and ‘deprecated’ status
- Langage dominant
- TypeScript
- Étoiles
- 12.2k
- Forks
- 2k
- Merge moyen
- 1 j 9 h
- PR mergées (30 j)
- 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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par examiner les schémas du dépôt pour Android Management API ainsi que la documentation référencée de JSON Schema draft 7 et draft 2019-09. Le travail est terminé lorsque les champs en lecture seule ou obsolètes sont représentés de manière cohérente avec des annotations readOnly ou deprecated lisibles par machine, plutôt qu’avec des commentaires uniquement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- json
- Domaine
- api
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100