Mobility Layer2 config: check out the issues with validation with openAPI version 3.1

rajaneeshk90 commented 1 week ago

Ticket Contents

Description

We have a sample layer2 config for the mobility domain. Layer2. This layer2 config uses the opneAPI version 3.1.

Beckn Protocol server uses the "express-openapi-validator" module internally for request validations.

To test out the above layer2 config with Beckn protocol server, Tanya upgraded her local instances of the protocol server to a new version of express-openapi-validator library which supports openAPI 3.1.

This version was used for the validations.

While doing the testing, we faced some issues, as part of this ticket, we need to investigate those issues and find solutions.

Key Points: Protocol server uses node module "express-openapi-validator" for the validations. While developing the l2 config, We used node module "openapi-backend" module for the validations.

There might be some differences between how these libraries do the validations.

Goals

[ ] Tanya to share the list of the exact issues.
[x] Investigate the issues faced with the validations.
[x] Create a postman collection with the positive and negative test cases.
[x] Validate the positive and negative test cases in the postman collection with a test server.

Expected Outcome

No response

Acceptance Criteria

No response

Implementation Details

NA

Mockups/Wireframes

No response

Product Name

protocol server

Domain

No response

Tech Skills Needed

Express.js, JavaScript, Other

Complexity

High

Category

Research

rajaneeshk90 commented 1 week ago

From what was discussed on the call, we tested the below items:

Reference errors: I checked the validity of the mobility layer2 config in the https://editor-next.swagger.io/ and https://json-schema.hyperjump.io/ tools, and both of these are considering it a valid openAPI doc. Also I have been using a lightweight node server to validate the rules in the layer2, that server also is considering the doc as valid.
allOf inside if block is not working: I tried a search request in POSTMAN and the backend is able to successfully enforce the rules added in the layer2.
Action enum should not be in the layer2: This is a trivial change, this can be easily removed.
Search not using the rules from the shared directory: Search has a different message structure than other APIs so as per the things we have explored till now it cant use the shared rules.

There could be additional issues that I might have missed. But from my testing I found these things to be working. The mismatch could be due to the different library being used.

Sent a mail to Tanya to get the details of the issues so that the team can dig deeper into it.

rajaneeshk90 commented 4 days ago

Extended the postman collected which is used to test the layer2 configuration on the test server (not the protocol server instance)

This was used while developing the layer2 as the existing protocol server did not have support for openAPI 3.1 at the time.

This could be used for testing when we implement the openAPI 3.1 in protocol serevr.

Took considerable time to add the cases and test.

OAS3.1-validator-Mobility-Test-Server.postman_collection.json

rajaneeshk90 commented 4 days ago

cc @emmayank

rajaneeshk90 commented 3 days ago

All the test cases tested on the l2 config with the test server are listed in this file:

https://docs.google.com/spreadsheets/d/1tEp8TxpSfuOLXimGH3gXIFWIxvffZoWW1fsaoEMuY9E/edit?gid=0#gid=0

rajaneeshk90 commented 3 days ago

cc @faizmagic

rajaneeshk90 commented 22 hours ago

Tanya have not shared the list or the details of the exact issues yet, we investigated the L2 based on the verbal feedback she had given on a call.

rajaneeshk90 commented 11 minutes ago

Had a call with Tanya on 16th of September.

I Demonstrated my postman collection and showed that the contains and allof combination is working for validation.

Unfortunately, we could not continue the call, as she had to drop off. Nevertheless I was able to show that contains and allof combination works fine.

shared with her my postman collection, she can use the postman to try it out offline.

shared with her the ajv version that the openapi-backend library is using.

beckn / protocol-server