Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update

Aberta
#809 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 4 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

Start with fabric/cluster-creation-management.md on the referenced docs/fabric-sharded-clusters branch and review related issue #539. Confirm the public API surface with the Fabric team, then document authentication, region and plan listing, cluster creation, updating, deletion, and error responses in a new fabric/ reference page. Done when the agreed behavior is documented and feature sections can link to the reference.

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

Descrição

content
Gap

The Fabric docs show Fabric API requests only inside feature sections. The new Sharded Clusters section on fabric/cluster-creation-management.md (branch docs/fabric-sharded-clusters) uses POST /Login/, POST /Cluster/, GET /Region/, GET /Plan/ and PUT /Cluster/<cluster id>/ in passing, because creating a sharded cluster is API-only until Studio offers it. Nothing documents those endpoints as such:

  • which fields a cluster create needs, and what each one does;
  • how to choose a plan and regions whose instanceCount adds up to what a feature needs (a sharded cluster needs at least shards × minOwners instances);
  • that regionPlans in a PUT is the complete set of regions, so a region left out is removed;
  • how an account that signs in to Studio without a password authenticates;
  • the error responses.
Impact

Each API-only feature re-explains sign-in and the create body in its own section, and a reader sizing a sharded cluster has to work out plan and region choice by trial and error.

Suggested fix

Add a fabric/ reference page for the Fabric API at https://fabric.harper.fast: authentication, listing regions and plans, and creating, updating and deleting a cluster. Agree the public surface with the Fabric team first, so the page documents only what is meant to be relied on. Feature sections such as Sharded Clusters then link to it instead of restating it. Related: #539 (a UI-independent reference for account, organization and cluster setup).

Review-Deferral: 8541bd35fc1a3d36 severity=nit category=documentation

🤖 Generated by Anthropic Claude Code (Claude Opus); posted via @kriszyp.

Linguagem predominante
MDX
Estrelas
9
Forks
9
Merge médio
5d 5h
PRs com merge (30d)
48

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 HarperFast/documentation

Todas as issues de HarperFast/documentation

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

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