Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validating UEI Specification and examples against the Beckn Core specification v 1.1.0 #18

Merged
merged 11 commits into from
Sep 25, 2024

Conversation

rajaneeshk90
Copy link
Collaborator

@rajaneeshk90 rajaneeshk90 commented Feb 12, 2024

Issue:

There are some components of the UEI specification which are not as per the Beckn core specification version 1.1.0
One such issue is highlighted below.

As per the UEI specification, "city" field should be enclosed inside context.location object.
Definition of the context in UEI specification can be found here: https://github.com/beckn/Unified-Energy-Interface/blob/main/api/dent.yaml#L2735
All the JSON examples in the UEI repository directly utilize the "city" field within the context.
More details of the issue can be found on the GitHub issue page of UEI repository: #17

As part of this task, we checked the UEI spec and example JSONs for any non-compliance with Beckn core spec version 1.1.0 and fixed the identified issues.

Change Made

  • Removed the "city" field from the context object of all the example JSONs in the examples/ev-charging folder
  • Added a "city" field in the context.location object of all the example JSONs in the examples/ev-charging folder
  • removed order.items.fulfillments from on_init, on_confirm. on_status, on_update. Fulfilment info was already embedded in the order.fulfillments field.
  • Adding add_ons info in the order.items in example JSONs.
  • fixing order.items.quantity in the example JSONs.
  • Changing support.order_id to support.ref_id in support API JSON
  • Adding transaction_id in the payments.params

Related ticket: beckn/beckn-ui-workspace#485

@rajaneeshk90 rajaneeshk90 changed the title Hotfixes: incorrect usage of "context.city" in example JSONs Hotfix: incorrect usage of "context.city" in example JSONs Feb 15, 2024
@rajaneeshk90 rajaneeshk90 changed the title Hotfix: incorrect usage of "context.city" in example JSONs Hotfix: incorrect use of "context.city" in example JSONs Feb 15, 2024
@emmayank
Copy link

Hey @rajaneeshk90 , Please find my comments on the pull request below :

  1. Search.intent has a location object which is not available in the core-v1.1 specification.
  2. /track and /on_track API is not available, which is part of the core-v1.1 specification.
  3. The examples that are defined in the YAML File (uei.yaml) are not as per the core-v1.1 specification.

I was hoping you could find the complete difference in the given comparison link (click here). Please make the required change and update the pull request.

Thanks
@emmayank

@rajaneeshk90 rajaneeshk90 changed the title Hotfix: incorrect use of "context.city" in example JSONs Make the UEI specification and examples follow the core spec version 1.1.0 Apr 5, 2024
@rajaneeshk90
Copy link
Collaborator Author

Hi @emmayank

I have fixed the highlighted issues. Can you please review this PR.

There are more changes made to fix any non compliance in the UEI spec with the Beckn core specifications version 1.1.0.

Please let me know if any clarification is needed.

Thanks,
Rajaneesh

@rajaneeshk90 rajaneeshk90 changed the title Make the UEI specification and examples follow the core spec version 1.1.0 Validating UEI Specification against the Beckn Core specification v 1.1.0, validating examples against the updated UEI specification Apr 15, 2024
@rajaneeshk90 rajaneeshk90 linked an issue May 7, 2024 that may be closed by this pull request
6 tasks
@rajaneeshk90 rajaneeshk90 changed the title Validating UEI Specification against the Beckn Core specification v 1.1.0, validating examples against the updated UEI specification Validating UEI Specification and examples against the Beckn Core specification v 1.1.0 Sep 11, 2024
@ravi-prakash-v ravi-prakash-v merged commit 5610c41 into beckn:main Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Validating UEI Specification with Core v 1.1.0
3 participants