Skip to content

Clean Up Documentation for Issue 28#35

Open
cpiggott wants to merge 7 commits intoDwolla:mainfrom
cpiggott:issue_28
Open

Clean Up Documentation for Issue 28#35
cpiggott wants to merge 7 commits intoDwolla:mainfrom
cpiggott:issue_28

Conversation

@cpiggott
Copy link
Copy Markdown
Contributor

All models are name-spaced to DwollaSwagger\models meaning all the PHPDocs are incorrect that use @return <MODEL>.

This updates the documentation to show the correct return type.

@randaleWatson
Copy link
Copy Markdown

If the conflicts with master can be fixed this would be a good PR as I am having to write doc comments a bunch to get type hint to work and some of the return types are wrong current like TransApi->create() I think returns a url string but current doc says it returns a unit.
Way off is FundingApi->createCustomerFundingSource() it's return type us a whole FundingSource but I think it returns only url for said funding source.
almost all the create methods need to be updated to accept an array | CreateXXXModel so type should be remove from parameters and just hinted in the phpDocs.

@ShreyaThapa ShreyaThapa linked an issue Feb 27, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Namespace issue with models vs. API call mathod PHPDoc

2 participants