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

docs: update readme for nft related endpoints #901

Merged
merged 6 commits into from
Sep 14, 2022
Merged

Conversation

jyeshe
Copy link
Member

@jyeshe jyeshe commented Sep 12, 2022

Refs #629
Depends on #899

@jyeshe jyeshe changed the base branch from master to nft-collection-stats September 12, 2022 23:42
@jyeshe jyeshe self-assigned this Sep 12, 2022
README.md Outdated
@@ -3147,6 +3147,299 @@ $ curl -s "https://mainnet.aeternity.io/mdw/v2/transfers?account=ak_7myFYvagcqh8

---

## NFTs (AEX-141 contracts and tokens)
Copy link
Collaborator

Choose a reason for hiding this comment

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

will you also add a reference in the directory?

Copy link
Member Author

Choose a reason for hiding this comment

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

@thepiwo So far the NFT images are not downloaded or are you imagining other directory use?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I mean in the headlines of the readme to add a reference to this section

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

README.md Outdated
Returns creation and stats information in default paginated way for all NFT collection. The same general paginated parameters might be used:

- `direction` with `forward` value ascendinly sorts the response contracts by creation transaction index while `backward` works for desc sorting
- `limit` defines the page size
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps we can just say that these are paginated endpoint to avoid repeating that there's limit and direction which applies for all paginated endpoints?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Base automatically changed from nft-collection-stats to master September 13, 2022 15:10
@jyeshe jyeshe merged commit 5f66f15 into master Sep 14, 2022
@jyeshe jyeshe deleted the nft-readme-docs branch September 14, 2022 00:53
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.

3 participants