From 5bab9af28a1b29b757ce7cb9e80b8c241a589afe Mon Sep 17 00:00:00 2001 From: Rafe Goldberg Date: Thu, 26 Jun 2025 11:43:34 -0400 Subject: [PATCH 1/2] chore(components): rename PostmanRunButton --- components/PostmanRunButton/readme.md | 26 ----------------- components/index.ts | 2 +- .../PostmanRunButton/index.tsx | 0 .../integrations/PostmanRunButton/readme.md | 28 +++++++++++++++++++ 4 files changed, 29 insertions(+), 27 deletions(-) delete mode 100644 components/PostmanRunButton/readme.md rename components/{ => integrations}/PostmanRunButton/index.tsx (100%) create mode 100644 components/integrations/PostmanRunButton/readme.md diff --git a/components/PostmanRunButton/readme.md b/components/PostmanRunButton/readme.md deleted file mode 100644 index 04c46b9aa..000000000 --- a/components/PostmanRunButton/readme.md +++ /dev/null @@ -1,26 +0,0 @@ -# Postman Run Button - -Add a Postman Run Button to your documentation, allowing users to fork a Postman collection. This is duped from [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. - -### Usage - -```mdx - -``` - -### How to Find Your Collection ID and URL - -1. Open your collection in Postman -2. Click "Share" button at the top right of your collection -3. Go to the "Via API" tab -4. You'll find your Collection ID in the URL or in the API response -5. The Collection URL contains parameters after the main URL (starting with "entityId=") - -### Props - -- `collectionId` (required): The ID of your Postman collection (e.g., "123456-abcd-efgh-ijkl") -- `collectionUrl` (required): The URL parameters for your collection, typically in this format: - `entityId=YOUR_COLLECTION_ID&entityType=collection&workspaceId=YOUR_WORKSPACE_ID` diff --git a/components/index.ts b/components/index.ts index eb8dbe57a..137b457c7 100644 --- a/components/index.ts +++ b/components/index.ts @@ -17,4 +17,4 @@ export { default as Tabs, Tab } from './Tabs'; export { default as TailwindRoot } from './TailwindRoot'; export { default as TailwindStyle } from './TailwindStyle'; export { default as TutorialTile } from './TutorialTile'; -export { default as PostmanRunButton } from './PostmanRunButton'; +export { default as Postman } from './integrations/PostmanRunButton'; diff --git a/components/PostmanRunButton/index.tsx b/components/integrations/PostmanRunButton/index.tsx similarity index 100% rename from components/PostmanRunButton/index.tsx rename to components/integrations/PostmanRunButton/index.tsx diff --git a/components/integrations/PostmanRunButton/readme.md b/components/integrations/PostmanRunButton/readme.md new file mode 100644 index 000000000..81b9b3b63 --- /dev/null +++ b/components/integrations/PostmanRunButton/readme.md @@ -0,0 +1,28 @@ +# Postman Run Button + +Add a Postman run button to your documentation, allowing users to fork a Postman collection. This component is a dupe of [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. + +### Usage + +```mdx + +``` + +### How to Find Your Collection ID and URL + +1. Open your collection in Postman +2. Click "Share" button at the top right of your collection +3. Go to the "Via API" tab +4. You'll find your Collection ID in the URL or in the API response +5. The Collection URL contains parameters after the main URL (starting with `entityId=`) + +### Props + +- **`collectionId`**: (required) the ID of your Postman collection (e.g. `"123456-abcd-efgh-ijkl"`) +- **`collectionUrl`**: (required) the URL parameters for your collection, typically in this format: + ``` + entityId=YOUR_COLLECTION_ID&entityType=collection&workspaceId=YOUR_WORKSPACE_ID + ``` From cff0c83f12d0ec928f54b048578e4d1f59d5734a Mon Sep 17 00:00:00 2001 From: Rafe Goldberg Date: Thu, 26 Jun 2025 13:14:19 -0400 Subject: [PATCH 2/2] docs(components): update PostmanRunButton docs Co-authored-by: Jon Ursenbach --- components/integrations/PostmanRunButton/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/integrations/PostmanRunButton/readme.md b/components/integrations/PostmanRunButton/readme.md index 81b9b3b63..2898df1bf 100644 --- a/components/integrations/PostmanRunButton/readme.md +++ b/components/integrations/PostmanRunButton/readme.md @@ -1,6 +1,6 @@ # Postman Run Button -Add a Postman run button to your documentation, allowing users to fork a Postman collection. This component is a dupe of [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. +Add a "Run in Postman" button to your documentation, allowing users to fork a Postman collection. This component is a dupe of [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. ### Usage