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

Aberta
  • Algo errado?
#173 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
56/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
go
Domínio
api, cli

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.
Linguagem predominante
Go
Estrelas
65
Forks
8
Merge médio
5d 7h
PRs com merge (30d)
3

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de gleanwork/glean-cli

Todas as issues de gleanwork/glean-cli

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.