Skip to content

Commit

Permalink
Small docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jzolo22 committed Jul 3, 2024
1 parent e8393b4 commit 60b0948
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions packages/integration-sdk-core/docs/createIntegrationHelpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ import { typeboxClassSchemaMap } from '@jupiterone/data-model';

export const { createEntityType, createEntityMetadata } =
createIntegrationHelpers({
integrationName: INTEGRATION_NAME, // Should be lowercase
schemaMap: typeboxClassSchemaMap,
integrationName: INTEGRATION_NAME, // Should be lowercase (i.e. aws)
classSchemaMap: typeboxClassSchemaMap,
});
```

Expand Down Expand Up @@ -130,7 +130,12 @@ export function createUserEntity(name: string): Entity {
for consumption outside the integraion, the package `platform-sdk-cli` must
be >= version `12.8.1` in the integration's deployment package.json.

### Notes:
### Notes/Gotchas:

1. To set up nullable fields, you can use
`SchemaType.Union([SchemaType.String(), SchemaType.Null()])`

2. If a property's type you have added to the new schema is not being respected,
check to see if it already exists on the \_class. If it does, you will need
to make sure the type complies with the \_class schema. You will not be able
to override it on a \_type level.

0 comments on commit 60b0948

Please sign in to comment.