Skip to content

docs: align SendOtp contract and customer guidance - #61

Merged
Hou (SciencePotato) merged 12 commits into
Azure-Samples:mainfrom
SciencePotato:houchichan-microsoft-expand-sendotp-contract
Oct 21, 2026
Merged

Hou (SciencePotato) merged 12 commits into
Azure-Samples:mainfrom
SciencePotato:houchichan-microsoft-expand-sendotp-contract

Conversation

@SciencePotato

@SciencePotato Hou (SciencePotato) commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • expand the SendOtp request, encrypted delivery context, response, status, and credential-diagnostic reference
  • review all 19 tracked documentation pages against the current JavaScript, .NET, Python, setup, and logging behavior
  • align riskContext, otp, tenant metadata, legacy fields, credential failures, and provider response handling across affected guides
  • replace ambiguous provider and regional recovery terminology with explicit secondary-provider and regional-recovery guidance
  • preserve the original architecture images and clarify the current request-time API-key and SDK-owned OAuth credential behavior in the README caption
  • correct the cost guide so it no longer implies all provider credentials are cached
  • explain how authorized evaluation differs from Microsoft Entra migration percentage and provide a staged rollout test matrix

Source handling

The supplied troubleshooting transcript was used only to identify contract-relevant behavior. Customer identifiers, resource URLs, screenshots, private logs, incident timing, and other operational details are not included.

Documentation review

Reviewed all tracked Markdown pages. Updated 12 affected files and left seven already-aligned runtime/setup guides unchanged. The review covered contract accuracy, customer flow and section ordering, navigation, public terminology, provider and regional recovery boundaries, telemetry differences, credentials, privacy, and preserved image captions.

Validation

  • rendered all 19 Markdown pages
  • checked 500 local links, 279 anchors, and 14 image references with no errors
  • reviewed the README and SendOtp contract at desktop and narrow widths; wide tables remain horizontally scrollable
  • visually reviewed both architecture diagrams and preserved every image byte-for-byte
  • confirmed no case-insensitive fallback, failback, or failover remains in tracked Markdown
  • confirmed no executable, infrastructure, settings, catalog, dependency, or image changes
  • git diff --check passed

External URLs were not exhaustively checked; the linked Microsoft migration/evaluation FAQ was reviewed during publication. Documentation-only change; no Azure, tenant, provider, runtime, or deployment behavior changed.

Final accuracy corrections

Clarify provider-selection versus configuration HTTP statuses, list the handler error categories and pre-handler response exceptions, identify runtime-specific diagnostic fields and transport-versus-handler evidence, and state that ttlSeconds validation does not enforce passcode expiry or a delivery deadline. Changes are limited to the contract and matching technical reference; existing reviewer fixes remain intact.

Hou Chi Chan added 4 commits October 20, 2026 12:29
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Comment thread docs/CONTRACT.md
Comment thread docs/CONTRACT.md Outdated
Hou Chi Chan added 4 commits October 20, 2026 13:27
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
@SciencePotato Hou (SciencePotato) changed the title docs: expand SendOtp contract reference docs: align SendOtp contract and customer guidance Oct 20, 2026
Comment thread docs/CONTRACT.md Outdated
Comment thread docs/CONTRACT.md Outdated
Hou Chi Chan added 4 commits October 20, 2026 14:58
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
@SciencePotato
Hou (SciencePotato) merged commit da71e65 into Azure-Samples:main Oct 21, 2026
9 checks passed
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.

2 participants