docs(cognitarium): re-generate documentation after schema update

axone-protocol · Jun 17, 2023 · f8602a1 · f8602a1
1 parent a97b0c1
commit f8602a1
Show file tree

Hide file tree

Showing 8 changed files with 145 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -66,6 +66,8 @@
 
 *   [NamedNode](./okp4-cognitarium-querymsg-definitions-node-oneof-namednode.md "An RDF IRI") – `undefined#/query/definitions/Node/oneOf/0`
 
+*   [NamedNode](./okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode.md "An RDF IRI") – `undefined#/query/definitions/VarOrNamedNode/oneOf/1`
+
 *   [Node](./okp4-cognitarium-executemsg-definitions-varornode-oneof-node.md "A node, i") – `undefined#/execute/definitions/VarOrNode/oneOf/1`
 
 *   [Node](./okp4-cognitarium-executemsg-definitions-varornodeorliteral-oneof-node.md "A node, i") – `undefined#/execute/definitions/VarOrNodeOrLiteral/oneOf/1`
@@ -214,6 +216,8 @@
 
 *   [Variable](./okp4-cognitarium-querymsg-definitions-selectitem-oneof-variable.md "Represents a variable") – `undefined#/query/definitions/SelectItem/oneOf/0`
 
+*   [Variable](./okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable.md "A variable") – `undefined#/query/definitions/VarOrNamedNode/oneOf/0`
+
 *   [Variable](./okp4-cognitarium-querymsg-definitions-varornode-oneof-variable.md "A variable") – `undefined#/query/definitions/VarOrNode/oneOf/0`
 
 *   [Variable](./okp4-cognitarium-querymsg-definitions-varornodeorliteral-oneof-variable.md "A variable") – `undefined#/query/definitions/VarOrNodeOrLiteral/oneOf/0`

diff --git a/...m-querymsg-definitions-varornamednode--oneof-namednode-properties-named_node.md b/...m-querymsg-definitions-varornamednode--oneof-namednode-properties-named_node.md
@@ -0,0 +1,15 @@
+# Untitled undefined type in okp4-cognitarium Schema
+
+```txt
+undefined#/query/definitions/VarOrNamedNode/oneOf/1/properties/named_node
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                     |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [okp4-cognitarium.json\*](schema/okp4-cognitarium.json "open original schema") |
+
+## named\_node Type
+
+unknown
diff --git a/docs/okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode.md b/docs/okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode.md
@@ -0,0 +1,39 @@
+# NamedNode Schema
+
+```txt
+undefined#/query/definitions/VarOrNamedNode/oneOf/1
+```
+
+An RDF [IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-iri).
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                     |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [okp4-cognitarium.json\*](schema/okp4-cognitarium.json "open original schema") |
+
+## 1 Type
+
+`object` ([NamedNode](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode.md))
+
+# 1 Properties
+
+| Property                   | Type          | Required | Nullable       | Defined by                                                                                                                                                                                     |
+| :------------------------- | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [named\_node](#named_node) | Not specified | Required | cannot be null | [okp4-cognitarium](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode-properties-named_node.md "undefined#/query/definitions/VarOrNamedNode/oneOf/1/properties/named_node") |
+
+## named\_node
+
+
+
+`named_node`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [okp4-cognitarium](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode-properties-named_node.md "undefined#/query/definitions/VarOrNamedNode/oneOf/1/properties/named_node")
+
+### named\_node Type
+
+unknown
diff --git a/...rium-querymsg-definitions-varornamednode--oneof-variable-properties-variable.md b/...rium-querymsg-definitions-varornamednode--oneof-variable-properties-variable.md
@@ -0,0 +1,15 @@
+# Untitled string in okp4-cognitarium Schema
+
+```txt
+undefined#/query/definitions/VarOrNamedNode/oneOf/0/properties/variable
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                     |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [okp4-cognitarium.json\*](schema/okp4-cognitarium.json "open original schema") |
+
+## variable Type
+
+`string`
diff --git a/docs/okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable.md b/docs/okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable.md
@@ -0,0 +1,39 @@
+# Variable Schema
+
+```txt
+undefined#/query/definitions/VarOrNamedNode/oneOf/0
+```
+
+A variable.
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                     |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [okp4-cognitarium.json\*](schema/okp4-cognitarium.json "open original schema") |
+
+## 0 Type
+
+`object` ([Variable](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable.md))
+
+# 0 Properties
+
+| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                |
+| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [variable](#variable) | `string` | Required | cannot be null | [okp4-cognitarium](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable-properties-variable.md "undefined#/query/definitions/VarOrNamedNode/oneOf/0/properties/variable") |
+
+## variable
+
+
+
+`variable`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [okp4-cognitarium](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable-properties-variable.md "undefined#/query/definitions/VarOrNamedNode/oneOf/0/properties/variable")
+
+### variable Type
+
+`string`
diff --git a/docs/okp4-cognitarium-querymsg-definitions-varornamednode-.md b/docs/okp4-cognitarium-querymsg-definitions-varornamednode-.md
@@ -0,0 +1,21 @@
+# VarOrNamedNode { Schema
+
+```txt
+undefined#/query/definitions/VarOrNamedNode
+```
+
+Represents either a variable or a named node (IRI).
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                     |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [okp4-cognitarium.json\*](schema/okp4-cognitarium.json "open original schema") |
+
+## VarOrNamedNode Type
+
+merged type ([VarOrNamedNode {](okp4-cognitarium-querymsg-definitions-varornamednode-.md))
+
+one (and only one) of
+
+*   [Variable](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-variable.md "check type definition")
+
+*   [NamedNode](okp4-cognitarium-querymsg-definitions-varornamednode--oneof-namednode.md "check type definition")
diff --git a/docs/okp4-cognitarium-querymsg.md b/docs/okp4-cognitarium-querymsg.md
@@ -384,6 +384,17 @@ all of
 
 *   [Untitled undefined type in okp4-cognitarium](okp4-cognitarium-querymsg-definitions-triplepattern-properties-subject-allof-0.md "check type definition")
 
+## Definitions group VarOrNamedNode
+
+Reference this group by using
+
+```json
+{"$ref":"undefined#/query/definitions/VarOrNamedNode"}
+```
+
+| Property | Type | Required | Nullable | Defined by |
+| :------- | :--- | :------- | :------- | :--------- |
+
 ## Definitions group VarOrNode
 
 Reference this group by using

diff --git a/docs/schema/okp4-cognitarium.json b/docs/schema/okp4-cognitarium.json