Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update
Les mainteneurs répondent en général sous 4 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- markdown
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
instanceCountadds up to what a feature needs (a sharded cluster needs at leastshards×minOwnersinstances); - that
regionPlansin aPUTis 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.
- Langage dominant
- MDX
- Étoiles
- 9
- Forks
- 9
- Merge moyen
- 5 j 5 h
- PR mergées (30 j)
- 48
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de HarperFast/documentation
-
Document http.maxRequestBodySize (REST, MCP application endpoint, and operations API body limits)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
HarperFast/documentation#806 ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
HarperFast/documentation#803 ·
Les mainteneurs répondent en général sous 4 jours
-
content
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
HarperFast/documentation#785 ·
Les mainteneurs répondent en général sous 4 jours
-
content
Difficulté 2/5 Une demi-journée Accessibilité débutants 68/100
HarperFast/documentation#770 ·
Les mainteneurs répondent en général sous 4 jours
-
content
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
HarperFast/documentation#769 ·
Les mainteneurs répondent en général sous 4 jours
Toutes les issues de HarperFast/documentation
Issues similaires
-
入群码过期Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 84/100
aliyun/ai-agent-handbook#29 · 1 commentaire ·
-
docs documentation need-triage SaaS
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)Ouvertesync-en
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)Ouvertesync-en
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 73/100
sleepyviper1213/redis#30 ·