Docs: Api reference docs update for Payments - Create #4955

gorakhnathy7 · 2024-06-11T19:46:00Z

Type of Change

Description

This is regarding the API Reference Doc changes using OpenAPI.
This PR just the doc changes for Payments - Create (Including the Payments - Response)

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

Partial resolution of #5014

How did you test it?

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

inventvenkat

Adding the use case of the field will give more clarity to the reader. And please explain the field, instead of just converting to readable. For example: CustomerDetailsResponse should tell what details it is exactly, instead of just saying "Details of customer attached to this payment"

inventvenkat · 2024-06-12T06:26:51Z

api-reference/openapi_spec.json

@@ -5221,6 +5221,7 @@
 },
 "AttemptStatus": {
 "type": "string",
+ "description": "The status of the attempt",


This should also include what each status means

Hey this has the following options in the enums -
Ref - hyperswitch/crates/common_enums/src/enums.rs Ln 39

pub enum AttemptStatus { Started, AuthenticationFailed, RouterDeclined, AuthenticationPending, AuthenticationSuccessful, Authorized, AuthorizationFailed, Charged, Authorizing, CodInitiated, Voided, VoidInitiated, CaptureInitiated, CaptureFailed, VoidFailed, AutoRefunded, PartialCharged, PartialChargedAndChargeable, Unresolved, #[default] Pending, Failure, PaymentMethodAwaited, ConfirmationAwaited, DeviceDataCollectionPending, }

I'll add it here in this enum, the api-reference/openapi_spec.json file is autogenerated one.
Does that works?

Hey @gorakhnathy7, If the descriptions are added to the enum variants these are not included in the generated openapi file. This is something that the library might support or we have to manually add support for this. Currently you can have the description of the enum something like this

/// The status of the payment attempt /// - Pending: The payment is in the processing state /// - Succeeded: The payment has succeeded and the customer has been charged enum AttemptStatus { Pending, Succeeded }

cc: @SanchithHegde

inventvenkat · 2024-06-12T06:27:32Z

api-reference/openapi_spec.json

@@ -7058,6 +7061,7 @@
 },
 "CaptureStatus": {
 "type": "string",
+ "description": "The status of the capture",


This should include what each status means

Similar to AttemptStatus, all status for CaptureMethod can also be described in a more elaborative way in their respective enum definition, that will work?

inventvenkat · 2024-06-12T06:28:27Z

api-reference/openapi_spec.json

@@ -7550,6 +7554,7 @@
 },
 "ConnectorMetadata": {
 "type": "object",
+ "description": "additional data related to some connectors",


Should also include what data. If we cannot define the list, we should mention check with integration team to get the data.

Ref - Link
There are child fields for this with relevant description, We can add a list of all the all the fields beforehand more like a preview before someone will open the child fields. Will that work?

inventvenkat · 2024-06-12T08:21:37Z

api-reference/openapi_spec.json

@@ -8166,6 +8171,7 @@
 },
 "CustomerAcceptance": {
 "type": "object",
+ "description": "Passing this object during payments confirm . The customer_acceptance sub object is usually passed by the SDK or client",


Please mention what to pass here

Accepted, changing the description for this.

Narayanbhat166 · 2024-06-13T07:35:37Z

api-reference/api-reference/openapi_spec.json

This seems to be a duplicate file, can you remove this

Hey removed this, thanks

Narayanbhat166 · 2024-06-14T07:20:09Z

crates/common_enums/src/enums.rs

@@ -307,6 +310,7 @@ pub enum BlocklistDataKind {
 ExtendedCardBin,
 }

+/// Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors


We can have a macro do this for us. If you want to do this manually then can you create this as a list so that the statuses are much more readable

Narayanbhat166 · 2024-06-14T09:05:27Z

api-reference/api-reference/openapi_spec.json

Can you remove this file?

Narayanbhat166 · 2024-06-18T10:06:40Z

List of fields to be removed from the api reference for payments request

merchant_id - remove in all three requests
capture_on
retry_action in PaymentsCreateRequest
feature_metadata
card_cvc in all three requests

Narayanbhat166 · 2024-06-25T14:19:36Z

crates/api_models/src/admin.rs

@@ -845,9 +845,11 @@ pub struct ToggleAllKVResponse {
 #[schema(example = true)]
 pub kv_enabled: bool,
 }
+
+/// Merchant connector details used to make payments.


This field can be removed in all the three requests from the api ref

Narayanbhat166 · 2024-06-25T14:21:42Z

crates/api_models/src/payments.rs

@@ -390,7 +391,7 @@ pub struct PaymentsRequest {
 /// Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.
 pub mandate_data: Option<MandateData>,

- /// Passing this object during payments confirm . The customer_acceptance sub object is usually passed by the SDK or client
+ /// We will be Passing this "CustomerAcceptance" object during Payments-Confirm. The customer_acceptance sub object is usually passed by the SDK or client


this tone can be changed

Narayanbhat166 · 2024-06-25T14:23:46Z

crates/api_models/src/payments.rs

@@ -504,6 +504,7 @@ pub struct PaymentsRequest {
 pub charges: Option<PaymentChargeRequest>,
 }

+/// Fee information to be charged on the payment being collected


cc: @kashif-m is this definition accurate?

Co-authored-by: Sanchith Hegde <[email protected]>

…ror-handling-in-cypress * 'main' of github.com:juspay/hyperswitch: Docs: Api reference docs update for Payments - Create (#4955) feat(cypress): add iatapay connector (#5093) chore: fix ui-test configs (#5152) chore(cards): add configuration option to change the decryption scheme locker (#5140) refactor(hyperswitch_constraint_graph): Removal of lifetime from the Constraint Graph framework (#5132) feat(core): customer_details storage in payment_intent (#5007) fix(connector): [ADYEN] send `browser_info` for all the card and googlepay payments (#5153) fix(users): clear cookie and alter parsing for sso (#5147) refactor(connector): added amount framework to paypal, payouts and routing (#4865) chore(version): 2024.06.28.0 chore(postman): update Postman collection files chore: use generic phone numbers instead (#5142)

Gorakhnath Yadav added 2 commits June 12, 2024 00:19

docs: openapi changes for Payments-Create

2c791f5

Payment-create-api-reference changes

aedffd7

gorakhnathy7 requested review from SanchithHegde and Narayanbhat166 June 11, 2024 19:46

gorakhnathy7 requested a review from a team as a code owner June 11, 2024 19:46

gorakhnathy7 changed the title ~~Api reference docs update for Payments - Create~~ Docs: Api reference docs update for Payments - Create Jun 11, 2024

docs(openapi): re-generate OpenAPI specification

13354fa

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jun 11, 2024

inventvenkat requested changes Jun 12, 2024

View reviewed changes

gorakhnathy7 and others added 4 commits June 12, 2024 19:16

Corrections based on first review

c7aa077

Payments-create and Payments-Response- Final

2458c46

chore: run formatter

e6a72dc

docs(openapi): re-generate OpenAPI specification

e186350

gorakhnathy7 mentioned this pull request Jun 12, 2024

Docs: API-Docs-update for Blocklist and Poll #4983

Open

14 tasks

Narayanbhat166 reviewed Jun 13, 2024

View reviewed changes

gorakhnathy7 and others added 2 commits June 13, 2024 16:50

Final Changes for Payments Module

24fcc3d

docs(openapi): re-generate OpenAPI specification

0a673ad

gorakhnathy7 self-assigned this Jun 13, 2024

Narayanbhat166 reviewed Jun 14, 2024

View reviewed changes

api-reference/api-reference/openapi_spec.json Outdated

Copy link

Member

Narayanbhat166 Jun 14, 2024

Choose a reason for hiding this comment

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

Can you remove this file?

Removing duplicate the Openapi/spec.json file

7562637

inventvenkat previously approved these changes Jun 18, 2024

View reviewed changes

few removals of the outdated fields

c4f9626

gorakhnathy7 dismissed inventvenkat’s stale review via c4f9626 June 24, 2024 12:18

gorakhnathy7 and others added 3 commits June 24, 2024 20:18

Updated schema to get custom response

bfcfabc

Updated schema to get custom response

d6c026a

chore: run formatter

5a5937d

Narayanbhat166 previously approved these changes Jun 25, 2024

View reviewed changes

Narayanbhat166 linked an issue Jun 25, 2024 that may be closed by this pull request

Updating the API reference documentation #5014

Closed

gorakhnathy7 and others added 3 commits June 26, 2024 01:14

Update crates/api_models/src/payments.rs

9f33045

Co-authored-by: Sanchith Hegde <[email protected]>

Update crates/common_enums/src/enums.rs

9d8dec8

Co-authored-by: Sanchith Hegde <[email protected]>

Update crates/api_models/src/payments.rs

1178905

Co-authored-by: Sanchith Hegde <[email protected]>

SanchithHegde previously approved these changes Jun 25, 2024

View reviewed changes

docs(openapi): re-generate OpenAPI specification

245913d

hyperswitch-bot bot dismissed SanchithHegde’s stale review via 245913d June 25, 2024 19:47

SanchithHegde previously approved these changes Jun 25, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Jun 26, 2024

View reviewed changes

gorakhnathy7 and others added 2 commits June 27, 2024 13:02

Merge branch 'main' into Api-reference-docs-update-payment-create

ff2ab6b

docs(openapi): re-generate OpenAPI specification

5da110d

hyperswitch-bot bot dismissed stale reviews from Narayanbhat166 and SanchithHegde via 5da110d June 27, 2024 07:34

Gnanasundari24 enabled auto-merge June 27, 2024 11:31

SanchithHegde disabled auto-merge June 27, 2024 18:06

Merge branch 'main' into Api-reference-docs-update-payment-create

0cfe34c

SanchithHegde previously approved these changes Jun 27, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Jun 28, 2024

View reviewed changes

Resolved conflicts.

151a1f9

gorakhnathy7 dismissed stale reviews from Narayanbhat166 and SanchithHegde via 151a1f9 June 28, 2024 10:22

gorakhnathy7 requested review from SanchithHegde and Narayanbhat166 June 28, 2024 10:36

SanchithHegde approved these changes Jun 28, 2024

View reviewed changes

Narayanbhat166 approved these changes Jun 28, 2024

View reviewed changes

Gnanasundari24 enabled auto-merge June 28, 2024 10:42

Gnanasundari24 added this pull request to the merge queue Jun 28, 2024

Merged via the queue into main with commit f55cae2 Jun 28, 2024
11 checks passed

Gnanasundari24 deleted the Api-reference-docs-update-payment-create branch June 28, 2024 11:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Api reference docs update for Payments - Create #4955

Docs: Api reference docs update for Payments - Create #4955

gorakhnathy7 commented Jun 11, 2024 •

edited

Loading

inventvenkat left a comment

inventvenkat Jun 12, 2024

gorakhnathy7 Jun 12, 2024 •

edited

Loading

Narayanbhat166 Jun 18, 2024

inventvenkat Jun 12, 2024

gorakhnathy7 Jun 12, 2024

inventvenkat Jun 12, 2024

gorakhnathy7 Jun 12, 2024 •

edited

Loading

inventvenkat Jun 12, 2024

gorakhnathy7 Jun 12, 2024

Narayanbhat166 Jun 13, 2024

gorakhnathy7 Jun 14, 2024

Narayanbhat166 Jun 14, 2024

Narayanbhat166 Jun 14, 2024

Narayanbhat166 commented Jun 18, 2024

Narayanbhat166 Jun 25, 2024

Narayanbhat166 Jun 25, 2024

Narayanbhat166 Jun 25, 2024

Docs: Api reference docs update for Payments - Create #4955

Docs: Api reference docs update for Payments - Create #4955

Conversation

gorakhnathy7 commented Jun 11, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

inventvenkat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gorakhnathy7 Jun 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gorakhnathy7 Jun 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Narayanbhat166 commented Jun 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gorakhnathy7 commented Jun 11, 2024 •

edited

Loading

gorakhnathy7 Jun 12, 2024 •

edited

Loading

gorakhnathy7 Jun 12, 2024 •

edited

Loading