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

Offen
  • Stimmt etwas nicht?
#173 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
56/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
go
Bereich
api, cli

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Go
Sterne
65
Forks
8
Ø Merge
5 T. 7 Std.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus gleanwork/glean-cli

Alle Issues in gleanwork/glean-cli

Ähnliche Issues

Weitere Issues zu Go

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.