diff --git a/api_catalog/github/github_shortlisted_api.mdx b/api_catalog/github/github_shortlisted_api.mdx deleted file mode 100644 index 1aa4c84..0000000 --- a/api_catalog/github/github_shortlisted_api.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Ranked list of GitHub APIs -description: to be used in this project, and used in case this needs to be expanded more in future scopes. ---- - -# 🌟 Primary Curated GitHub API Endpoint Set (7 endpoints) - -| # | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Why Pick? | -| - | ------ | ---------------------------- | -------------------------------- | ------ | ---------- | ---------- | -------------------------------------- | -| 1 | GET | /users/{username} | Get public info of a GitHub user | Read | Low | High | Common, simple, widely used | -| 2 | GET | /repos/{owner}/{repo} | Get detailed repository info | Read | Low | High | Core API; essential resource | -| 3 | POST | /user/repos | Create a new repository | Create | Medium | High | Shows write ops and request body usage | -| 4 | GET | /repos/{owner}/{repo}/issues | List issues for a repository | Read | Low | High | Common dev workflow | -| 5 | POST | /repos/{owner}/{repo}/issues | Create an issue | Create | Medium | High | Shows complex request body | -| 6 | GET | /repos/{owner}/{repo}/pulls | List pull requests | Read | Low | High | Widely used, important flow | -| 7 | POST | /repos/{owner}/{repo}/pulls | Create a pull request | Create | Medium | High | Demonstrates complex flow | - ---- - -# 🔄 Secondary / Replacement Candidate Endpoints (Ranked by relevance for replacement) - -| Rank | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Reason to Consider Replacement | -| ---- | ------ | -------------------------------------------- | ------------------------- | ------ | ---------- | ---------- | ----------------------------------------------- | -| 1 | PATCH | /repos/{owner}/{repo}/issues/{issue/_number} | Update an issue | Update | Medium | High | Completes issue lifecycle | -| 2 | PATCH | /repos/{owner}/{repo}/pulls/{pull/_number} | Update a pull request | Update | Medium | High | Completes PR lifecycle | -| 3 | GET | /repos/{owner}/{repo}/branches | List branches | Read | Low | Medium | Common repo operation | -| 4 | GET | /orgs/{org}/members | List organization members | Read | Medium | Medium | Shows org membership and team dynamics | -| 5 | POST | /repos/{owner}/{repo}/comments | Create commit comment | Create | Medium | Medium | Important for code review workflows | -| 6 | GET | /repos/{owner}/{repo}/commits | List commits | Read | Medium | Medium | Useful for audit and history | -| 7 | POST | /repos/{owner}/{repo}/git/refs | Create a Git ref | Create | High | Medium | More advanced Git database operation | -| 8 | DELETE | /repos/{owner}/{repo} | Delete a repository | Delete | Medium | Medium | Important destructive operation (use carefully) | -| 9 | GET | /users/{username}/followers | List followers of a user | Read | Low | Medium | Social aspects of GitHub user | -| 10 | POST | /repos/{owner}/{repo}/releases | Create a release | Create | Medium | Medium | Popular for release management | - ---- diff --git a/api_catalog/jira/jira_shortlisted_api.mdx b/api_catalog/jira/jira_shortlisted_api.mdx deleted file mode 100644 index 1012f63..0000000 --- a/api_catalog/jira/jira_shortlisted_api.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Ranked list of Jira APIs -description: to be used in this project, and used in case this needs to be expanded more in future scopes. ---- - -# 🎯 Primary Curated Jira API Endpoint Set (7 endpoints) - -| # | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Why Pick? | -| - | ------ | -------------------------------------------- | ------------------------------- | ------ | ---------- | ---------- | --------------------------------- | -| 1 | GET | /rest/api/3/issue/{issueIdOrKey} | Retrieve issue details | Read | Low | High | Core issue retrieval | -| 2 | POST | /rest/api/3/issue | Create a new issue | Create | Medium | High | Essential issue creation workflow | -| 3 | PUT | /rest/api/3/issue/{issueIdOrKey} | Update an issue | Update | Medium | High | Modify issue details | -| 4 | POST | /rest/api/3/issue/{issueIdOrKey}/comment | Add comment to an issue | Create | Medium | High | Important for collaboration | -| 5 | POST | /rest/api/3/search | Search issues with JQL query | Read | Medium | High | Powerful query functionality | -| 6 | GET | /rest/api/3/project | List all projects | Read | Low | Medium | Context for issues and workflows | -| 7 | POST | /rest/api/3/issue/{issueIdOrKey}/transitions | Perform issue status transition | Update | Medium | High | Key workflow action | - ---- - -# 🔄 Secondary / Replacement Candidate Endpoints (ranked by relevance) - -| Rank | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Reason to Consider Replacement | -| ---- | ------ | -------------------------------------------- | ----------------------- | ------ | ---------- | ---------- | ------------------------------------- | -| 1 | GET | /rest/api/3/user/search | Search users | Read | Low | High | User-related APIs are often essential | -| 2 | GET | /rest/api/3/issuetype | Get all issue types | Read | Low | Medium | Metadata about issue types | -| 3 | GET | /rest/api/3/component | Get project components | Read | Low | Medium | Project details enrichment | -| 4 | POST | /rest/api/3/version | Create a version | Create | Medium | Medium | Versioning in project management | -| 5 | GET | /rest/api/3/version | List versions | Read | Low | Medium | Version info useful for releases | -| 6 | GET | /rest/api/3/issue/{issueIdOrKey}/attachments | List issue attachments | Read | Medium | Medium | For rich issue context | -| 7 | POST | /rest/api/3/issue/{issueIdOrKey}/attachments | Add attachment to issue | Create | Medium | Medium | Collaboration enhancement | -| 8 | GET | /rest/api/3/workflow | Get workflows | Read | Medium | Medium | Workflow metadata | -| 9 | GET | /rest/api/3/project/{projectIdOrKey}/role | Get project roles | Read | Medium | Medium | Permissions and access management | -| 10 | DELETE | /rest/api/3/issue/{issueIdOrKey} | Delete issue | Delete | Medium | Medium | Important but less frequent action | - ---- diff --git a/api_catalog/notion/notion_shortlisted_api.mdx b/api_catalog/notion/notion_shortlisted_api.mdx deleted file mode 100644 index 682e18e..0000000 --- a/api_catalog/notion/notion_shortlisted_api.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Ranked list of Notion APIs -description: to be used in this project, and used in case this needs to be expanded more in future scopes. ---- - -# 🎯 Primary Curated Notion API Endpoint Set (7 endpoints) - -| # | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Why Pick? | -| - | ------ | ------------------------------- | ------------------------------------------------ | ------ | ---------- | ---------- | ------------------------------------------- | -| 1 | POST | /v1/databases/query | Query database with filters, sorting, pagination | Read | Medium | High | Core data retrieval for apps | -| 2 | GET | /v1/databases/{database/_id} | Retrieve database metadata | Read | Low | High | Metadata needed for schema and UI | -| 3 | POST | /v1/pages | Create a page inside database/workspace | Create | Medium | High | Content creation is key | -| 4 | GET | /v1/pages/{page/_id} | Retrieve a page and its properties | Read | Low | High | Basic retrieval API | -| 5 | GET | /v1/blocks/{block/_id} | Retrieve block content | Read | Low | High | Building blocks is fundamental | -| 6 | PATCH | /v1/blocks/{block/_id}/children | Append children blocks to a block | Create | Medium | High | Common for dynamic content | -| 7 | POST | /v1/search | Search pages, databases, and workspaces | Read | Medium | High | Important for full-text and filtered search | - ---- - -# 🔄 Secondary / Replacement Candidate Endpoints (ranked) - -| Rank | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Reason to Consider Replacement | -| ---- | ------ | ------------------------------- | --------------------------------------------- | ------ | ---------- | ---------- | ----------------------------------------- | -| 1 | GET | /v1/users/me | Retrieve current authorized user info | Read | Low | High | Personalization and authorization context | -| 2 | GET | /v1/users | List users | Read | Low | Medium | User management | -| 3 | PATCH | /v1/pages/{page/_id} | Update page properties | Update | Medium | Medium | Content editing | -| 4 | GET | /v1/blocks/{block/_id}/children | Retrieve children blocks | Read | Medium | Medium | Navigation of content structure | -| 5 | PATCH | /v1/blocks/{block/_id} | Update block content | Update | Medium | Medium | Modify content blocks | -| 6 | DELETE | /v1/blocks/{block/_id} | Delete a block | Delete | Medium | Medium | Content removal | -| 7 | POST | /v1/blocks/{block/_id}/children | Append children blocks (alternative to PATCH) | Create | Medium | Medium | More granular content building | -| 8 | GET | /v1/search | Search with filters (advanced) | Read | Medium | Medium | Alternative search approaches | -| 9 | GET | /v1/databases | List all databases accessible | Read | Low | Medium | Metadata discovery | -| 10 | POST | /v1/databases | Create a new database | Create | High | Medium | Advanced content structure creation | - ---- diff --git a/api_catalog/slack/slack_shortlisted_api.mdx b/api_catalog/slack/slack_shortlisted_api.mdx deleted file mode 100644 index dd81dd8..0000000 --- a/api_catalog/slack/slack_shortlisted_api.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Ranked list of Slack APIs -description: to be used in this project, and used in case this needs to be expanded more in future scopes. ---- - -# 🎯 Primary Curated Slack API Endpoint Set (7 endpoints) - -| # | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Why Pick? | -| - | ------ | --------------------- | ----------------------------------- | ------ | ---------- | ---------- | --------------------------------- | -| 1 | POST | chat.postMessage | Send a message to a channel or user | Create | Medium | High | Core messaging functionality | -| 2 | POST | conversations.list | List all channels/conversations | Read | Medium | High | Essential for listing channels | -| 3 | POST | conversations.history | Retrieve messages from a channel | Read | Medium | High | Common for message retrieval | -| 4 | GET | users.list | List all users in workspace | Read | Low | High | Basic user info retrieval | -| 5 | GET | users.info | Get information about a user | Read | Low | High | User profile details | -| 6 | POST | files.upload | Upload a file to Slack | Create | Medium | Medium | File sharing use case | -| 7 | POST | reactions.add | Add a reaction emoji to a message | Create | Low | Medium | Common social interaction feature | - ---- - -# 🔄 Secondary / Replacement Candidate Endpoints (ranked) - -| Rank | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Reason to Consider Replacement | -| ---- | ------ | --------------------- | -------------------------------------- | ------ | ---------- | ---------- | -------------------------------- | -| 1 | POST | chat.update | Update a message | Update | Medium | Medium | Common message editing operation | -| 2 | POST | chat.delete | Delete a message | Delete | Medium | Medium | Message deletion | -| 3 | POST | conversations.join | Join a conversation | Update | Medium | Medium | Channel membership | -| 4 | POST | conversations.leave | Leave a conversation | Update | Medium | Medium | Channel membership | -| 5 | POST | files.list | List files | Read | Medium | Medium | File management | -| 6 | POST | reactions.remove | Remove a reaction from a message | Delete | Low | Medium | Undo reaction | -| 7 | GET | team.info | Get info about the workspace/team | Read | Low | Medium | Workspace metadata | -| 8 | POST | usergroups.list | List user groups | Read | Medium | Medium | User segmentation | -| 9 | POST | usergroups.users.list | List users in a user group | Read | Medium | Medium | Group membership | -| 10 | POST | auth.test | Test authentication and token validity | Read | Low | High | Authentication verification | - ---- diff --git a/api_catalog/stripe/stripe-shortlisted_api.mdx b/api_catalog/stripe/stripe-shortlisted_api.mdx deleted file mode 100644 index efa83d4..0000000 --- a/api_catalog/stripe/stripe-shortlisted_api.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Ranked list of Stripe APIs -description: to be used in this project, and used in case this needs to be expanded more in future scopes. ---- - -# 🎯 Primary Curated Stripe API Endpoints (7 endpoints) - -| # | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Why Pick? | -| - | ------ | ------------------------- | ------------------------- | ------ | ---------- | ---------- | --------------------------- | -| 1 | POST | /v1/customers | Create a customer | Create | Medium | High | Core for any billing system | -| 2 | GET | /v1/customers/{id} | Retrieve customer details | Read | Low | High | Common read operation | -| 3 | POST | /v1/payment/_intents | Create a payment intent | Create | High | High | Payment lifecycle core | -| 4 | GET | /v1/payment/_intents/{id} | Retrieve payment intent | Read | Medium | High | Payment status checks | -| 5 | POST | /v1/subscriptions | Create a subscription | Create | High | High | Recurring billing showcase | -| 6 | POST | /v1/invoices | Create an invoice | Create | Medium | High | Billing and invoicing | -| 7 | POST | /v1/refunds | Create a refund | Create | Medium | Medium | Important refund flow | - ---- - -# 🔄 Secondary / Replacement Candidate Endpoints (ranked) - -| Rank | Method | Endpoint | Brief Description | Type | Difficulty | Importance | Reason to Consider Replacement | -| ---- | ------ | ----------------------------- | ------------------------------- | ------ | ---------- | ---------- | -------------------------------------------- | -| 1 | POST | /v1/payment/_methods | Create a payment method | Create | Medium | Medium | Useful for diverse payment setups | -| 2 | GET | /v1/subscriptions/{id} | Retrieve subscription details | Read | Medium | High | Completes subscription lifecycle | -| 3 | POST | /v1/subscriptions/{id}/cancel | Cancel a subscription | Update | Medium | High | Common subscription management action | -| 4 | POST | /v1/invoices/{id}/pay | Pay an invoice | Update | Medium | High | Important invoice lifecycle step | -| 5 | GET | /v1/products | List products | Read | Low | Medium | For product catalog management | -| 6 | POST | /v1/prices | Create price | Create | Medium | Medium | For pricing management | -| 7 | GET | /v1/payment/_methods/{id} | Retrieve payment method details | Read | Low | Medium | Often needed for payment method verification | -| 8 | POST | /v1/setup/_intents | Create a setup intent | Create | High | Medium | For saved payment methods | -| 9 | GET | /v1/balance | Retrieve current balance | Read | Low | Low | Useful for account financial overview | -| 10 | GET | /v1/charges | List charges | Read | Medium | Medium | Legacy payment flow support | - ----