From 44d3c73c3f264e9ea409c0369f92226d344ca36e Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Thu, 5 Dec 2024 21:15:30 +0200 Subject: [PATCH 1/3] typos api.mdx --- docs/api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.mdx b/docs/api.mdx index 1c692bd..f4fe64f 100644 --- a/docs/api.mdx +++ b/docs/api.mdx @@ -16,7 +16,7 @@ If you have any questions, comments, or suggestions, please reach out in the #gi ## Version 1 **Note that the public API limits individual IPs to a -maximum of 100 requests within a 5 minute window.** +maximum of 100 requests within a 5-minute window.** ### `GET /v1/poap/:poapTokenId/is-gitpoap` From 62dd50207182dd4ee09e3463e7dea12aba5db35e Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Thu, 5 Dec 2024 21:17:27 +0200 Subject: [PATCH 2/3] typos api.mdx --- docs/api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.mdx b/docs/api.mdx index f4fe64f..2d4a676 100644 --- a/docs/api.mdx +++ b/docs/api.mdx @@ -183,7 +183,7 @@ This endpoint allows users to query for a list of all addresses that hold any Gi ### `GET /v1/address/:address/gitpoaps` -This endpoint allows users to query for some address's (either an ETH or ENS address) GitPOAPs. This returns data like: +This endpoint allows users to query for some addresses (either an ETH or ENS address) GitPOAPs. This returns data like: ```json [ From 859013119b731fdc2aaaf4a5f11c29f3569389da Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Thu, 5 Dec 2024 21:18:22 +0200 Subject: [PATCH 3/3] typos api.mdx --- docs/api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.mdx b/docs/api.mdx index 2d4a676..e9416fa 100644 --- a/docs/api.mdx +++ b/docs/api.mdx @@ -234,7 +234,7 @@ the following: `claimed`, `unclaimed`, `pending`, `minting`, and can be omitted ### `GET /v1/repo/:owner/:name/badge` -This endpoint generates a GitHub badge containing the count of minted GitPOAPs for a specified repo. The repo is specified with a GitHub owner and repo name & the endpoint will return a SVG for use in any `.md` file such as a `README.md`. +This endpoint generates a GitHub badge containing the count of minted GitPOAPs for a specified repo. The repo is specified with a GitHub owner and repo name & the endpoint will return an SVG for use in any `.md` file such as a `README.md`. Using `ethereum/ethereum-org-website` as an example via [https://public-api.gitpoap.io/v1/repo/ethereum/ethereum-org-website/badge](https://public-api.gitpoap.io/v1/repo/ethereum/ethereum-org-website/badge), embed the badge in a `.md` file the following way: