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.

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

Updated readme #254

Merged
merged 43 commits into from
Oct 7, 2021
Merged

Updated readme #254

merged 43 commits into from
Oct 7, 2021

Conversation

HancilSequeira
Copy link
Contributor

No description provided.

@chirag-patel-rp
Copy link

@HancilSequeira let's also add what the function returns, store it in some variable and lay down the attributes of that variable

Example:
$card = $api->card->fetch($cardId);

Now also add how this $card return variable looks like, you can have this object defined somewhere and then reference to not repeatedly define $card object

@HancilSequeira
Copy link
Contributor Author

@chirag-patel-rp do I need to add response for all the API or is it ok if I had only one response for any API

@chirag-patel-rp
Copy link

@HancilSequeira yes for all API responses, you can create a common object and then link that in the document to avoid repetitiveness.

For example, create a document of entity.md and there list all entity objects (like: order, payment, transfer) and then start referring those in the API response

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
documents/addon.md Show resolved Hide resolved
documents/addon.md Outdated Show resolved Hide resolved
documents/plan.md Outdated Show resolved Hide resolved
Copy link

@chirag-patel-rp chirag-patel-rp left a comment

Choose a reason for hiding this comment

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

Looks good now

@HancilSequeira HancilSequeira merged commit d8438e2 into master Oct 7, 2021
@sonyy-m sonyy-m deleted the readmeUpdate branch April 26, 2022 11:22
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.

5 participants