Skip to content

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

@zemberdotnet

Description

@zemberdotnet

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestproposalquestionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions