Skip to content

Clarify recovery/verification API documentation #1321

Open
@Benehiko

Description

@Benehiko

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething is not working.featNew feature or request.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions