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.

Sign up for GitHub

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

Jump to bottom

CON-5700 add api documentation for credit card disablement #735

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

CON-5700 add api documentation for credit card disablement #735

wants to merge 15 commits into from
+39 −0

Conversation

ShadiWa
Copy link
Contributor

@ShadiWa ShadiWa commented Feb 7, 2025

Summary

Checklist

  • Documentation follows the Style Guide
  • JSON examples updated
  • Properties in JSON examples are in the same order as in property tables
  • Changelog dated the day when PR merged
  • Changelog accurately describes all changes
  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations
  • All hyperlinks tested
  • Deprecation Table updated if any deprecations
  • SUMMARY.md updated if new pages added

@ShadiWa ShadiWa closed this Feb 7, 2025
@ShadiWa ShadiWa reopened this Feb 7, 2025
@ShadiWa ShadiWa self-assigned this Feb 7, 2025
@ShadiWa ShadiWa added Documentation Generator Pull requests related to reference documentation generator labels Feb 7, 2025
@ShadiWa ShadiWa requested review from jnv and MikeAdamsMews February 7, 2025 11:46
@ShadiWa ShadiWa marked this pull request as ready for review February 7, 2025 12:52
@ShadiWa ShadiWa requested review from a team as code owners February 7, 2025 12:52
MikeAdamsMews
MikeAdamsMews requested changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@MikeAdamsMews MikeAdamsMews left a comment

Choose a reason for hiding this comment

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

Sorry to say, but it looks like the new operation is in the wrong place! The URL is [PlatformAddress]/api/connector/v1/creditCards/disable so it should be in creditcards.md alongside Get all credit cards and Charge credit card, not in payments.md.

Secondly, I would prefer if the name was consistent wherever it is used, so always Disable gateway credit card or always Disable credit card. At the moment, it mixes both names.

operations/payments.md Outdated Show resolved Hide resolved
operations/payments.md Outdated Show resolved Hide resolved
operations/README.md Outdated Show resolved Hide resolved
@ShadiWa ShadiWa requested a review from MikeAdamsMews February 7, 2025 15:50
MikeAdamsMews
MikeAdamsMews approved these changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@MikeAdamsMews MikeAdamsMews left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes.

operations/creditcards.md Outdated Show resolved Hide resolved
@jnv jnv changed the title Con 5700 add api documentation for credit card disablement CON-5700 add api documentation for credit card disablement Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MikeAdamsMews MikeAdamsMews MikeAdamsMews approved these changes

@jnv jnv Awaiting requested review from jnv

Assignees

@ShadiWa ShadiWa

Labels
Documentation Generator Pull requests related to reference documentation generator
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ShadiWa @jnv @MikeAdamsMews