new endpoint /workflows/response

[humansinstitute]

Context

• Problem: We need to handle responses from Stakwork efficiently and take the next action on the response data.
• Why it's needed: This endpoint is crucial for maintaining the integrity and accuracy of our workflow tracking system by ensuring that all responses are logged and processed correctly.
• Larger System Fit: This endpoint is part of the Stakwork Common Workflow Plumbing feature, which aims to streamline and automate workflow processes.
• Background: The /workflows/response endpoint will update the wf_requests table with response data, ensuring that the status of each request is accurately tracked.

This is related to a broader project defined here:
For context see: #1922

System Schematic:

Design

The logical flow to process a response is:

1. "/workflow/response"
2. On receipt of response object.
3. Use requestUUID to load response data into DB wf_requests
4. Create action object (union of requestObject and responseObject)
   POST to /workflow/action

{
    "source": "string",
    "requestUUID": "string",
    "action": "string"
    "workflowID": interger,
    "formData": { object },
    "responseData": { object }
}

• Endpoint: /workflows/response

• HTTP Method: POST

• Request Body: JSON object containing response data from Stakwork.

  • Example:

    {
      "request_id": "12345",
      "status": "completed",
      "response_data": {
        "key1": "value1",
        "key2": "value2"
      }
    }

• Database Interaction: Update the wf_requests table with the response data based on request_id.

• Database Interaction: Use the wf_processing_map to check for next processing action based on action.

Task Breakdown

• Dependancy for handler: Implement Workflow Database Layer #1937
• Add Workflow Response Route #1941
• Implement Response Handler #1942
• Create Response Processing Utils #1943

Assignment Criteria

• Required Knowledge/Skills:
  • Proficiency in the primary programming language and framework used in the project.
  • Understanding of RESTful API design and database operations.
• Communication Channels:
  • Ensure you are live on Sphinx V2 for team communication.

Acceptance Criteria

• The /workflows/response endpoint accepts POST requests with valid JSON response data.
• The endpoint updates the wf_requests table with the correct response data based on request_id.
• The endpoint returns a 200 HTTP status code and a success message upon successful update.
• The endpoint returns an appropriate error message and status code for invalid requests or update failures.
• The implementation includes unit tests covering both successful and failure scenarios.
• The endpoint is documented in the API documentation.

[MuhammadUmer44]

@humansinstitute I can help?

[sophieturner0]

@humansinstitute Please assign me?

[MahtabBukhari]

@humansinstitute assign me?

[humansinstitute]

This would be blocked until this ticket is merged to allow access to the wf_requests table: #1925

[aliraza556]

@humansinstitute, Please assign me?