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

Entities and relationships should have consumable information about the properties on them #698

Open
zemberdotnet opened this issue Apr 25, 2022 · 0 comments
Labels
enhancement New feature or request proposal question Further information is requested

Comments

@zemberdotnet
Copy link
Member

zemberdotnet commented Apr 25, 2022

Description

A common problem when working with the entities and relationships across our many integrations is knowing what properties can be expected. This issue is an extension of #672. The problem with convertProperties is that it hides information from those working on the project.

At the moment, the converters present in our many graph-* projects are better than convertProperties because there is some record of what may appear, but the information is not consumable.

A few ideas about ways we could increase entity and relationship visibility and consumability:

  • converters could be promoted to a first-class concept in the sdk. Almost every, if not all, graph-* projects use converters to transform the data received from the APIs into an Entity or Relationship, but the SDK itself has no concept of a converter.
    • Information from the converter could be exported from the project.
  • The schema object on the StepEntityMetadata type currently exists to make it easier to test that an entity matches a certain schema. However, we could use the information in the schema in the opposite direction as well. If we could generate converters from schemas, I think that would put us one step closer to making integrations easier for anyone to develop.
  • There should be a generated file in each project that exports information about the Entities/Relationships in them and their properties.

Related Issues:
#487, #612

@zemberdotnet zemberdotnet added enhancement New feature or request question Further information is requested proposal labels Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request proposal question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant