Skip to content
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
27 changes: 27 additions & 0 deletions src/app/postman/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
export const metadata = {
title: 'Postman',
description:
'Postman collection (lua.sh.postman_collection.json) is available in the root of this repository. Import it into Postman and set the BASE_URL and API_TOKEN variables to begin testing the API.',
}

## Postman Collection

A Postman collection is included in the root of this repository:
**`lua.sh.postman_collection.json`**

### Importing the Collection

1. Open Postman.
2. Click **"Import"** and choose the **"File"** tab.
3. Select the file `lua.sh.postman_collection.json` from the repository root.

### Environment Setup

After import, configure the following collection variables:

- `BASE_URL`: The base endpoint of the API (e.g., `https://api.example.com`)
- `API_TOKEN`: Authorization token for accessing protected endpoints

These variables are required to authenticate and interact with the API successfully.

Once configured, the collection is ready for use.
92 changes: 46 additions & 46 deletions src/components/Guides.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,53 @@ import { Button } from '@/components/Button'
import { Heading } from '@/components/Heading'

const guides = [
{
href: '/authentication',
name: 'Authentication',
description: 'Learn how to authenticate your API requests.',
},
{
href: '/pagination',
name: 'Pagination',
description: 'Understand how to work with paginated responses.',
},
{
href: '/errors',
name: 'Errors',
description:
'Read about the different types of errors returned by the API.',
},
{
href: '/rate-limits',
name: 'Rate Limits',
description:
'Understand the rate limits that apply to your API requests.',
},
{
href: '/authentication',
name: 'Authentication',
description: 'Learn how to authenticate your API requests.',
},
{
href: '/pagination',
name: 'Pagination',
description: 'Understand how to work with paginated responses.',
},
{
href: '/errors',
name: 'Errors',
description:
'Read about the different types of errors returned by the API.',
},
{
href: '/rate-limits',
name: 'Rate Limits',
description:
'Understand the rate limits that apply to your API requests.',
},
]

export function Guides() {
return (
<div className="my-16 xl:max-w-none">
<Heading level={2} id="guides">
Guides
</Heading>
<div className="not-prose mt-4 grid grid-cols-1 gap-8 border-t border-zinc-900/5 pt-10 sm:grid-cols-2 xl:grid-cols-4 dark:border-white/5">
{guides.map((guide) => (
<div key={guide.href}>
<h3 className="text-sm font-semibold text-zinc-900 dark:text-white">
{guide.name}
</h3>
<p className="mt-1 text-sm text-zinc-600 dark:text-zinc-400">
{guide.description}
</p>
<p className="mt-4">
<Button href={guide.href} variant="text" arrow="right">
Read more
</Button>
</p>
</div>
))}
</div>
</div>
)
return (
<div className="my-16 xl:max-w-none">
<Heading level={2} id="guides">
Guides
</Heading>
<div className="not-prose mt-4 grid grid-cols-1 gap-8 border-t border-zinc-900/5 pt-10 sm:grid-cols-2 xl:grid-cols-4 dark:border-white/5">
{guides.map((guide) => (
<div key={guide.href}>
<h3 className="text-sm font-semibold text-zinc-900 dark:text-white">
{guide.name}
</h3>
<p className="mt-1 text-sm text-zinc-600 dark:text-zinc-400">
{guide.description}
</p>
<p className="mt-4">
<Button href={guide.href} variant="text" arrow="right">
Read more
</Button>
</p>
</div>
))}
</div>
</div>
)
}
Loading