@unito/integration-api 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,7 +27,6 @@
27
27
  "$id": "Semantic",
28
28
  "type": ["string", "null"],
29
29
  "enum": [
30
- "canonicalPath",
31
30
  "createdAt",
32
31
  "description",
33
32
  "displayName",
@@ -16,6 +16,11 @@
16
16
  "minLength": 1,
17
17
  "maxLength": 100
18
18
  },
19
+ "aggregatePath": {
20
+ "type": "string",
21
+ "format": "uri-reference",
22
+ "pattern": "^\/.*$"
23
+ },
19
24
  "semantic": {
20
25
  "$ref": "https://unito.io/integration_api/definitions.schema.json#/$defs/relationSemantic"
21
26
  },
@@ -321,7 +321,7 @@ export interface Relation {
321
321
  schema: RelationSchema;
322
322
  }
323
323
  /**
324
- * A summary of a relation.
324
+ * A RelationSummary describes the common properties of a relation expected to be found on each item of a relation.
325
325
  */
326
326
  export type RelationSummary = {
327
327
  /**
@@ -332,6 +332,11 @@ export type RelationSummary = {
332
332
  * The publicly visible label of the relation.
333
333
  */
334
334
  label: string;
335
+ /**
336
+ * When provided, provides a way to retrieve all the items described by this relation summary.
337
+ * This needs to be used in conjunction with a field having a PARENT semantic.
338
+ */
339
+ aggregatePath?: string;
335
340
  /**
336
341
  * The semantic of the relation.
337
342
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unito/integration-api",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "The Unito Integration API",
5
5
  "type": "module",
6
6
  "types": "./dist/src/index.d.ts",