Skip to content

docs: correct connector schema registration to loader-entry pattern #32775

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.

Sign up for GitHub

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
detail-app wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −9
Open

docs: correct connector schema registration to loader-entry pattern #32775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions ingestion/src/metadata/ingestion/source/database/my_db/CONNECTOR_CONTEXT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,9 @@ Modify these existing files:
{"$ref": "connections/database/myDbConnection.json"}
```

### 3b. UI service utils: `openmetadata-ui/src/main/resources/ui/src/utils/DatabaseServiceUtils.tsx`
### 3b. UI service utils: `openmetadata-ui/src/main/resources/ui/src/utils/DatabaseServicePureUtils.ts`

- Import the resolved connection schema for `MyDb`
- Add a `case 'MyDb':` in the switch statement that returns the schema
- Add a `MyDb` entry to `databaseSchemaLoaders` that calls `loadConnectionSchema('connections/database/myDbConnection.json')`

### 3c. Localization

Expand Down
4 changes: 2 additions & 2 deletions skills/connector-building/GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The scaffold prints a checklist. These files need manual edits:
- Add your connector name to the `type` enum array
- Add a `$ref` to your connection schema in the `connection` oneOf

2. **UI service utils** — Import the schema and add a switch case:
2. **UI service utils** — Add a schema loader entry:
```
openmetadata-ui/.../utils/{ServiceType}ServiceUtils.tsx
```
Expand Down Expand Up @@ -432,7 +432,7 @@ auth and `../../../../` to reach shared types. Non-database schemas use

1. Check you added the type to `{serviceType}Service.json`
2. Check you ran `yarn parse-schema`
3. Check you added the switch case in `{ServiceType}ServiceUtils.tsx`
3. Check you added the schema loader entry in `{ServiceType}ServiceUtils.tsx`

### Test connection fails

Expand Down
2 changes: 1 addition & 1 deletion skills/connector-building/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Read `${CLAUDE_SKILL_DIR}/standards/registration.md` for detailed instructions.
| 1 | `openmetadata-spec/.../entity/services/{serviceType}Service.json` | Add to type enum + connection oneOf |
| 2 | `ingestion/setup.py` | Add connector pip extras block |
| 3 | `ingestion/src/metadata/examples/workflows/{name}.yaml` | Runnable CLI workflow example (`metadata ingest -c`) |
| 4 | `openmetadata-ui/.../utils/{ServiceType}ServiceUtils.tsx` | Import schema + add switch case |
| 4 | `openmetadata-ui/.../utils/{ServiceType}ServiceUtils.tsx` | Add schema loader entry |
| 5 | `openmetadata-ui/.../assets/img/service-icon-{name}.png` | Add service logo asset |
| 6 | `openmetadata-ui/.../utils/ServiceIconUtils.ts` | Import asset + register in `SERVICE_ICON_LOADERS` |
| 7 | `openmetadata-ui/.../public/locales/en-US/{ServiceType}/{Name}.md` | Field-level docs rendered in the Add Service form |
Expand Down
2 changes: 1 addition & 1 deletion skills/connector-review/templates/full-review-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Mark each check as PASS or FAIL. **If a blocker or warning was found for an area
| Test connection JSON steps match test_fn keys | | |
| Test connection steps are distinct (no duplicate functions) | | |
| Registered in service schema enum and oneOf | | |
| UI utils updated with schema import and switch case | | |
| UI utils updated with schema loader entry | | |
| i18n keys added | | |

{{SCHEMA_DETAILS}}
Expand Down
2 changes: 1 addition & 1 deletion skills/connector-review/templates/specialized-review-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This review focused on **{{FOCUS_AREA}}** only. Other aspects of the connector w
- [ ] Capability flags match implementation
- [ ] Test connection JSON steps match test_fn keys
- [ ] Registered in service schema enum and oneOf
- [ ] UI utils updated with schema import and switch case
- [ ] UI utils updated with schema loader entry
- [ ] i18n keys added
{{/IF}}

Expand Down
2 changes: 1 addition & 1 deletion skills/standards/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To register a new connector, modify these files:

1. **Service enum**: `openmetadata-spec/.../entity/services/{serviceType}Service.json` — add type to enum + connection `oneOf`
2. **Test connection**: `openmetadata-service/.../testConnections/{serviceType}/{name}.json` — create file
3. **UI utils**: `openmetadata-ui/.../utils/{ServiceType}ServiceUtils.tsx` — import schema + add switch case
3. **UI utils**: `openmetadata-ui/.../utils/{ServiceType}ServiceUtils.tsx` — add schema loader entry
4. **Localization**: `openmetadata-ui/.../locale/languages/` — add i18n display name keys

## Code Generation Commands
Expand Down
Loading