Clarify recovery/verification API documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, documentation
Línea de trabajo
Empieza con las páginas updateRecoveryFlow y updateVerificationFlow de la referencia de la API de Ory y, después, revisa la discusión enlazada para obtener contexto. Compara los campos y métodos de solicitud documentados con los flujos de recuperación y verificación en dos etapas descritos en el issue. Se considera terminado cuando la documentación explica claramente qué campos y métodos corresponden a cada estado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- TypeScript
- Estrellas
- 161
- Forks
- 1.9k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ory/docs
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
good first issue help wanted upstream
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
-
good first issue help wanted upstream
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation contextQuizá libre de nuevo @hperl la tomó hace 80 días y no hay ningún pull request abierto. Abierto
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
lichess-org/api#678 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
PostHog/posthog.com#20628 ·
Los mantenedores suelen responder en 1 día
-
bug status:Needs Triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
jupyterlab/jupyterlab#19964 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
agentscope-ai/QwenPaw#8064 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
area: notebooks-jupyter bug theme: new notebook frontend
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
posit-dev/positron#16347 · 1 comentario ·
Los mantenedores suelen responder en 1 día