Fix incomplete Portal intent documentation and add validation#310
Merged
nicknisi merged 1 commit intoworkos:mainfrom Nov 26, 2025
Merged
Fix incomplete Portal intent documentation and add validation#310nicknisi merged 1 commit intoworkos:mainfrom
nicknisi merged 1 commit intoworkos:mainfrom
Conversation
Update PHPDoc to include missing intent values (certificate_renewal, domain_verification) and add runtime validation for $intent parameter to provide better error messages before API calls. Includes test coverage for all intent values and invalid intent handling. Fixes workos#295
Contributor
Greptile OverviewGreptile SummaryUpdated PHPDoc and added runtime validation for Portal intent parameter to address issue #295. Changes:
The implementation follows existing validation patterns used elsewhere in the codebase (e.g., Confidence Score: 5/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
participant Client as Client Code
participant Portal as Portal.generateLink()
participant Validation as Intent Validation
participant API as WorkOS API
Client->>Portal: generateLink(org, intent, returnUrl, successUrl)
Portal->>Validation: Check intent in validIntents array
alt Invalid Intent
Validation-->>Client: throw UnexpectedValueException
else Valid Intent
Validation->>Portal: Continue
Portal->>API: POST /portal/generate_link
API-->>Portal: Return portal link
Portal-->>Client: Return PortalLink resource
end
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update PHPDoc to include missing intent values (certificate_renewal, domain_verification) and add runtime validation for $intent parameter to provide better error messages before API calls. Includes test coverage for all intent values and invalid intent handling.
Fixes #295
Description
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.