square / square/connect-api-specification

Generic `Reason` not defined. should be more specific

Open
#164 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
76
Forks
36
Avg merge
3h 14m
Merged PRs (30d)
1

Description

Type Reason doesn't exist but is referenced several times. For example:

property reason on method GiftCardActivityAdjustDecrement should be GiftCardActivityAdjustDecrementReason not Reason.

property reason on method GiftCardActivityAdjustIncrement should be GiftCardActivityAdjustIncrementReason not Reason

same is true for GiftCardActivityBlock, GiftCardActivityClearBalance, GiftCardActivityDeactivate, and GiftCardActivityUnblock

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the OpenAPI specification entries for GiftCardActivityAdjustDecrement, GiftCardActivityAdjustIncrement, GiftCardActivityBlock, GiftCardActivityClearBalance, GiftCardActivityDeactivate, and GiftCardActivityUnblock. Check each reason property and replace the generic Reason reference with the corresponding operation-specific reason type; done means none of these operations references an undefined generic Reason type.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.