Skip to content
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

MINOR: doc: service spec breaking changes #18688

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Conversation

sushi30
Copy link
Contributor

@sushi30 sushi30 commented Nov 19, 2024

Describe your changes:

Added information about the breaking changes with the ServiceSpec connector entrypoint.

Type of change:

  • Bug fix
  • Improvement
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

@github-actions github-actions bot added Ingestion safe to test Add this label to run secure Github workflows on PRs labels Nov 19, 2024
@sushi30 sushi30 enabled auto-merge (squash) November 19, 2024 10:18
@sushi30 sushi30 added documentation Improvements or additions to documentation and removed Ingestion labels Nov 21, 2024
Introducing the ["connector specifcication class (`ServiceSpec`)"](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/utils/service_spec/service_spec.py).
The `ServiceSpec` class serves as the entrypoint for the connector and holds the references for the classes that will be used
to ingest and process the metadata from the source.
You can see [postgres](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/source/database/postgres/service_spec.py) for an
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sushi30 sushi30 merged commit 430791d into main Nov 25, 2024
20 checks passed
@sushi30 sushi30 deleted the doc-spec-breaking-change branch November 25, 2024 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation safe to test Add this label to run secure Github workflows on PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants