Add flow management API definition #793
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive OpenAPI 3.0.3 specifications for flow management and execution APIs that enable app native authentication capabilities. The changes add two new YAML files defining REST APIs for creating, managing, and executing authentication and registration flows.
Key changes:
- Added Flow Execution API definition (
api/flow-execution.yaml) for executing app native authentication flows with support for initial and subsequent flow requests - Added Flow Management API definition (
api/WIP/flow-management.yaml) for CRUD operations on flow definitions with comprehensive schema definitions for VIEW, EXECUTION, and specialized step types - Defined detailed component and action schemas supporting a visual flow composer with UI components, executors, and navigation logic
Reviewed Changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| api/flow-execution.yaml | Defines the POST endpoint for executing flow steps with request/response schemas for incomplete, complete, and error flow states, including input validation and authentication assertions |
| api/WIP/flow-management.yaml | Defines full CRUD endpoints for flow management with detailed schemas for step types, UI components, actions, executors, pagination, and comprehensive validation rules for authentication and registration flows |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #793 +/- ##
==========================================
- Coverage 82.83% 82.81% -0.02%
==========================================
Files 298 298
Lines 23314 23313 -1
Branches 563 562 -1
==========================================
- Hits 19311 19307 -4
- Misses 2843 2845 +2
- Partials 1160 1161 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
429624b to
60aada3
Compare
60aada3 to
6eacd6f
Compare
| data: | ||
| $ref: '#/components/schemas/StepData' |
There was a problem hiding this comment.
The data field in the Step schema is not marked as required. However, all examples in the document (lines 399-404, 413-534, etc.) include the data field. If steps always require data configuration, this should be marked as required, or the documentation should clarify when it's optional.
| name: Basic Registration Flow | ||
| flowType: REGISTRATION | ||
| isEnabled: true | ||
| steps: ®istrationFlowSteps |
There was a problem hiding this comment.
YAML anchor ®istrationFlowSteps is defined here but creates a tight coupling between the request example and the response example (line 642). If either example needs to be modified independently in the future, this could cause issues. Consider duplicating the steps definition in both places for better maintainability.
| steps: ®istrationFlowSteps | |
| steps: |
| size: | ||
| $ref: '#/components/schemas/Size' | ||
| position: | ||
| $ref: '#/components/schemas/Position' |
There was a problem hiding this comment.
The size and position fields in the Step schema are not marked as required, but based on the examples throughout the document (lines 393-398, 407-412, etc.), these fields are always provided. Consider marking them as required if they are essential for the flow composer UI, or clarify in the description when they are optional.
Purpose
This pull request introduces the flow management API swagger definition.
Approach
Related Issues
Related PRs
Checklist
Security checks