googleapis / googleapis/google-api-nodejs-client

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

Abierto
#2,995 0 comentarios 0 reacciones 0 asignados Ver en GitHub
priority: p3 type: feature request
Lenguaje dominante
TypeScript
Estrellas
12.2k
Forks
2k
Merge medio
1 d 9 h
PR fusionados (30 d)
24

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza revisando los esquemas del repositorio para Android Management API y la documentación referenciada de JSON Schema draft 7 y draft 2019-09. El trabajo estará terminado cuando los campos de solo lectura o obsoletos se representen de forma coherente con anotaciones readOnly o deprecated legibles por máquinas, en lugar de solo con comentarios.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
json
Área
api
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.