Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify recovery/verification API documentation #1321

Open
6 tasks done
Benehiko opened this issue Mar 15, 2023 · 1 comment
Open
6 tasks done

Clarify recovery/verification API documentation #1321

Benehiko opened this issue Mar 15, 2023 · 1 comment
Labels
bug Something is not working. feat New feature or request.

Comments

@Benehiko
Copy link
Contributor

Preflight checklist

Describe your problem

The recovery API documentation shows all of the fields for the body on POST for all states.

image

https://www.ory.sh/docs/reference/api#tag/frontend/operation/updateRecoveryFlow

The verification API documentation doesn't even show the code method.
image

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:

  1. Create recovery flow
  2. Submit email
  3. Re-render form based on response (or get flow data through ID)
  4. Submit code
  5. 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

@Benehiko Benehiko added feat New feature or request. bug Something is not working. labels Mar 15, 2023
@Big-Brother-Man
Copy link

Big-Brother-Man commented Mar 15, 2023

Hey @Benehiko thank you for opening this. It will definitely help users who struggled with the two path ways i.e. email, then code like myself. It took me a while to understand this separation as nothing pointed to this in the docs.

For the verification code not showing that is also something I struggled with and documented part of an issue.

Many thanks for your help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is not working. feat New feature or request.
Projects
None yet
Development

No branches or pull requests

2 participants