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

Aperta
  • Qualcosa non va?
#173 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
1-2 giorni
Idoneità per principianti
56/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go
Ambito
api, cli

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Go
Stelle
65
Fork
8
Merge medio
5g 7h
PR unite (30g)
3

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di gleanwork/glean-cli

Tutte le issue di gleanwork/glean-cli

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.