IGM: Initial research for creating Specification

[rajaneeshk90]

Description

The Issue and Grievance Management (IGM) system will allow users and service providers to raise, track, and resolve issues within the Beckn-ONIX ecosystem. This will help improve transparency and user satisfaction.

The objective of this ticket is to understand the flow and concept, read the Functional Requirements Document (FRD) get some context before creating the IGM specification.

Goals

• Analyze the flow and concept of the IGM system.
• Go through the FRD.

Mockups / Wireframes

NA

Product Name

Beckn-ONIX

Domain

Open Commerce

Tech Skills Needed

• OpenAPI syntax
• YAML

Complexity

Medium

Category

Documentation

Sub Category

Grievance Handling

Project View

Beckn-ONIX Grievance System

Project Name

Beckn-ONIX

[rajaneeshk90]

Status

Date: 09/10/2024

Went through the documents attached in this ticket to build an understanding: #245
There is a call scheduled with Tanya on 10/10/2024 to discuss it in more detail.

[rajaneeshk90]

Status

Date: 10/10/2024

Call with Tanya and Viraj to understand how ONDC has implemented the IGM in their networks.

1. Tanya provided a brief overview., informed that they have an MVP version of the implementation as of now.
2. They have implemented 2 levels as of now.
3. IGM is part of existing network, it is not a separate network.
4. She shared some PRD documents that we can use to get more understanding.

[rajaneeshk90]

Status

Date: 11/10/2024

1. Started drafting the IGM specification.
2. Adding the specs in the protocol-specification repository
3. The structure of the spec would be same as it is currently for meta and registry APIs.
4. Added the issue/, on_issue/, issue_status/, on_issue_status/ api endpoints.
5. Added the supporting components used in the above APIs.
6. Trying to use some of the components that are already defined in the core protocol specifications.
7. The whole yaml is not compiling as of now, facing reference issues, will figure out on 14th October.