rebilly / api-definitions Goto Github PK

A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified. The default value is false.

We tend to use nullable with allOf and not on a typed Schema Object.

nullable: true
allOf:
  - $ref: ./foo.yaml

This is incorrect.

Hi,

I'm looking at your current API documentation, where you are using Redocly. I really like how you organised and customized it. It is very helpful for my own setup.

I wonder how you are able to add and use the "Try It" option?
What configuration option did you use?

Another question is how do you publish the online documentation?
I guess you are using the "redoc-cli" to generate the HMTL page?

Hoping to find some insights from your experience.

Regards,
Tim

• PostPurchase
• PostPreviewOrder

• GetCheckoutFormCollection
• GetCheckoutForm
• PostCheckoutForm
• PutCheckoutForm
• DeleteCheckoutForm
• StorefrontGetCheckoutForm

Response must contain http header Location of the newly created resource; if the status is 201, the Location header must exist.

Update the API docs to remove mentions of the FeeDetails scheme.

The fee object contains the name property for buy-fee, sell-fee transactions riskReserve that contains releaseTime property for risk-reserve transactions. There is no feeDetails scheme, we should remove it from the docs.

We need to add new payment method digital-wallet to have ability store Google Pay and Apple Pay data as a token

https://all-rebilly.redoc.ly/tag/Cashier

Cashier implies both deposits and withdrawals. We need to rename the API endpoints and update the definitions:
For example: PostCashierRequest -> PostDepositRequest

We propose adding an "expand" parameter to the refund method. This improvement, would allow users to specify additional resources to include in the response, reducing the number of requests needed to update information after a transaction refund.

Example Usage
$newTransaction = $coreService->transactions()->refund(id: 1, expand: 'invoices,parentTransaction');

This task is to update the terminology for cashier and cashier strategies to deposit and deposit strategies.

Example:

• hosted cashiers -> hosted deposit forms
• cashier strategies -> deposit strategies

Context

The term cashier may be confusing because the form is used to make deposits and not to withdraw. Also, when generating a hosted cashier URL for a customer, the option in the UI is called Request deposit.

The eventType field for each webhook in the definitions lists every possible eventType when it actually only returns a single relevant event type as a string. This can be fixed quickly and easily.

Details

• Remove Common* Schemas
  • #1437
  • #1438
• Fix discriminator usage
  • #1441 from A1Gateway to Ilixium
  • #1444 From Ingenico to SafeCharge
  • #1446 From SecureTrading to Worldpay
  • #1447 Misc.
• Remove excessive schemas reuse
  • #1476
  • #1499
  • #1503
  • #1508
  • #1511
  • #1522
  • #1523
  • #1525
  • #1530
• Flatten the file structure
  • Move schemas referenced from paths to top level directory.
    • #1448
    • #1450
    • #1453
    • #1454
    • #1455
    • #1458
    • #1461
    • #1462
    • #1470
    • #1471
    • #1473
    • #1507
  • Move sub schemas to second level directory.
    • #1532
    • #1655
    • #1659
    • #1658
• Update rebilly-js-sdk version in FE projects that use TypeScript and make adjustments to types based on schema changes / removals.