Skip to content

Commit 6b3ec25

Browse files
committed
docs: Rename Generic HTTP to Ocean Custom Integration
- Rename directory: ocean-http/ → ocean-custom-integration/ - Rename React components: GenericHttp/ → OceanCustom/ - Update category label to 'Ocean Custom Integration' - Update all text references from 'Generic HTTP' to 'Ocean Custom' - Update integration type: generic-http → custom - Update integration identifier: generic-http → ocean-custom - Update Docker image: port-ocean-generic-http → port-ocean-custom - Update GitHub repo links: /integrations/generic-http → /integrations/custom - Use :latest tag for Docker, remove version from Helm (auto-handled by chart)
1 parent a312042 commit 6b3ec25

18 files changed

+20
-22
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"position": 1,
3-
"label": "Generic HTTP (New ⭐)",
3+
"label": "Ocean Custom Integration",
44
"collapsible": true,
55
"collapsed": true,
66
"link": {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Interactive guide to configure and install your integration
55
---
66

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

1010
# Build Your Integration
1111

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 1
33
title: Overview
4-
description: Understanding the Generic HTTP Integration
4+
description: Understanding the Ocean Custom Integration
55
---
66

77
# Overview
@@ -85,7 +85,7 @@ You'll use a [JQ](https://jqlang.org/manual/) `data_path` expression in your map
8585

8686
## How It Works
8787

88-
The Generic HTTP integration uses a [**two-step setup**](/build-your-software-catalog/sync-data-to-catalog/) similar to other Ocean integrations you've used:
88+
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

9090
### Step 1: Installation (Global Configuration)
9191

@@ -104,14 +104,14 @@ Think of this as setting up the "connection" to your API - these settings are us
104104

105105
```bash
106106
helm repo add --force-update port-labs https://port-labs.github.io/helm-charts
107-
helm install generic-http port-labs/port-ocean \
107+
helm install ocean-custom port-labs/port-ocean \
108108
--set port.clientId="<PORT_CLIENT_ID>" \
109109
--set port.clientSecret="<PORT_CLIENT_SECRET>" \
110110
--set port.baseUrl="https://api.getport.io" \
111111
--set initializePortResources=true \
112112
--set scheduledResyncInterval=60 \
113-
--set integration.identifier="generic-http" \
114-
--set integration.type="generic-http" \
113+
--set integration.identifier="ocean-custom" \
114+
--set integration.type="custom" \
115115
--set integration.eventListener.type="POLLING" \
116116
--set integration.config.baseUrl="https://api.yourcompany.com" \
117117
--set integration.config.authType="bearer_token" \
@@ -334,5 +334,5 @@ Head to [Build Your Integration](./build-your-integration) for a step-by-step gu
334334
335335
## More Resources
336336
337-
For all configuration options, code examples, and advanced use cases, check out the [Generic HTTP integration repository on GitHub](https://github.com/port-labs/ocean/tree/main/integrations/generic-http).
337+
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

src/components/GenericHttp/IntegrationBuilder.jsx renamed to src/components/OceanCustom/IntegrationBuilder.jsx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ export function IntegrationBuilder() {
5151
` -e OCEAN__PORT__CLIENT_SECRET="<PORT_CLIENT_SECRET>"`,
5252
` -e OCEAN__PORT__BASE_URL="https://api.getport.io"`,
5353
` -e OCEAN__EVENT_LISTENER__TYPE="ONCE"`,
54-
` -e OCEAN__INTEGRATION__IDENTIFIER="generic-http"`,
55-
` -e OCEAN__INTEGRATION__TYPE="generic-http"`,
54+
` -e OCEAN__INTEGRATION__IDENTIFIER="ocean-custom"`,
55+
` -e OCEAN__INTEGRATION__TYPE="custom"`,
5656
` -e OCEAN__INTEGRATION__CONFIG__BASE_URL="${baseUrl || 'https://api.example.com'}"`,
5757
];
5858

@@ -79,7 +79,7 @@ export function IntegrationBuilder() {
7979

8080
return `docker run -d --name ocean-http-integration \\
8181
${envVars.join(' \\\n')} \\
82-
ghcr.io/port-labs/port-ocean-generic-http:0.1.5-dev`;
82+
ghcr.io/port-labs/port-ocean-custom:latest`;
8383
};
8484

8585
const generateHelmValues = () => {
@@ -118,9 +118,8 @@ ${envVars.join(' \\\n')} \\
118118
return `initializePortResources: true
119119
scheduledResyncInterval: 60
120120
integration:
121-
identifier: generic-http
122-
type: generic-http
123-
version: 0.1.5-dev
121+
identifier: ocean-custom
122+
type: custom
124123
eventListener:
125124
type: POLLING
126125
config:
@@ -583,7 +582,7 @@ ${Object.entries(resource.port.entity.mappings.properties).map(([k, v]) => `
583582
<p style={{ marginTop: '1rem' }}>Then install:</p>
584583
<CodeBlock language="bash" showLineNumbers>
585584
{`helm repo add --force-update port-labs https://port-labs.github.io/helm-charts
586-
helm install generic-http port-labs/port-ocean -f values.yaml`}
585+
helm install ocean-custom port-labs/port-ocean -f values.yaml`}
587586
</CodeBlock>
588587
</TabItem>
589588
</Tabs>

0 commit comments

Comments
 (0)