Skip to content

Commit

Permalink
Merge pull request #447 from okp4/feat/ontology-v3.0.0
Browse files Browse the repository at this point in the history
📜 Add v3.0.0 ontology documentation version
  • Loading branch information
amimart authored Mar 5, 2024
2 parents 1711244 + 6ac4268 commit 906400c
Show file tree
Hide file tree
Showing 16 changed files with 1,031 additions and 115 deletions.
40 changes: 20 additions & 20 deletions ontology/schemas/credential-dataset-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1

> **Name**: `credential-dataset-description`
>
> **Namespace**: [https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/)
> **Namespace**: [https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/)
## Namespaces

Expand All @@ -19,12 +19,12 @@ Here are the namespaces used in this schema:
- `dcterms`: [http://purl.org/dc/terms/](http://purl.org/dc/terms/)
- `schema`: [http://schema.org/](http://schema.org/)
- `xsd`: [http://www.w3.org/2001/XMLSchema#](http://www.w3.org/2001/XMLSchema#)
- `thesaurus`: [https://w3id.org/okp4/ontology/v2/thesaurus/](https://w3id.org/okp4/ontology/v2/thesaurus/)
- `credential-dataset-description`: [https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/)
- `thesaurus`: [https://w3id.org/okp4/ontology/v3/thesaurus/](https://w3id.org/okp4/ontology/v3/thesaurus/)
- `credential-dataset-description`: [https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/)

## Verifiable Credential

> **IRI**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/DatasetDescriptionCredential)
> **IRI**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
### Description

Expand All @@ -38,24 +38,24 @@ The objective of these credentials is to furnish a wide-ranging insight into the
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/"
"https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/"
],
"type": "VerifiableCredential",
"id": "https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/d1120529-3242-4fa8-ac7c-a99abc3fc73e",
"id": "https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/d1120529-3242-4fa8-ac7c-a99abc3fc73e",
"credentialSubject": {
"id": "did:key:zQ3shRfADCmegmmKotqCjzDc9BHWDpbEzp9yMiN5RkJx88oP5",
"type": "DatasetDescriptionCredential",
"hasDescription": "This dataset reflects incidents of crime in the City of Los Angeles dating back to 2020. This data is transcribed from original crime reports that are typed on paper and therefore there may be some inaccuracies within the data. Some location fields with missing data are noted as (0°, 0°). Address fields are only provided to the nearest hundred block in order to maintain privacy. This data is as accurate as the data in the database.",
"hasFormat": "https://w3id.org/okp4/ontology/v2/thesaurus/media-type/text_csv",
"hasGeoCoverage": "https://w3id.org/okp4/ontology/v2/thesaurus/area-code/840",
"hasFormat": "https://w3id.org/okp4/ontology/v3/thesaurus/media-type/text_csv",
"hasGeoCoverage": "https://w3id.org/okp4/ontology/v3/thesaurus/area-code/840",
"hasTag": [
"Crime",
"Police",
"Los Angeles"
],
"hasTemporalCoverage": "2020-01-01T00:00:00.0000+01:00/2024-02-02T00:00:00.00000+01:00",
"hasTitle": "Crime Data from 2020 to Present",
"hasTopic": "https://w3id.org/okp4/ontology/v2/thesaurus/topic/security"
"hasTopic": "https://w3id.org/okp4/ontology/v3/thesaurus/topic/security"
},
"issuanceDate": "2024-02-02T09:45:43.475304+01:00",
"issuer": {
Expand All @@ -70,64 +70,64 @@ The objective of these credentials is to furnish a wide-ranging insight into the

#### Has description
>
> **IRI**: [credential-dataset-description:hasDescription](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasDescription)
> **IRI**: [credential-dataset-description:hasDescription](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasDescription)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
A description of the Dataset.

#### Has format
>
> **IRI**: [credential-dataset-description:hasFormat](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasFormat)
> **IRI**: [credential-dataset-description:hasFormat](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasFormat)
>
> **Range**: [thesaurus:media-type](https://w3id.org/okp4/ontology/v2/thesaurus/media-type)
> **Range**: [thesaurus:media-type](https://w3id.org/okp4/ontology/v3/thesaurus/media-type)
The format of the Dataset.

#### Has geo coverage
>
> **IRI**: [credential-dataset-description:hasGeoCoverage](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasGeoCoverage)
> **IRI**: [credential-dataset-description:hasGeoCoverage](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasGeoCoverage)
>
> **Range**: [thesaurus:area](https://w3id.org/okp4/ontology/v2/thesaurus/area)
> **Range**: [thesaurus:area](https://w3id.org/okp4/ontology/v3/thesaurus/area)
Indicates the geographical area that the dataset applies to,

#### Has image
>
> **IRI**: [credential-dataset-description:hasImage](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasImage)
> **IRI**: [credential-dataset-description:hasImage](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasImage)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)
The image associated with the Dataset.

#### Has tag
>
> **IRI**: [credential-dataset-description:hasTag](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasTag)
> **IRI**: [credential-dataset-description:hasTag](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasTag)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
A (free) keyword or term assigned to the Dataset.

#### Has temporal coverage
>
> **IRI**: [credential-dataset-description:hasTemporalCoverage](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasTemporalCoverage)
> **IRI**: [credential-dataset-description:hasTemporalCoverage](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasTemporalCoverage)
>
> **Range**: [schema:DateTime](http://schema.org/DateTime)
Indicates the period that the dataset applies to,

#### Has title
>
> **IRI**: [credential-dataset-description:hasTitle](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasTitle)
> **IRI**: [credential-dataset-description:hasTitle](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasTitle)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
The title of the Dataset.

#### Has topic
>
> **IRI**: [credential-dataset-description:hasTopic](https://w3id.org/okp4/ontology/v2/schema/credential/dataset/description/hasTopic)
> **IRI**: [credential-dataset-description:hasTopic](https://w3id.org/okp4/ontology/v3/schema/credential/dataset/description/hasTopic)
>
> **Range**: [thesaurus:topic](https://w3id.org/okp4/ontology/v2/thesaurus/topic)
> **Range**: [thesaurus:topic](https://w3id.org/okp4/ontology/v3/thesaurus/topic)
A topic of the Dataset.
16 changes: 8 additions & 8 deletions ontology/schemas/credential-digital-resource-rights.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 2

> **Name**: `credential-digital-resource-rights`
>
> **Namespace**: [https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/)
> **Namespace**: [https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/)
## Namespaces

Expand All @@ -18,11 +18,11 @@ Here are the namespaces used in this schema:
- `skos`: [http://www.w3.org/2004/02/skos/core#](http://www.w3.org/2004/02/skos/core#)
- `dcterms`: [http://purl.org/dc/terms/](http://purl.org/dc/terms/)
- `schema`: [http://schema.org/](http://schema.org/)
- `credential-digital-resource-rights`: [https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/)
- `credential-digital-resource-rights`: [https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/)

## Verifiable Credential

> **IRI**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
> **IRI**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
### Description

Expand All @@ -34,31 +34,31 @@ These details are critical for understanding the Digital Resource's provenance,

#### Has author
>
> **IRI**: [credential-digital-resource-rights:hasAuthor](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasAuthor)
> **IRI**: [credential-digital-resource-rights:hasAuthor](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/hasAuthor)
>
> **Range**: [schema:Organization](http://schema.org/Organization), [schema:Person](http://schema.org/Person)
The author(s) of the Digital Resource.

#### Has creator
>
> **IRI**: [credential-digital-resource-rights:hasCreator](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasCreator)
> **IRI**: [credential-digital-resource-rights:hasCreator](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/hasCreator)
>
> **Range**: [schema:Organization](http://schema.org/Organization), [schema:Person](http://schema.org/Person)
The creator or entity responsible for compiling or generating the Digital Resource.

#### Has license
>
> **IRI**: [credential-digital-resource-rights:hasLicense](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasLicense)
> **IRI**: [credential-digital-resource-rights:hasLicense](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/hasLicense)
>
> **Range**: [ns1:license](https://w3id.org/okp4/ontology/v2/thesaurus/license)
> **Range**: [ns1:license](https://w3id.org/okp4/ontology/v3/thesaurus/license)
The licensing terms under which the Digital Resource is made available.

#### Has publisher
>
> **IRI**: [credential-digital-resource-rights:hasPublisher](https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasPublisher)
> **IRI**: [credential-digital-resource-rights:hasPublisher](https://w3id.org/okp4/ontology/v3/schema/credential/digital-resource/rights/hasPublisher)
>
> **Range**: [schema:Organization](http://schema.org/Organization), [schema:Person](http://schema.org/Person)
Expand Down
30 changes: 15 additions & 15 deletions ontology/schemas/credential-digital-service-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3

> **Name**: `credential-digital-service-description`
>
> **Namespace**: [https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/)
> **Namespace**: [https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/)
## Namespaces

Expand All @@ -19,12 +19,12 @@ Here are the namespaces used in this schema:
- `dcterms`: [http://purl.org/dc/terms/](http://purl.org/dc/terms/)
- `schema`: [http://schema.org/](http://schema.org/)
- `xsd`: [http://www.w3.org/2001/XMLSchema#](http://www.w3.org/2001/XMLSchema#)
- `thesaurus`: [https://w3id.org/okp4/ontology/v2/thesaurus/](https://w3id.org/okp4/ontology/v2/thesaurus/)
- `credential-digital-service-description`: [https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/)
- `thesaurus`: [https://w3id.org/okp4/ontology/v3/thesaurus/](https://w3id.org/okp4/ontology/v3/thesaurus/)
- `credential-digital-service-description`: [https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/)

## Verifiable Credential

> **IRI**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/DigitalServiceDescriptionCredential)
> **IRI**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/DigitalServiceDescriptionCredential)
### Description

Expand All @@ -38,14 +38,14 @@ Their primary function is to simplify the process for users to grasp the service
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/"
"https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/"
],
"type": "VerifiableCredential",
"id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/72cab400-5bd6-4eb4-8605-a5ee8c1a45c9",
"id": "https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/72cab400-5bd6-4eb4-8605-a5ee8c1a45c9",
"credentialSubject": {
"id": "did:key:zQ3shhb4SvzBRLbBonsvKb3WX6WoDeKWHpsXXXMhAJETqXAfB",
"type": "DigitalServiceDescriptionCredential",
"hasCategory": "https://w3id.org/okp4/ontology/v2/thesaurus/digital-service-category/Storage",
"hasCategory": "https://w3id.org/okp4/ontology/v3/thesaurus/digital-service-category/Storage",
"hasDescription": "IPFS is a decentralized protocol designed to facilitate the storage, sharing, and retrieval of files on a global scale",
"hasPublisher": "IPFS",
"hasTag": [
Expand All @@ -69,55 +69,55 @@ Their primary function is to simplify the process for users to grasp the service

#### Has category
>
> **IRI**: [credential-digital-service-description:hasCategory](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasCategory)
> **IRI**: [credential-digital-service-description:hasCategory](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasCategory)
>
> **Range**: [thesaurus:service-category](https://w3id.org/okp4/ontology/v2/thesaurus/service-category)
> **Range**: [thesaurus:service-category](https://w3id.org/okp4/ontology/v3/thesaurus/service-category)
A category of the Digital Service.

#### Has description
>
> **IRI**: [credential-digital-service-description:hasDescription](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasDescription)
> **IRI**: [credential-digital-service-description:hasDescription](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasDescription)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
A description of the Digital Service.

#### Has image
>
> **IRI**: [credential-digital-service-description:hasImage](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasImage)
> **IRI**: [credential-digital-service-description:hasImage](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasImage)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)
The image associated with the Digital Service.

#### Has publisher
>
> **IRI**: [credential-digital-service-description:hasPublisher](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasPublisher)
> **IRI**: [credential-digital-service-description:hasPublisher](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasPublisher)
>
> **Range**: [schema:Organization](http://schema.org/Organization), [schema:Person](http://schema.org/Person)
An entity primarily responsible for making the Digital Service available.

#### Has tag
>
> **IRI**: [credential-digital-service-description:hasTag](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasTag)
> **IRI**: [credential-digital-service-description:hasTag](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasTag)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
A (free) keyword or term assigned to the Digital Service.

#### Has title
>
> **IRI**: [credential-digital-service-description:hasTitle](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasTitle)
> **IRI**: [credential-digital-service-description:hasTitle](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasTitle)
>
> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string)
The title of the Digital Service.

#### Has webpage
>
> **IRI**: [credential-digital-service-description:hasWebpage](https://w3id.org/okp4/ontology/v2/schema/credential/digital-service/description/hasWebpage)
> **IRI**: [credential-digital-service-description:hasWebpage](https://w3id.org/okp4/ontology/v3/schema/credential/digital-service/description/hasWebpage)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)
Expand Down
Loading

0 comments on commit 906400c

Please sign in to comment.