Skip to content

Commit

Permalink
docs: update draft docs for contracts
Browse files Browse the repository at this point in the history
  • Loading branch information
@bot-anik
bot-anik committed Jun 23, 2023
1 parent 0be8f44 commit ef62681
Show file tree
Hide file tree
Showing 368 changed files with 2,109 additions and 1,443 deletions.
250 changes: 127 additions & 123 deletions contracts/README.md
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-dataformat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ merged type ([DataFormat](okp4-cognitarium-executemsg-definitions-dataformat.md)

one (and only one) of

* [RDF XML](okp4-cognitarium-executemsg-definitions-dataformat-oneof-rdf-xml.md "check type definition")
* [RDF XML](okp4-cognitarium-executemsg-definitions-dataformat-oneof-rdf-xml.md "check type definition")

* [Turtle](okp4-cognitarium-executemsg-definitions-dataformat-oneof-turtle.md "check type definition")
* [Turtle](okp4-cognitarium-executemsg-definitions-dataformat-oneof-turtle.md "check type definition")

* [N-Triples](okp4-cognitarium-executemsg-definitions-dataformat-oneof-n-triples.md "check type definition")
* [N-Triples](okp4-cognitarium-executemsg-definitions-dataformat-oneof-n-triples.md "check type definition")

* [N-Quads](okp4-cognitarium-executemsg-definitions-dataformat-oneof-n-quads.md "check type definition")
* [N-Quads](okp4-cognitarium-executemsg-definitions-dataformat-oneof-n-quads.md "check type definition")
2 changes: 2 additions & 0 deletions ...racts/okp4-cognitarium-executemsg-definitions-iri-oneof-full-properties-full.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/IRI/oneOf/1/properties/full
```



| 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") |
Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-iri-oneof-full.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ A full IRI.

## full



`full`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-iri-oneof-full-properties-full.md "undefined#/execute/definitions/IRI/oneOf/1/properties/full")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-iri-oneof-full-properties-full.md "undefined#/execute/definitions/IRI/oneOf/1/properties/full")

### full Type

Expand Down
2 changes: 2 additions & 0 deletions ...p4-cognitarium-executemsg-definitions-iri-oneof-prefixed-properties-prefixed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/IRI/oneOf/0/properties/prefixed
```



| 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") |
Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-iri-oneof-prefixed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ An IRI prefixed with a prefix. The prefixed IRI is expanded to a full IRI using

## prefixed



`prefixed`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-iri-oneof-prefixed-properties-prefixed.md "undefined#/execute/definitions/IRI/oneOf/0/properties/prefixed")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-iri-oneof-prefixed-properties-prefixed.md "undefined#/execute/definitions/IRI/oneOf/0/properties/prefixed")

### prefixed Type

Expand Down
4 changes: 2 additions & 2 deletions contracts/okp4-cognitarium-executemsg-definitions-iri.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ merged type ([IRI](okp4-cognitarium-executemsg-definitions-iri.md))

one (and only one) of

* [Prefixed](okp4-cognitarium-executemsg-definitions-iri-oneof-prefixed.md "check type definition")
* [Prefixed](okp4-cognitarium-executemsg-definitions-iri-oneof-prefixed.md "check type definition")

* [Full](okp4-cognitarium-executemsg-definitions-iri-oneof-full.md "check type definition")
* [Full](okp4-cognitarium-executemsg-definitions-iri-oneof-full.md "check type definition")
18 changes: 10 additions & 8 deletions ...nitions-literal-oneof-languagetaggedstring-properties-language_tagged_string.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string
```



| 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") |
Expand All @@ -25,13 +27,13 @@ The [language tag](https://www.w3.org/TR/rdf11-concepts/#dfn-language-tag).

`language`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string-properties-language.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string/properties/language")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string-properties-language.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string/properties/language")

### language Type

Expand All @@ -43,13 +45,13 @@ The [lexical form](https://www.w3.org/TR/rdf11-concepts/#dfn-lexical-form).

`value`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string-properties-value.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string/properties/value")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string-properties-value.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string/properties/value")

### value Type

Expand Down
10 changes: 6 additions & 4 deletions ...s/okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ A [language-tagged string](https://www.w3.org/TR/rdf11-concepts/#dfn-language-ta

## language\_tagged\_string



`language_tagged_string`

* is required
* is required

* Type: `object` ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string.md))
* Type: `object` ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string.md))

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring-properties-language_tagged_string.md "undefined#/execute/definitions/Literal/oneOf/1/properties/language_tagged_string")

### language\_tagged\_string Type

Expand Down
2 changes: 2 additions & 0 deletions ...p4-cognitarium-executemsg-definitions-literal-oneof-simple-properties-simple.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Literal/oneOf/0/properties/simple
```



| 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") |
Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-literal-oneof-simple.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ A [simple literal](https://www.w3.org/TR/rdf11-concepts/#dfn-simple-literal) wit

## simple



`simple`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-simple-properties-simple.md "undefined#/execute/definitions/Literal/oneOf/0/properties/simple")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-simple-properties-simple.md "undefined#/execute/definitions/Literal/oneOf/0/properties/simple")

### simple Type

Expand Down
2 changes: 2 additions & 0 deletions ...-literal-oneof-typedvalue-properties-typed_value-properties-datatype-allof-0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value/properties/datatype/allOf/0
```



| 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") |
Expand Down
2 changes: 1 addition & 1 deletion ...initions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ merged type ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typ

all of

* [Untitled undefined type in okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype-allof-0.md "check type definition")
* [Untitled undefined type in okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype-allof-0.md "check type definition")
20 changes: 11 additions & 9 deletions ...arium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value
```



| 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") |
Expand All @@ -25,35 +27,35 @@ The [datatype IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-datatype-iri).

`datatype`

* is required
* is required

* Type: merged type ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md))
* Type: merged type ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md))

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value/properties/datatype")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value/properties/datatype")

### datatype Type

merged type ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype.md))

all of

* [Untitled undefined type in okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype-allof-0.md "check type definition")
* [Untitled undefined type in okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-datatype-allof-0.md "check type definition")

## value

The [lexical form](https://www.w3.org/TR/rdf11-concepts/#dfn-lexical-form).

`value`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-value.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value/properties/value")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value-properties-value.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value/properties/value")

### value Type

Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ A value with a datatype.

## typed\_value



`typed_value`

* is required
* is required

* Type: `object` ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value.md))
* Type: `object` ([Details](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value.md))

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue-properties-typed_value.md "undefined#/execute/definitions/Literal/oneOf/2/properties/typed_value")

### typed\_value Type

Expand Down
6 changes: 3 additions & 3 deletions contracts/okp4-cognitarium-executemsg-definitions-literal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ merged type ([Literal](okp4-cognitarium-executemsg-definitions-literal.md))

one (and only one) of

* [Simple](okp4-cognitarium-executemsg-definitions-literal-oneof-simple.md "check type definition")
* [Simple](okp4-cognitarium-executemsg-definitions-literal-oneof-simple.md "check type definition")

* [LanguageTaggedString](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring.md "check type definition")
* [LanguageTaggedString](okp4-cognitarium-executemsg-definitions-literal-oneof-languagetaggedstring.md "check type definition")

* [TypedValue](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue.md "check type definition")
* [TypedValue](okp4-cognitarium-executemsg-definitions-literal-oneof-typedvalue.md "check type definition")
2 changes: 2 additions & 0 deletions ...ognitarium-executemsg-definitions-node-oneof-blanknode-properties-blank_node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Node/oneOf/1/properties/blank_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") |
Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-node-oneof-blanknode.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ An RDF [blank node](https://www.w3.org/TR/rdf11-concepts/#dfn-blank-node).

## blank\_node



`blank_node`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-node-oneof-blanknode-properties-blank_node.md "undefined#/execute/definitions/Node/oneOf/1/properties/blank_node")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-node-oneof-blanknode-properties-blank_node.md "undefined#/execute/definitions/Node/oneOf/1/properties/blank_node")

### blank\_node Type

Expand Down
2 changes: 2 additions & 0 deletions ...ognitarium-executemsg-definitions-node-oneof-namednode-properties-named_node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
undefined#/execute/definitions/Node/oneOf/0/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") |
Expand Down
10 changes: 6 additions & 4 deletions contracts/okp4-cognitarium-executemsg-definitions-node-oneof-namednode.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ An RDF [IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-iri).

## named\_node



`named_node`

* is required
* is required

* Type: unknown
* Type: unknown

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-node-oneof-namednode-properties-named_node.md "undefined#/execute/definitions/Node/oneOf/0/properties/named_node")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-node-oneof-namednode-properties-named_node.md "undefined#/execute/definitions/Node/oneOf/0/properties/named_node")

### named\_node Type

Expand Down
4 changes: 2 additions & 2 deletions contracts/okp4-cognitarium-executemsg-definitions-node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ merged type ([Node](okp4-cognitarium-executemsg-definitions-node.md))

one (and only one) of

* [NamedNode](okp4-cognitarium-executemsg-definitions-node-oneof-namednode.md "check type definition")
* [NamedNode](okp4-cognitarium-executemsg-definitions-node-oneof-namednode.md "check type definition")

* [BlankNode](okp4-cognitarium-executemsg-definitions-node-oneof-blanknode.md "check type definition")
* [BlankNode](okp4-cognitarium-executemsg-definitions-node-oneof-blanknode.md "check type definition")
16 changes: 8 additions & 8 deletions contracts/okp4-cognitarium-executemsg-definitions-prefix.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ The namespace associated with the prefix.

`namespace`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-prefix-properties-namespace.md "undefined#/execute/definitions/Prefix/properties/namespace")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-prefix-properties-namespace.md "undefined#/execute/definitions/Prefix/properties/namespace")

### namespace Type

Expand All @@ -45,13 +45,13 @@ The prefix.

`prefix`

* is required
* is required

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-prefix-properties-prefix.md "undefined#/execute/definitions/Prefix/properties/prefix")
* defined in: [okp4-cognitarium](okp4-cognitarium-executemsg-definitions-prefix-properties-prefix.md "undefined#/execute/definitions/Prefix/properties/prefix")

### prefix Type

Expand Down
Loading

0 comments on commit ef62681

Please sign in to comment.