SDK-2775: Add support for new capture_type property on Static Liveness resources - Python

[mehmet-yoti]

Automated PR created by n8n. Related Jira Issue: SDK-2775

[mehmet-yoti]

@copilot do To implement support for exposing the capture_type property within the StaticLivenessResourceResponse class when the Relying Business fetches the session, we need to follow a structured plan. The implementation plan includes a breakdown of subtasks and steps required:

Step 1: Understand the Current Implementation

• Review the Codebase: Familiarize yourself with the existing StaticLivenessResourceResponse class and how the session data is fetched and exposed to the Relying Business.
• Identify Dependencies: Determine what parts of the system are responsible for fetching and transforming static liveness resource information.

Step 2: Design the Exposure Mechanism for capture_type

• Interface Analysis: Ensure that the interface used by the Relying Business to fetch the session supports the inclusion of new fields.
• Database/Storage Implications: Verify that the capture_type property is being correctly stored and is retrievable, or if any database changes are needed.
• Backward Compatibility: Consider how to maintain backward compatibility if older versions of the interface are being used.

Step 3: Implement the Necessary Changes

• Model Class Update:

  • Update the StaticLivenessResourceResponse class to ensure that it includes the capture_type property.

• Data Access Layer:

  • Update the DAO (Data Access Object) or equivalent layer to ensure the capture_type data is correctly fetched from the database/storage and populated into the StaticLivenessResourceResponse object.

• Service Layer Modification:

  • Modify the service layer method responsible for returning session data to include the capture_type in its response object.

• Controller/Endpoint Update:

  • Update the API endpoint or controller method that provides session data to the Relying Business to include the capture_type in its response payload.

Step 4: Testing

• Unit Testing:

  • Write unit tests for the updated StaticLivenessResourceResponse class to verify that capture_type is correctly set and retrieved.

• Integration Testing:

  • Conduct integration tests to ensure that the end-to-end flow correctly exposes the capture_type property when the session is fetched.
  • Test edge cases, such as when capture_type is null or unexpected values are received.

• Regression Testing:

  • Perform regression testing to ensure that existing functionalities are not affected by the introduction of the capture_type property.

Step 5: Documentation

• API Documentation Update:

  • Update the API documentation to include the new capture_type field in the response objects for relevant endpoints.

• Developer Documentation:

  • Provide documentation for developers on how capture_type should be used, including any constraints or expected values.

Step 6: Deployment and Monitoring

• Deploy Changes:

  • Deploy the changes to a staging environment first and run all tests to ensure everything works as expected.

• Monitor Post-Deployment:

  • Once deployed to production, monitor the application for any inconsistencies related to the capture_type field.

By following these steps, you will ensure that the capture_type property is properly integrated and exposed when the Relying Business fetches the session, maintaining the integrity and performance of the existing system.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud