Skip to content

chore(components): rename PostmanRunButton #1141

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

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions components/PostmanRunButton/readme.md

This file was deleted.

2 changes: 1 addition & 1 deletion components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ export { default as Tabs, Tab } from './Tabs';
export { default as TailwindRoot } from './TailwindRoot';
export { default as TailwindStyle } from './TailwindStyle';
export { default as Recipe } from './Recipe';
export { default as PostmanRunButton } from './PostmanRunButton';
export { default as Postman } from './integrations/PostmanRunButton';
28 changes: 28 additions & 0 deletions components/integrations/PostmanRunButton/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Postman Run Button

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

```mdx
<Postman
collectionId="123456-abcd-efgh-ijkl"
collectionUrl="entityId=123456-abcd-efgh-ijkl&entityType=collection&workspaceId=abcdef-1234-5678"
/>
```

### 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
```