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

Enhancements for Carrier Billing v0.2 - Part I #119

Merged
merged 10 commits into from
Nov 15, 2023
Merged

Conversation

PedroDiez
Copy link
Collaborator

@PedroDiez PedroDiez commented Nov 1, 2023

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature
  • documentation

What this PR does / why we need it:

This PR deals with some Issues whose output is already agreed:

  • Issue#97 [COVERED]
  • Issue#105 [COVERED: Impacts in amount and taxAmount]
  • Issue#106 [COVERED: Inspired in /documentation/API_documentation/Carrier_Billing_API.md and aligned with current model approach for QoD and Home Devices QoD APIs. Providing details about state transitions -in the current context, without considerations of Issue#116]
  • Issue#107 [COVERED]
  • Issue#108 [COVERED]
  • Issue#112 [COVERED]

Which issue(s) this PR fixes:

Fixes #97, #105, #106, #107, #108, #112

Special notes for reviewers:

COMPLETED. Ready for review

@PedroDiez PedroDiez added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 1, 2023
@PedroDiez PedroDiez self-assigned this Nov 1, 2023
@bigludo7
Copy link
Collaborator

bigludo7 commented Nov 1, 2023

Thanks @PedroDiez
I saw the fixes for 107 & 108 - Looks good for me. Do you want me to approve or wait for the other issue inside this PR to be solved?
Thanks

@PedroDiez
Copy link
Collaborator Author

Hi @bigludo7, Many thanks for the review!. I wanted to add these ones in advance as were easy to manage.
I prefer waiting for final review until i include the rest of points.

@PedroDiez
Copy link
Collaborator Author

Ready for review: @bigludo7, @rartych, @alabajnaid

Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current API Design Guidelines states that X-Correlator header is not Required in OAS Definition.
Some clarifications are currently proposed in camaraproject/Commonalities#88

BTW, X-Correlator or x-correlator or more popular header: X-Correlation-ID ?

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good. A small fix for the application/cloudevents+json that we have in the notification. I will take a second look on the state engine later today.

requestBody:
description: Creates a new carrier billing payment notification
content:
application/json:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be: application/cloudevents+json:

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

@bigludo7 bigludo7 Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and here also: camaraproject/Commonalities#86
We have discussed this point in Commonalities call 2 weeks ago and the team was agreed to align with Cloud Events application

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for clarification!

code/API_definitions/carrier_billing.yaml Outdated Show resolved Hide resolved
@PedroDiez
Copy link
Collaborator Author

Current API Design Guidelines states that X-Correlator header is not Required in OAS Definition. Some clarifications are currently proposed in camaraproject/Commonalities#88

BTW, X-Correlator or x-correlator or more popular header: X-Correlation-ID ?

Hi Rafał,

Regarding the fact of not indicating the header in the yaml is not a good approach, because there is no contingency to inform consumers that they can use the header. Consumers do NOT have to know the CAMARA API Design guidelines. Then, for the time being I prefer to keep the "x-correlator" header (HTTP headers are case insensitive). I have already commented in commonalities for alignment

@PedroDiez PedroDiez requested review from bigludo7 and rartych November 8, 2023 19:32
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look fine for me . Thanks !

Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@PedroDiez PedroDiez merged commit 4052df5 into main Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improvements for Carrier Billing
3 participants