Skip to content

Commit

Permalink
feat(ontology): update axone-protocol/ontology ontology documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@bot-anik
bot-anik committed Aug 8, 2024
1 parent 49014f7 commit ffd6766
Show file tree
Hide file tree
Showing 9 changed files with 150 additions and 150 deletions.
56 changes: 28 additions & 28 deletions ontology/schemas/credential-dataset-description.md
View file
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/axone/ontology/v3/schema/credential/dataset/description/](https://w3id.org/axone/ontology/v3/schema/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

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/axone/ontology/v3/thesaurus/](https://w3id.org/axone/ontology/v3/thesaurus/)
- `credential-dataset-description`: [https://w3id.org/axone/ontology/v3/schema/credential/dataset/description/](https://w3id.org/axone/ontology/v3/schema/credential/dataset/description/)
- `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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **IRI**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
### Description

Expand All @@ -38,23 +38,23 @@ 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/axone/ontology/v3/schema/credential/dataset/description/"
"https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/"
],
"type": ["VerifiableCredential","DatasetDescriptionCredential"],
"id": "https://w3id.org/axone/ontology/v3/schema/credential/dataset/description/5d29ea71-003f-46e7-a74d-d8d598629ed8",
"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/v3/thesaurus/media-type/text_csv",
"hasGeoCoverage": "https://w3id.org/axone/ontology/v3/thesaurus/area-code/840",
"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/v3/thesaurus/topic/security"
"hasTopic": "https://w3id.org/axone/ontology/v4/thesaurus/topic/security"
},
"issuanceDate": "2024-02-02T09:45:43.475304+01:00",
"issuer": {
Expand All @@ -69,80 +69,80 @@ The objective of these credentials is to furnish a wide-ranging insight into the

#### Has description
>
> **IRI**: [credential-dataset-description:hasDescription](https://w3id.org/axone/ontology/v3/schema/credential/dataset/description/hasDescription)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/schema/credential/dataset/description/hasFormat)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/thesaurus/media-type)
> **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/v3/schema/credential/dataset/description/hasGeoCoverage)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **Range**: [thesaurus:area](https://w3id.org/axone/ontology/v3/thesaurus/area)
> **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/v3/schema/credential/dataset/description/hasImage)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/schema/credential/dataset/description/hasTag)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/schema/credential/dataset/description/hasTemporalCoverage)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/schema/credential/dataset/description/hasTitle)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **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/v3/schema/credential/dataset/description/hasTopic)
> **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/v3/schema/credential/dataset/description/DatasetDescriptionCredential)
> **Domain**: [credential-dataset-description:DatasetDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/dataset/description/DatasetDescriptionCredential)
>
> **Range**: [thesaurus:topic](https://w3id.org/axone/ontology/v3/thesaurus/topic)
> **Range**: [thesaurus:topic](https://w3id.org/axone/ontology/v4/thesaurus/topic)
A topic of the Dataset.
14 changes: 7 additions & 7 deletions ontology/schemas/credential-digital-resource-publication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 2

> **Name**: `credential-digital-resource-publication`
>
> **Namespace**: [https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/publication/](https://w3id.org/axone/ontology/v3/schema/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

Expand All @@ -19,11 +19,11 @@ 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#)
- `credential-digital-resource-publication`: [https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/publication/](https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/publication/)
- `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/v3/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
> **IRI**: [credential-digital-resource-publication:DigitalResourcePublicationCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
### Description

Expand All @@ -33,19 +33,19 @@ Digital Resource Publication Credentials confirm the publication and availabilit

#### Has identifier
>
> **IRI**: [credential-digital-resource-publication:hasIdentifier](https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/publication/hasIdentifier)
> **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/v3/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
> **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/v3/schema/credential/digital-resource/publication/servedBy)
> **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/v3/schema/credential/digital-resource/publication/DigitalResourcePublicationCredential)
> **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)
Expand Down
24 changes: 12 additions & 12 deletions ontology/schemas/credential-digital-resource-rights.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3

> **Name**: `credential-digital-resource-rights`
>
> **Namespace**: [https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/rights/](https://w3id.org/axone/ontology/v3/schema/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

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/axone/ontology/v3/schema/credential/digital-resource/rights/](https://w3id.org/axone/ontology/v3/schema/credential/digital-resource/rights/)
- `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/v3/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
> **IRI**: [credential-digital-resource-rights:DigitalResourceRightsCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-resource/rights/DigitalResourceRightsCredential)
### Description

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

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

0 comments on commit ffd6766

Please sign in to comment.