Skip to content

Commit fbe22a7

Browse files
committed
styling
1 parent 6b3ec25 commit fbe22a7

File tree

3 files changed

+24
-27
lines changed

3 files changed

+24
-27
lines changed

docs/build-your-software-catalog/custom-integration/ocean-custom-integration/_category_.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
{
22
"position": 1,
3-
"label": "Ocean Custom Integration",
3+
"label": "Ocean custom integration",
44
"collapsible": true,
5-
"collapsed": true,
6-
"link": {
7-
"type": "generated-index"
8-
}
5+
"collapsed": true
96
}
107

118

docs/build-your-software-catalog/custom-integration/ocean-custom-integration/build-your-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
sidebar_position: 2
3-
title: Build Your Integration
3+
title: Build your integration
44
description: Interactive guide to configure and install your integration
55
---
66

77
import PortApiRegionTip from "/docs/generalTemplates/_port_api_available_regions.md"
88
import { IntegrationBuilderProvider, Step1ApiConfig, Step2DataMapping, Step3Installation } from '@site/src/components/OceanCustom';
99

10-
# Build Your Integration
10+
# Build your integration
1111

1212
This interactive guide will help you generate everything you need to connect your API to Port.
1313

@@ -20,7 +20,7 @@ This interactive guide will help you generate everything you need to connect you
2020

2121
---
2222

23-
## Step 1: Configure Your API
23+
## Step 1: Configure your API
2424

2525
Set up the connection details for your API. These settings apply globally to all endpoints you'll sync from this API.
2626

@@ -36,7 +36,7 @@ Think of this as setting up the "connection" - these settings will be used for e
3636

3737
---
3838

39-
## Step 2: Choose What Data to Sync
39+
## Step 2: Choose what data to sync
4040

4141
Now that your API connection is configured, let's define what data to sync. This step helps you map a specific API endpoint to a Port blueprint.
4242

@@ -53,7 +53,7 @@ The builder will automatically detect field types (string, number, boolean, emai
5353

5454
---
5555

56-
## Step 3: Install and Create in Port
56+
## Step 3: Install and create in Port
5757

5858
You're all set! Based on your configuration, we've generated everything you need:
5959

docs/build-your-software-catalog/custom-integration/ocean-custom-integration/overview.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This integration allows Port customers to connect to any custom API, internal sy
1010

1111
---
1212

13-
## When to Use This Integration?
13+
## When to use this integration?
1414

1515
This integration is ideal when:
1616

@@ -83,11 +83,11 @@ You'll use a [JQ](https://jqlang.org/manual/) `data_path` expression in your map
8383

8484
---
8585

86-
## How It Works
86+
## How it works
8787

8888
The Ocean Custom integration uses a [**two-step setup**](/build-your-software-catalog/sync-data-to-catalog/) similar to other Ocean integrations you've used:
8989

90-
### Step 1: Installation (Global Configuration)
90+
### Step 1: Installation (Global configuration)
9191

9292
During installation, you configure the **connection settings** that apply to all API calls:
9393

@@ -120,21 +120,21 @@ helm install ocean-custom port-labs/port-ocean \
120120
--set integration.config.pageSize=100
121121
```
122122

123-
### Step 2: Resource Mapping
123+
### Step 2: Resource mapping
124124

125125
After installation, you define **which endpoints to sync** in your `port-app-config.yml` file (or using the integration's configuration in Port).
126126

127127
This is where you map each API endpoint to Port entities - similar to how you've mapped GitHub repositories or Jira issues in other integrations.
128128

129-
#### 🆕 Endpoint-as-Kind Feature
129+
#### 🆕 Endpoint-as-kind feature
130130

131131
The `kind` field is now the **endpoint path itself**! This provides better visibility in Port's UI, allowing you to:
132132

133133
- ✅ Track each endpoint's sync status individually
134134
- ✅ Debug mapping issues per endpoint
135135
- ✅ Monitor data ingestion per API call
136136

137-
#### Example: Mapping Two Endpoints
137+
#### Example: Mapping two endpoints
138138

139139
```yaml
140140
resources:
@@ -178,7 +178,7 @@ resources:
178178
created: .created_date
179179
```
180180
181-
#### What Each Field Does
181+
#### What each field does
182182
183183
- **`kind`**: The API endpoint path (combined with your base URL)
184184
- **`selector.query`**: JQ filter to include/exclude entities (use `'true'` to sync all)
@@ -189,7 +189,7 @@ resources:
189189

190190
---
191191

192-
## Advanced Configurations
192+
## Advanced configurations
193193

194194
Once you have the basics working, these features handle more complex scenarios.
195195

@@ -199,7 +199,7 @@ Fetch data from dynamic endpoints that depend on other resources.
199199

200200
**Use case:** Get all tickets, then fetch comments for each ticket.
201201

202-
#### How It Works
202+
#### How it works
203203

204204
**Step 1 - Define parent endpoint:**
205205
```yaml
@@ -245,7 +245,7 @@ The integration will:
245245

246246
For APIs that split data across multiple pages, configure how the integration fetches all pages.
247247

248-
#### Pagination Types
248+
#### Pagination types
249249

250250
**Offset-based** (like SQL):
251251
```
@@ -265,7 +265,7 @@ GET /api/users?cursor=abc123&limit=100
265265
GET /api/users?cursor=xyz789&limit=100
266266
```
267267
268-
#### Custom Parameter Names
268+
#### Custom parameter names
269269
270270
APIs often use different parameter names. You can configure:
271271
@@ -287,7 +287,7 @@ paginationParam: starting_after
287287
sizeParam: limit
288288
```
289289

290-
#### Cursor Path Configuration
290+
#### Cursor path configuration
291291

292292
For cursor-based pagination, tell the integration where to find the next cursor in responses:
293293

@@ -308,11 +308,11 @@ cursorPath: meta.after_cursor
308308
hasMorePath: meta.has_more
309309
```
310310
311-
### Rate Limiting
311+
### Rate limiting
312312
313313
Control how the integration interacts with your API to prevent overwhelming it or hitting rate limits.
314314
315-
#### Request Timeout
315+
#### Request timeout
316316
317317
How long to wait for each API call to complete.
318318
@@ -326,13 +326,13 @@ timeout: 30 # seconds (default: 30)
326326
327327
---
328328
329-
## Ready to Build?
329+
## Ready to build?
330330
331-
Head to [Build Your Integration](./build-your-integration) for a step-by-step guide with an interactive configuration builder.
331+
Head to [Build your integration](./build-your-integration) for a step-by-step guide with an interactive configuration builder.
332332
333333
---
334334
335-
## More Resources
335+
## More resources
336336
337337
For all configuration options, code examples, and advanced use cases, check out the [Ocean Custom integration repository on GitHub](https://github.com/port-labs/ocean/tree/main/integrations/custom).
338338

0 commit comments

Comments
 (0)