search

beckn / protocol-server

protocol-server
3 stars 1 forks source link

Migrate Core Protocol Spec to OpenAPI 3.1 #139

Closed viraj89 closed 1 month ago

viraj89 commented 1 month ago

Description

Migrate the Core Protocol Specification to OpenAPI Specification 3.1 format while adding necessary validations. This will enhance the clarity, consistency, and maintainability of the specification document.

Goals

Expected Outcome

Successfully migrate the Core Protocol Specification to OpenAPI Specification 3.1 with added example, ensuring improved clarity and accuracy.

Acceptance Criteria

Product Name

Beckn

Domain

Protocol Specification

Tech Skills Needed

Complexity

Medium

Category

Specification Management

Sub Category

Migration and Validation

emmayank commented 1 month ago

3rd May, 2024, Time Spent : 8 hrs

  1. Read about Open API Specification 3.1
emmayank commented 1 month ago

6th May, 2024, Time Spent : 8 hrs

  1. changed the openapi version to 3.1.0
  2. No Breaking changes observed
  3. Started Adding Validations

Blocker/ Issue: New Swagger Editor for OAS3.1 is not working properly as expected, debugging if it is issue in the YAML or the UI Tool.

emmayank commented 1 month ago

8th May, 2024 , Time Spent : 8 hrs

  1. Tried different Editors and Plugins to see if the issue still persists.
  2. Later resolved the issue, by adding example in the reference schema

Image

emmayank commented 1 month ago

9th May, 2024, Time Spent: 10 hrs

  1. Added Example Directory in the Core Specification and
  2. Added Examples for search, on_search, select, on_select, confirm
emmayank commented 1 month ago

10th May, 2024, Time Spent: 10 hrs

  1. Added Examples for on_confirm, cancel, on_cancel, update, on_update, status, on_status
  2. Working on the Analyzing how to add new directory for validations and read about adding validations in OAS3.1

Code Pushed here - https://github.com/emmayank/protocol-specifications/tree/open-api-3.1

Not yet ready for creating PR with beckn protocol repository