Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📜 Add v4.0.0 ontology documentation version #543

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
sidebar_position: 1
---
[//]: # (This file is auto-generated. Please do not modify it yourself.)

# Dataset description credential

> **Name**: `credential-dataset-description`
>
> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/)

## Namespaces

Here are the namespaces used in this schema:

- `rdf`: [http://www.w3.org/1999/02/22-rdf-syntax-ns#](http://www.w3.org/1999/02/22-rdf-syntax-ns#)
- `rdfs`: [http://www.w3.org/2000/01/rdf-schema#](http://www.w3.org/2000/01/rdf-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/)
- `xsd`: [http://www.w3.org/2001/XMLSchema#](http://www.w3.org/2001/XMLSchema#)
- `thesaurus`: [https://w3id.org/axone/ontology/v4/thesaurus/](https://w3id.org/axone/ontology/v4/thesaurus/)
- `credential-dataset-description`: [https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/)

## Verifiable Credential

> **IRI**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)

### Description

Dataset Description credentials deliver an extensive overview of the principal attributes of a dataset. Commonly, they encompass details like the dataset's title, its detailed description, associated tags, as well as its subject matter, and both temporal and geographical scopes.

The objective of these credentials is to furnish a wide-ranging insight into the dataset, thereby simplifying the process for users to comprehend the dataset's content and potential applications.

### Examples

```json title="crime-dataset-description.jsonld"
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/"
],
"type": ["VerifiableCredential","DatasetDescriptionCredential"],
"id": "https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/5d29ea71-003f-46e7-a74d-d8d598629ed8",
"credentialSubject": {
"id": "did:key:zQ3shRfADCmegmmKotqCjzDc9BHWDpbEzp9yMiN5RkJx88oP5",
"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/axone/ontology/v4/thesaurus/media-type/text_csv",
"hasGeoCoverage": "https://w3id.org/axone/ontology/v4/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/axone/ontology/v4/thesaurus/topic/security"
},
"issuanceDate": "2024-02-02T09:45:43.475304+01:00",
"issuer": {
"id": "did:key:zQ3shs7auhJSmVJpiUbQWco6bxxEhSqWnVEPvaBHBRvBKw6Q3",
"name": "OKP4"
}
}

```

### Properties

#### Has description
>
> **IRI**: [credential-dataset-description:hasDescription](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/hasDescription)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **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/axone/ontology/v4/schema/credential/dataset/description/hasFormat)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **Range**: [thesaurus:media-type](https://w3id.org/axone/ontology/v4/thesaurus/media-type)

The format of the Dataset.

#### Has geo coverage
>
> **IRI**: [credential-dataset-description:hasGeoCoverage](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/hasGeoCoverage)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **Range**: [thesaurus:area](https://w3id.org/axone/ontology/v4/thesaurus/area)

Indicates the geographical area that the dataset applies to,

#### Has image
>
> **IRI**: [credential-dataset-description:hasImage](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/hasImage)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **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/axone/ontology/v4/schema/credential/dataset/description/hasTag)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **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/axone/ontology/v4/schema/credential/dataset/description/hasTemporalCoverage)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **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/axone/ontology/v4/schema/credential/dataset/description/hasTitle)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **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/axone/ontology/v4/schema/credential/dataset/description/hasTopic)
>
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **Range**: [thesaurus:topic](https://w3id.org/axone/ontology/v4/thesaurus/topic)

A topic of the Dataset.
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
sidebar_position: 2
---
[//]: # (This file is auto-generated. Please do not modify it yourself.)

# Digital resource publication credential

> **Name**: `credential-digital-resource-publication`
>
> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/)

## Namespaces

Here are the namespaces used in this schema:

- `rdf`: [http://www.w3.org/1999/02/22-rdf-syntax-ns#](http://www.w3.org/1999/02/22-rdf-syntax-ns#)
- `rdfs`: [http://www.w3.org/2000/01/rdf-schema#](http://www.w3.org/2000/01/rdf-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/)
- `xsd`: [http://www.w3.org/2001/XMLSchema#](http://www.w3.org/2001/XMLSchema#)
- `credential-digital-resource-publication`: [https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/)

## Verifiable Credential

> **IRI**: [credential-digital-resource-publication:DigitalResourcePublicationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)

### Description

Digital Resource Publication Credentials confirm the publication and availability of a digital asset through a digital service.

### Properties

#### Has identifier
>
> **IRI**: [credential-digital-resource-publication:hasIdentifier](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/hasIdentifier)
>
> **Domain**: [credential-digital-resource-publication:DigitalResourcePublicationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)

The URI that identifies the digital asset within the scope of a digital service that provides access to it.

#### Served by
>
> **IRI**: [credential-digital-resource-publication:servedBy](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/servedBy)
>
> **Domain**: [credential-digital-resource-publication:DigitalResourcePublicationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)

The digital service that makes the resource accessible.

This information is vital for enabling interactions with the resource. In this context, digital services act as conduits for distributing
and exchanging digital resources across various networks. These services manifest in multiple forms, including network communication
protocols such as RESTful APIs and gRPC services. They play a crucial role in connecting resources to orchestrator services, which
leverage these resources for a range of applications. For instance, a digital resource might be a dataset accessible via a RESTful API,
utilized by an orchestrator service to train a machine learning model.
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
sidebar_position: 3
---
[//]: # (This file is auto-generated. Please do not modify it yourself.)

# Digital resource rights credential

> **Name**: `credential-digital-resource-rights`
>
> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/)

## Namespaces

Here are the namespaces used in this schema:

- `rdf`: [http://www.w3.org/1999/02/22-rdf-syntax-ns#](http://www.w3.org/1999/02/22-rdf-syntax-ns#)
- `rdfs`: [http://www.w3.org/2000/01/rdf-schema#](http://www.w3.org/2000/01/rdf-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/axone/ontology/v4/schema/credential/digital-resource/rights/](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/)

## Verifiable Credential

> **IRI**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)

### Description

Digital Resource Rights Credentials provide comprehensive information regarding the authorship, creation, publishing, and licensing of a Digital Resource.

These details are critical for understanding the Digital Resource's provenance, ownership, and the terms under which it can be used.

### Properties

#### Has author
>
> **IRI**: [credential-digital-resource-rights:hasAuthor](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/hasAuthor)
>
> **Domain**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
>
> **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/axone/ontology/v4/schema/credential/digital-resource/rights/hasCreator)
>
> **Domain**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
>
> **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/axone/ontology/v4/schema/credential/digital-resource/rights/hasLicense)
>
> **Domain**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
>
> **Range**: [ns1:license](https://w3id.org/axone/ontology/v4/thesaurus/license)

The licensing terms under which the Digital Resource is made available.

#### Has publisher
>
> **IRI**: [credential-digital-resource-rights:hasPublisher](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/hasPublisher)
>
> **Domain**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
>
> **Range**: [schema:Organization](http://schema.org/Organization), [schema:Person](http://schema.org/Person)

The publisher of the Digital Resource.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_position: 4
---
[//]: # (This file is auto-generated. Please do not modify it yourself.)

# Digital service authentication credential

> **Name**: `credential-digital-service-authentication`
>
> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/)

## Namespaces

Here are the namespaces used in this schema:

- `rdf`: [http://www.w3.org/1999/02/22-rdf-syntax-ns#](http://www.w3.org/1999/02/22-rdf-syntax-ns#)
- `rdfs`: [http://www.w3.org/2000/01/rdf-schema#](http://www.w3.org/2000/01/rdf-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/)
- `xsd`: [http://www.w3.org/2001/XMLSchema#](http://www.w3.org/2001/XMLSchema#)
- `credential-digital-service-authentication`: [https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/)

## Verifiable Credential

> **IRI**: [credential-digital-service-authentication:DigitalServiceAuthenticationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/DigitalServiceAuthenticationCredential)

### Description

The Digital Service Authentication Credential is a formal declaration used to authenticate a Digital Service against another.

In these credentials, both the subject and the issuer are the Digital Service to be authenticated. The credential carries the needed element to verify the requested authentication.

### Properties

#### To service
>
> **IRI**: [credential-digital-service-authentication:toService](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/toService)
>
> **Domain**: [credential-digital-service-authentication:DigitalServiceAuthenticationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/authentication/DigitalServiceAuthenticationCredential)
>
> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI)

The Digital Service to authenticate to.
Loading
Loading