Documentation unclear on self-service flows post payload

[Benehiko]

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 Cloud project.
• I have joined the Ory Community Slack.
• I am signed up to the Ory Security Patch Newsletter.

Describe your problem

Some Kratos users have trouble implementing the self-service flows since the documentation doesn't make it clear that certain fields are required for the POST request to succeed and thus confuses them when Kratos redirects them back to the UI they POST'ed from. The documentation does hint at it in certain places such as here but does not give an example of a concrete explanation of things to look for (e.g. missing a field in the POST body).

When validation errors happen, browser clients receive a HTTP 302 Found redirect to the Registration Flow UI, containing the Registration Flow ID which includes the error payloads.

Describe your ideal solution

Add more concrete examples to the self-service flows and what the POST request expects the body to be (of course this would be a mock example).

Workarounds or alternatives

None

Version

v0.8

Additional Context

Since it is not clear in the documentation this question always comes up in the community slack as it frustrates users although it is an easy fix.

[aeneasr]

Contribs welcomed :)

[github-actions]

Hello contributors!

I am marking this issue as stale as it has not received any engagement from the community or maintainers for a year. That does not imply that the issue has no merit! If you feel strongly about this issue

• open a PR referencing and resolving the issue;
• leave a comment on it and discuss ideas on how you could contribute towards resolving it;
• leave a comment and describe in detail why this issue is critical for your use case;
• open a new issue with updated details and a plan for resolving the issue.

Throughout its lifetime, Ory has received over 10.000 issues and PRs. To sustain that growth, we need to prioritize and focus on issues that are important to the community. A good indication of importance, and thus priority, is activity on a topic.

Unfortunately, burnout has become a topic of concern amongst open-source projects.

It can lead to severe personal and health issues as well as opening catastrophic attack vectors.

The motivation for this automation is to help prioritize issues in the backlog and not ignore, reject, or belittle anyone.

If this issue was marked as stale erroneously you can exempt it by adding the backlog label, assigning someone, or setting a milestone for it.

Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you!

Thank you 🙏✌️