Skip to content

📝 Docs / Sync migration guide & changelog with 1.1.1 changes#34

Merged
docJerem merged 1 commit into
mainfrom
docs/sync-with-1.1.1-changelog
May 26, 2026
Merged

📝 Docs / Sync migration guide & changelog with 1.1.1 changes#34
docJerem merged 1 commit into
mainfrom
docs/sync-with-1.1.1-changelog

Conversation

@docJerem

Copy link
Copy Markdown
Owner

What

Bring the docs in line with the v1.1.1 changelog entries.

  • Migration guideconsume_signin_response/2's documented return shape was stale. Added the flow: field and a note on its values, matching the source @doc and the actual 1.1.1 behaviour:
    {:ok, %{flow: flow, assertion: assertion, nonce: nonce, user_token: token, redirect_uri: uri}}
  • CHANGELOG — the [1.1.1] heading had no compare-link reference at the bottom (the list stopped at 1.1.0), so the version heading wasn't linked like the others. Added the missing reference.

Notes

  • The generated ExDoc output under doc/ was also rebuilt locally (mix docs) to reflect 1.1.1 — the flow: field and the renamed :idp_initiated_not_allowed atom — but doc/ is gitignored, so it's not part of this PR.
  • README.md was reviewed and left unchanged: none of the 1.1.1 changes touch its documented surface (the IdP-initiated flow is already listed as supported; the return shape and error atoms aren't documented there).

- Add flow: field to consume_signin_response/2 return shape in the
  Samly migration guide (matches the source @doc and 1.1.1 behaviour)
- Add the missing [1.1.1] compare-link reference at the bottom of the
  changelog so the version heading is linked like the others
@docJerem docJerem merged commit 61d23a4 into main May 26, 2026
2 of 3 checks passed
docJerem added a commit that referenced this pull request May 26, 2026
@docJerem docJerem mentioned this pull request May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant