@twin.org/auditable-item-graph-models 0.0.3-next.12 → 0.0.3-next.14

package/docs/reference/interfaces/IAuditableItemGraphVersionGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionGetResponse
+
+Response to getting an auditable item graph vertex at a specific version.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphVersionListRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphVersionListRequest
+
+Get all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### after?
+
+> `optional` **after?**: `string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+#### before?
+
+> `optional` **before?**: `string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).

package/docs/reference/interfaces/IAuditableItemGraphVersionListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionListResponse
+
+Response to getting all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -117,3 +117,12 @@ Edges connected to the vertex.
 > `optional` **verified?**: `boolean`
 
 Is the vertex verified, will only be populated when verification is requested.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version of the vertex, populated only when getting a specific version.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphVertexVersionList.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphVertexVersionList
+
+Interface describing a list of auditable item graph vertex version numbers.
+
+## Properties
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: \[`"ItemList"`, `"AuditableItemGraphVertexVersionList"`\]
+
+JSON-LD Type.
+
+***
+
+### itemListElement {#itemlistelement}
+
+> **itemListElement**: `number`[]
+
+The list of version numbers.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -53,3 +53,9 @@ Represents auditable item graph changeset list.
 > `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
+
+### VertexVersionList {#vertexversionlist}
+
+> `readonly` **VertexVersionList**: `"AuditableItemGraphVertexVersionList"` = `"AuditableItemGraphVertexVersionList"`
+
+Represents auditable item graph vertex version list.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.12",
+	"version": "0.0.3-next.14",
 	"description": "Defines shared graph data contracts, JSON schemas, and JSON-LD contexts for consistent interoperability.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/auditable-item-graph.git",
+		"url": "git+https://github.com/iotaledger/auditable-item-graph.git",
 		"directory": "packages/auditable-item-graph-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -51,7 +51,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/auditable-item-graph/issues"
+		"url": "git+https://github.com/iotaledger/auditable-item-graph/issues"
 	},
 	"homepage": "https://twindev.org"
 }