Skip to content

Commit 5192aaa

Browse files
authored
Merge pull request #14 from Abk700007/update-readme
Added Missing api-docs-urls.csv
2 parents a92966b + 87d7c05 commit 5192aaa

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
1010
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#contributing)
1111
[![Build Status](https://img.shields.io/badge/status-under_construction-orange.svg)](#status)
12-
[![Open Issues](https://img.shields.io/github/issues/yourusername/updapi)](https://github.com/yourusername/updapi/issues)
12+
[![Open Issues](https://img.shields.io/github/issues/in-c0/updapi)](https://github.com/in-c0/updapi/issues)
1313

1414
---
1515
> Like the project? Please give it a Star so it can reach more people >>>>> [![Star on GitHub](https://img.shields.io/badge/⭐-Star_on_GitHub-blue?style=flat)](https://github.com/UpdAPI/updAPI/stargazers)
@@ -22,14 +22,14 @@
2222

2323
`api-docs-urls.csv` contains a **centralized collection of popular APIs** with **links to their official documentation and associated policies**. It includes tools to scrape, preprocess, and update the dataset for better usability and retrieval.
2424

25-
api-docs-url.csv:
25+
api-docs-urls.csv:
2626

2727
| API Name | Official Documentation URL | Privacy Policy URL | Terms of Service URL | Rate Limiting Policy URL | Changelog/Release Notes URL | Security Policy URL | Developer Community/Forum URL |
2828
|-----------------------|-----------------------------------------------------|------------------------------------|-------------------------------|----------------------------------------|------------------------------------------|-----------------------------------|------------------------------------------|
2929
| OpenAI API | [Documentation](https://platform.openai.com/docs) | [Privacy](https://openai.com/privacy) | [Terms](https://openai.com/terms) | [Rate Limits](https://platform.openai.com/docs/guides/rate-limits) | [Changelog](https://platform.openai.com/docs/release-notes) | [Security](https://openai.com/security) | [Community](https://community.openai.com/) |
3030
...
3131

32-
> ⚠️ **the URLs are auto-generated and require manual verification**
32+
> ⚠️ **The URLs are auto-generated and require manual verification**
3333
> We aim to maintain these URLs to be pointing to the **current** document (TODO: Set up cron jobs/GitHub Actions to periodically re-run the scrapers and keep the dataset up-to-date)
3434
3535

@@ -194,7 +194,7 @@ Contributions are welcome! Here's how you can contribute:
194194
195195
2. **Verify API Entries**:
196196
- Is the URL up-to-date?
197-
- Is the URL root-level for the relevant page? (api.com/docs/, not api.com/docs/nested)
197+
- Is the URL root-level for the relevant page? (`api.com/docs/`, not `api.com/docs/nested`)
198198
- Is the API doc public and does it comply with "robots.txt"?
199199
- Does the URL provide all the expected information (changelogs, rate limits, etc) ?
200200
- Is there any dynamically loaded page content that the scraper is able to extract?
@@ -238,7 +238,7 @@ This repository is licensed under the [MIT License](LICENSE).
238238
- Limited API support.
239239
- Some features may not work as expected.
240240

241-
Check the [Open Issues](https://github.com/yourusername/updapi/issues) for more details.
241+
Check the [Open Issues](https://github.com/in-c0/updapi/issues) for more details.
242242

243243
---
244244

@@ -258,8 +258,8 @@ Check the [Open Issues](https://github.com/yourusername/updapi/issues) for more
258258

259259
## Community
260260

261-
- [Discussions](https://github.com/yourusername/updapi/discussions)
262-
- [Bug Reports](https://github.com/yourusername/updapi/issues)
261+
- [Discussions](https://github.com/in-c0/updapi/discussions)
262+
- [Bug Reports](https://github.com/in-c0/updapi/issues)
263263

264264
---
265265

0 commit comments

Comments
 (0)