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

docs(api): add business partner annotations to the Orchestrator api #1101

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nicoprow
Copy link
Contributor

@nicoprow nicoprow commented Oct 31, 2024

Description

This pull request introduces a suggestion on how to add annotations to business partner data in the golden record process.

  • Each task has in addition to the business partner data also an annotations object.
  • The annotations object mirrors in big parts the data structure of the business partner data but contains a list of annotations for each property.
  • Upon creating a task or resolving a task the service can specify a new annotation for each annotatable data point.
  • Business partner data reserved by a cleaning service or queried by the Gates are returned with the full list of annotations so far for each data point.

Proposal for #1102

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@nicoprow nicoprow requested a review from AmirMattarx October 31, 2024 09:27
@nicoprow nicoprow added this to the BPDM v6.3.0 / R25.03. milestone Nov 14, 2024
@nicoprow nicoprow added documentation Improvements or additions to documentation standards-relevant The issue has an impact on the Catena-X standards labels Nov 22, 2024
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 standards-relevant The issue has an impact on the Catena-X standards
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant