Skip to content

Commit

Permalink
Update GraphObjectSchema docstrings
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Williams <[email protected]>
  • Loading branch information
ndowmon and aiwilliams authored Feb 10, 2022
1 parent 43496b6 commit e292f84
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion packages/integration-sdk-core/src/types/step.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,14 @@ export interface StepGraphObjectMetadata {
_type: string;

/**
* The schema used to describe the properties assigned to this entity
* An optional extension to the JSON schemas defined by the `_class` of this entity
* in the @jupiterone/data-model.
*
* Extensions defined by this schema are in addition to the schemas referenced by the
* `_class` values of the entity. These should be considered unique properties for
* this integration. Ask yourself, should a property here be considered for promotion
* to the @jupiterone/data-model to benefit normalization of all integrations producing
* this class of entity?
*/
schema?: GraphObjectSchema;

Expand Down

0 comments on commit e292f84

Please sign in to comment.