documents, users, departments: expose the experimental platform APIs behind an opt-in

Abierto
  • ¿Algo no está bien?
#173 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
1-2 días
Aptitud para principiantes
56/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
api, cli

Línea de trabajo

Start by reading the CLI command implementations for documents and entities read-people, then compare how search and agents switched to platform APIs. Check how agent-help marks experimental commands and how requests add the opt-in header. Done means the new API commands send the header only after explicit opt-in, while classic commands retain their current behavior.

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

Descripción

enhancement

Several platform APIs are experimental: callers must send X-Glean-Include-Experimental: true. They cover things the CLI does today through classic endpoints, and api-client-go v0.17.3 models them:

  • Documents: GET /api/documents (by URL), GET /api/documents/{document_id}, POST /api/documents/batch (Glean.Documents.GetByURL, GetByID, Batch). Today glean documents uses classic getdocuments and getdocumentsbyfacets.
  • People: GET /api/users, GET /api/users/{user_id}, GET /api/departments, GET /api/departments/{department_id} (Glean.Users, Glean.Departments). Today glean entities read-people uses classic people.

Proposal

Expose these behind an explicit opt-in, so the CLI never sends the experimental header without the user asking. Options include a global --experimental flag or separate subcommands, such as documents get --by-url and users list / users get. Keep the classic commands as the default until the APIs are GA, then switch them to platform-first the way search and agents were switched.

Done when

  • Each experimental command sends the header only when the user opts in, and agent-help marks it as experimental.
  • The classic commands behave the same as before.
Lenguaje dominante
Go
Estrellas
65
Forks
8
Merge medio
5 d 7 h
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de gleanwork/glean-cli

Todos los issues de gleanwork/glean-cli

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.