Clarify recovery/verification API documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia dalle pagine updateRecoveryFlow e updateVerificationFlow nell'Ory API reference, quindi esamina la discussione collegata per il contesto. Confronta i campi e i metodi delle richieste documentati con i flussi di recovery e verification in due fasi descritti nell'issue. Il lavoro è completato quando la documentazione spiega chiaramente quali campi e metodi si applicano a ogni stato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Preflight checklist
- I could not find a solution in the existing issues, docs, nor discussions.
- I agree to follow this project's Code of Conduct.
- I have read and am following this repository's Contribution Guidelines.
- This issue affects my Ory Network project.
- I have joined the Ory Community Slack.
- I am signed up to the Ory Security Patch Newsletter.
Describe your problem
The recovery API documentation shows all of the fields for the body on POST for all states.
https://www.ory.sh/docs/reference/api#tag/frontend/operation/updateRecoveryFlow
The verification API documentation doesn't even show the code method.
https://www.ory.sh/docs/reference/api#tag/frontend/operation/updateVerificationFlow
This might confuse some users since we don't indicate that the Recovery & Verification flows can have two states.
The recovery flow is submitted twice, once to get the email sent out to the email, and the second to submit the code sent out from the email.
The flow kind of looks a bit like this:
- Create recovery flow
- Submit email
- Re-render form based on response (or get flow data through ID)
- Submit code
- Get redirected to settings flow on success OR handle form error
Describe your ideal solution
We should update the description to indicate what is required when.
Not sure how we could show multiple states with the OpenAPI spec.
Workarounds or alternatives
None
Version
latest
Additional Context
https://github.com/orgs/ory/discussions/54#discussioncomment-5314981
- Lingua principale
- TypeScript
- Stelle
- 161
- Fork
- 1.9k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ory/docs
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
upstream reference closed: github.com/w3c/webauthn/issues/1372Forse di nuovo libera @Faisal-9999 l’ha presa 47 giorni fa e non c’è nessuna pull request aperta. Apertagood first issue help wanted upstream
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
-
good first issue help wanted upstream
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation contextForse di nuovo libera @hperl l’ha presa 99 giorni fa e non c’è nessuna pull request aperta. Aperta
Issue simili
-
docs(api): openapi.yaml still documents gif-tools optimize colors as 2-256 instead of 2, 4, 16, 256Apertaarea: backend documentation priority: low
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
snapotter-hq/SnapOtter#2919 ·
I maintainer di solito rispondono entro 1 giorno
-
accepted :+1: bug db/redis
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
beekeeper-studio/beekeeper-studio#4882 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
ready-for-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
konflux-ci/konflux-ui#1630 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
ahmedkhaleel2004/gitdiagram#233 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
simkimsia/netlify-axi#19 ·
I maintainer di solito rispondono entro 1 giorno