diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-dataset-description.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-dataset-description.md new file mode 100644 index 00000000000..c430a2166c8 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-dataset-description.md @@ -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. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-publication.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-publication.md new file mode 100644 index 00000000000..be39603280e --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-publication.md @@ -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. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-rights.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-rights.md new file mode 100644 index 00000000000..f9cbe0d8e2d --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-rights.md @@ -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. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-authentication.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-authentication.md new file mode 100644 index 00000000000..00b3835fbe6 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-authentication.md @@ -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. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-description.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-description.md new file mode 100644 index 00000000000..d86bff401cb --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-description.md @@ -0,0 +1,137 @@ +--- +sidebar_position: 5 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Digital service description credential + +> **Name**: `credential-digital-service-description` +> +> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/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-digital-service-description`: [https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/) + +## Verifiable Credential + +> **IRI**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) + +### Description + +Digital Service Description credentials offer a comprehensive summary of a Digital Service's key features, encompassing aspects like its title, description, and associated tags. + +Their primary function is to simplify the process for users to grasp the service's intent and practical application. + +### Examples + +```json title="ipfs-digital-service-description.jsonld" +{ + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/" + ], + "type": ["VerifiableCredential","DigitalServiceDescriptionCredential"], + "id": "https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/5a3bd610-3a5d-4a41-bc90-0e437d453220", + "credentialSubject": { + "id": "did:key:zQ3shhb4SvzBRLbBonsvKb3WX6WoDeKWHpsXXXMhAJETqXAfB", + "hasCategory": "https://w3id.org/axone/ontology/v4/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": [ + "Storage", + "Peer-to-peer", + "Cloud" + ], + "hasTitle": "IPFS", + "hasWebpage": "https://docs.ipfs.tech/" + }, + "issuanceDate": "2024-01-22T09:28:43.475304+01:00", + "issuer": { + "id": "did:key:zQ3shs7auhJSmVJpiUbQWco6bxxEhSqWnVEPvaBHBRvBKw6Q3", + "name": "OKP4" + } +} + +``` + +### Properties + +#### Has category +> +> **IRI**: [credential-digital-service-description:hasCategory](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/hasCategory) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **Range**: [thesaurus:service-category](https://w3id.org/axone/ontology/v4/thesaurus/service-category) + +A category of the Digital Service. + +#### Has description +> +> **IRI**: [credential-digital-service-description:hasDescription](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/hasDescription) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **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/axone/ontology/v4/schema/credential/digital-service/description/hasImage) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **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/axone/ontology/v4/schema/credential/digital-service/description/hasPublisher) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **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/axone/ontology/v4/schema/credential/digital-service/description/hasTag) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **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/axone/ontology/v4/schema/credential/digital-service/description/hasTitle) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **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/axone/ontology/v4/schema/credential/digital-service/description/hasWebpage) +> +> **Domain**: [credential-digital-service-description:DigitalServiceDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/digital-service/description/DigitalServiceDescriptionCredential) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +A public web page detailing the service, its pricing and any other information useful for the user of the service. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-governance-text.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-governance-text.md new file mode 100644 index 00000000000..c948493bef7 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-governance-text.md @@ -0,0 +1,246 @@ +--- +sidebar_position: 6 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Governance description credential + +> **Name**: `credential-governance-text` +> +> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/governance/text/](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/) + +## 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-governance-text`: [https://w3id.org/axone/ontology/v4/schema/credential/governance/text/](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/) + +## Verifiable Credential + +> **IRI**: [credential-governance-text:GovernanceTextCredential](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/GovernanceTextCredential) + +### Description + +Governance Text Credential is a type of Credential that attests to descriptive information about a governance text in a "human-readable format". + +The Governance Text Credential applies to all resources in the Dataverse for which rules must be followed. Such Governances are categorized into three main types as recognized by the [OKP4 protocol](https://okp4.network): + +- Zone Rules: Rules establish the boundaries of a specific area in the Dataverse, termed a Zone, within which governance is enforced. Each Zone is governed by its unique set of Rules tailored to its particular function or purpose. +- Resource Consent: Consents are agreements associated with the use of Resources within Zones. By resources, we mean Digital Resources (e.g. datasets) or Digital Services. It goes beyond simple approval and encompasses the permissions and restrictions on resource owners' access, usage, sharing, management and handling of their resources. It allows parties to define boundaries and establish terms for others to interact with their digital resources. It's a crucial aspect of governance, ensuring resources are used appropriately per the relevant parties' expressed will and intentions. +- Agreement: An agreement between parties involves creating shared understanding, consent, and alignment regarding future actions or outcomes. It signifies that the involved parties voluntarily accept and adhere to the rules, obligations, and conditions outlined in the agreement. By doing so, they demonstrate their commitment to collaboration and willingness to respect the rights and responsibilities defined in the contract until its completion. + +### Properties + +#### Is governed by +> +> **IRI**: [credential-governance-text:isGovernedBy](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/isGovernedBy) +> +> **Domain**: [credential-governance-text:GovernanceTextCredential](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/GovernanceTextCredential) +> +> **Range**: [credential-governance-text:GovernanceText](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/GovernanceText) + +The Governance Text that governs a Resource in the Dataverse. + +## Classes + +This schema defines 5 classes. + +### Article +> +> **IRI**: [credential-governance-text:Article](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Article) + +#### Description + +An article of a Governance Text, which states a specific (legal) rule or principle. Articles are the smallest unit of a governance text which represents a significant rule that can be enforced. + +#### Properties + +##### Has content +> +> **IRI**: [credential-governance-text:hasContent](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasContent) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The content of a Governance Text. + +##### Has ordinal number +> +> **IRI**: [credential-governance-text:hasOrdinalNumber](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasOrdinalNumber) +> +> **Range**: [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) + +This property associates a governance component with its sequential number. + +It assigns an ordinal number as a value, starting from 1, ensuring sequential continuity within a specific domain instance. + +The format for this numbering may vary based on the domain, for instance, employing Roman numerals for section numbering. + +##### Has paragraph +> +> **IRI**: [credential-governance-text:hasParagraph](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasParagraph) +> +> **Range**: [credential-governance-text:Paragraph](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Paragraph) + +The paragraph of an article. + +##### Has title +> +> **IRI**: [credential-governance-text:hasTitle](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasTitle) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The title of a Governance Text. + +### Chapter +> +> **IRI**: [credential-governance-text:Chapter](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Chapter) + +#### Description + +A chapter of a Governance Text. + +#### Properties + +##### Has content +> +> **IRI**: [credential-governance-text:hasContent](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasContent) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The content of a Governance Text. + +##### Has ordinal number +> +> **IRI**: [credential-governance-text:hasOrdinalNumber](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasOrdinalNumber) +> +> **Range**: [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) + +This property associates a governance component with its sequential number. + +It assigns an ordinal number as a value, starting from 1, ensuring sequential continuity within a specific domain instance. + +The format for this numbering may vary based on the domain, for instance, employing Roman numerals for section numbering. + +##### Has section +> +> **IRI**: [credential-governance-text:hasSection](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasSection) +> +> **Range**: [credential-governance-text:Section](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Section) + +The section of a Governance Text. + +##### Has title +> +> **IRI**: [credential-governance-text:hasTitle](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasTitle) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The title of a Governance Text. + +### Governance text +> +> **IRI**: [credential-governance-text:GovernanceText](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/GovernanceText) + +#### Description + +Governance Text provides descriptive information about a Governance text in a "human-readable format". It gives a description in a hierarchical manner, organized into chapters, sections, and articles. This hierarchy helps to structure the governance text and makes it easier to navigate and comprehend. + +Governance Text is mostly valuable in decentralized applications and web3 interfaces where governance texts are utilized to describe and represent the rules that applies to resources, like Zone or Digital Resources. This enables users to more readily engage with the governance text, allowing them to gain a better understanding of how the text operates and the rules governing the relationship between all resources in a Zone within the Dataverse. + +Governance Text is distinct from the Governance itself expressed using logic language (e.g. [Prolog](https://en.wikipedia.org/wiki/Prolog)), but helps to understand the Governance by providing important context. + +#### Properties + +##### From governance +> +> **IRI**: [credential-governance-text:fromGovernance](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/fromGovernance) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +The Governance that a Governance Text is derived from. + +##### Has chapter +> +> **IRI**: [credential-governance-text:hasChapter](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasChapter) +> +> **Range**: [credential-governance-text:Chapter](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Chapter) + +The chapter of a governance text, which groups related sections together. + +### Paragraph +> +> **IRI**: [credential-governance-text:Paragraph](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Paragraph) + +#### Description + +A paragraph of an article, which expresses a sub-rule or sub-principle of the article. + +#### Properties + +##### Has content +> +> **IRI**: [credential-governance-text:hasContent](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasContent) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The content of a Governance Text. + +##### Has title +> +> **IRI**: [credential-governance-text:hasTitle](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasTitle) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The title of a Governance Text. + +### Section +> +> **IRI**: [credential-governance-text:Section](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Section) + +#### Description + +A section of a governance text, which groups related articles together. + +#### Properties + +##### Has article +> +> **IRI**: [credential-governance-text:hasArticle](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasArticle) +> +> **Range**: [credential-governance-text:Article](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Article) + +The article of a Governance Text. + +##### Has content +> +> **IRI**: [credential-governance-text:hasContent](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasContent) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The content of a Governance Text. + +##### Has ordinal number +> +> **IRI**: [credential-governance-text:hasOrdinalNumber](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasOrdinalNumber) +> +> **Range**: [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) + +This property associates a governance component with its sequential number. + +It assigns an ordinal number as a value, starting from 1, ensuring sequential continuity within a specific domain instance. + +The format for this numbering may vary based on the domain, for instance, employing Roman numerals for section numbering. + +##### Has title +> +> **IRI**: [credential-governance-text:hasTitle](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/hasTitle) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The title of a Governance Text. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution-order.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution-order.md new file mode 100644 index 00000000000..178fdc06437 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution-order.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 8 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Orchestration service execution order credential + +> **Name**: `credential-orchestration-service-execution-order` +> +> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/) + +## 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-orchestration-service-execution-order`: [https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/) + +## Verifiable Credential + +> **IRI**: [credential-orchestration-service-execution-order:OrchestrationServiceExecutionOrderCredential](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/OrchestrationServiceExecutionOrderCredential) + +### Description + +The Orchestration Execution Order Credential is a formal declaration that requests the execution of an orchestration, outlining specific parameters for its operation. + +In these credentials, the subject is the Orchestration Service to be executed. The issuer, acting as the principal, is the party who benefits from the execution of the service. + +These credentials function as directives for orchestrating service execution, ranging from simple data processing to complex Machine Learning workflows. They establish a standardized method for requesting and managing service execution in a decentralized and interoperable manner. + +### Properties + +#### Has execution order +> +> **IRI**: [credential-orchestration-service-execution-order:hasExecutionOrder](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/hasExecutionOrder) +> +> **Domain**: [credential-orchestration-service-execution-order:OrchestrationServiceExecutionOrderCredential](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/OrchestrationServiceExecutionOrderCredential) +> +> **Range**: [credential-orchestration-service-execution-order:OrchestrationServiceExecutionOrder](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/OrchestrationServiceExecutionOrder) + +This property links an Orchestration Service Execution Order Credential to the specific Orchestration Execution Order it pertains to. It establishes a relationship indicating that the execution of the service, as detailed in the order, is authorized or mandated by the credential. + +## Classes + +This schema defines 1 class. + +### Orchestration service execution order +> +> **IRI**: [credential-orchestration-service-execution-order:OrchestrationServiceExecutionOrder](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/OrchestrationServiceExecutionOrder) + +#### Description + +Formal representation of the order in which an orchestration should be executed. + +#### Properties + +##### In zone +> +> **IRI**: [credential-orchestration-service-execution-order:inZone](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/inZone) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +The zone in which the service should be executed. + +The zone must point to a valid zone identifier and is used to determine the governance policies that apply to the service execution. + +##### Placed on +> +> **IRI**: [credential-orchestration-service-execution-order:placedOn](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/placedOn) +> +> **Range**: [schema:Date](http://schema.org/Date), [schema:DateTime](http://schema.org/DateTime) + +The date and time when the order was placed. + +##### With parameter +> +> **IRI**: [credential-orchestration-service-execution-order:withParameter](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution-order/withParameter) +> +> **Range**: [schema:PropertyValue](http://schema.org/PropertyValue) + +A single parameter specifying a part of how the Orchestration Service should be executed, represented as a key-value object. Multiple `withParameter` properties can be used to represent multiple parameters. + +Parameters can be used to specify the input data, the output data, the computational resources, the execution environment, and other aspects of the service execution. The comprehension of the parameters is dependent on the Orchestration Service being targeted. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution.md new file mode 100644 index 00000000000..f544ca722a6 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution.md @@ -0,0 +1,122 @@ +--- +sidebar_position: 7 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Orchestration service execution credential + +> **Name**: `credential-orchestration-service-execution` +> +> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/) + +## 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-orchestration-service-execution`: [https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/) + +## Verifiable Credential + +> **IRI**: [credential-orchestration-service-execution:OrchestrationServiceExecutionCredential](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecutionCredential) + +### Description + +A credential that provides proof of the execution of an Orchestration Service for a considered Orchestration Service Execution Order. It includes details of all the resources involved (consumed and produced), the time and date of execution, the parameters used, and any outcomes or results relevant to the execution. + +In these credentials, the Orchestration service is both the subject and the issuer. + +This credential is fundamental in providing a formal record of the execution of a digital service, which can be used for auditing, verification, and other purposes. + +### Properties + +#### Has execution result +> +> **IRI**: [credential-orchestration-service-execution:hasExecution](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasExecution) +> +> **Domain**: [credential-orchestration-service-execution:OrchestrationServiceExecutionCredential](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecutionCredential) +> +> **Range**: [credential-orchestration-service-execution:OrchestrationServiceExecution](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecution) + +The execution of the Orchestration Service. + +## Classes + +This schema defines 1 class. + +### Orchestration service execution +> +> **IRI**: [credential-orchestration-service-execution:OrchestrationServiceExecution](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecution) + +#### Description + +Captures the details of the progress and outcomes of the execution of an Orchestration Service. + +#### Properties + +##### Execution of +> +> **IRI**: [credential-orchestration-service-execution:executionOf](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/executionOf) +> +> **Range**: [credential-orchestration-service-execution:OrchestrationServiceExecutionOrder](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecutionOrder) + +This relationship is pivotal for associating the formal execution request with the corresponding credential, providing the necessary authorization and detailed directives for service execution. This ensures a verifiable and formalized process for initiating and tracking the execution of orchestration services. + +##### Has consumed resource +> +> **IRI**: [credential-orchestration-service-execution:hasConsumedResource](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasConsumedResource) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +Specifies a resource consumed during this Orchestration Service Execution. The resource can be any URI denoting a Digital Resource (such as a dataset), or a Digital Service (such as a Storage Service or a Processing Service). + +Multiple instances of `hasConsumedResource` can represent various resources consumed during the execution. Accessing a Digital Resource may require the use of multiple Digital Services, reflecting the complexity and interdependencies of digital service orchestration. + +##### Has execution evidence +> +> **IRI**: [credential-orchestration-service-execution:hasExecutionEvidence](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasExecutionEvidence) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +Links the Orchestration Service Execution to a resource that provides evidence of the execution, such as logs, transaction records, or other forms of auditable data. This evidence supports the verification of the execution's integrity, completeness, and compliance with the specified execution parameters and governance rules of all the involved resources within the Zone. + +The evidence resource can be a URI pointing to a secure, immutable and verifiable location where the evidence is stored, like IPFS, a blockchain, or an immutable database. + +##### Has execution status +> +> **IRI**: [credential-orchestration-service-execution:hasExecutionStatus](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasExecutionStatus) +> +> **Range**: [ns1:digital-service-execution-status](https://w3id.org/axone/ontology/v4/thesaurus/digital-service-execution-status) + +Indicates the status of the service execution. + +##### Has execution time +> +> **IRI**: [credential-orchestration-service-execution:hasExecutionTime](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasExecutionTime) +> +> **Range**: [schema:DateTime](http://schema.org/DateTime) + +The time and date when the Digital Service was executed. + +##### Has produced resource +> +> **IRI**: [credential-orchestration-service-execution:hasProducedResource](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/hasProducedResource) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +Specify a resource produced during this Orchestration Service Execution, if any. The resource can be any URI denoting a Digital Resource (such as a dataset), or a Digital Service (such as a Storage Service or a Processing Service). + +##### Part of execution +> +> **IRI**: [credential-orchestration-service-execution:partOfExecution](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/partOfExecution) +> +> **Range**: [credential-orchestration-service-execution:OrchestrationServiceExecution](https://w3id.org/axone/ontology/v4/schema/credential/orchestration-service/execution/OrchestrationServiceExecution) + +Links an Orchestration Service Execution to its parent Orchestration Service Execution, if any. + +This property establishes a hierarchical relationship between executions, enabling the tracking of complex orchestration services composed of multiple, nested sub-executions. It enables the understanding the structure and progress of workflows that involve sequential or parallel steps. diff --git a/ontology_versioned_docs/version-v4.0.0/schemas/credential-zone-description.md b/ontology_versioned_docs/version-v4.0.0/schemas/credential-zone-description.md new file mode 100644 index 00000000000..3a5622a0af7 --- /dev/null +++ b/ontology_versioned_docs/version-v4.0.0/schemas/credential-zone-description.md @@ -0,0 +1,115 @@ +--- +sidebar_position: 9 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# Zone description credential + +> **Name**: `credential-zone-description` +> +> **Namespace**: [https://w3id.org/axone/ontology/v4/schema/credential/zone/description/](https://w3id.org/axone/ontology/v4/schema/credential/zone/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-zone-description`: [https://w3id.org/axone/ontology/v4/schema/credential/zone/description/](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/) + +## Verifiable Credential + +> **IRI**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) + +### Description + +Zone Description credentials deliver an extensive overview of the essential information about a zone. This typically comprises details like the zone's title, description, and tags. + +The primary objective of these credentials is to provide a broad overview of the zone, facilitating users' comprehension of its purpose and potential use cases. + +### Examples + +```json title="collab-ai-zone-description.jsonld" +{ + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/axone/ontology/v4/schema/credential/zone/description/" + ], + "type": ["VerifiableCredential","ZoneDescriptionCredential"], + "id": "https://w3id.org/axone/ontology/v4/schema/credential/zone/description/7f547e63-ceb8-4ff3-8e2e-7a4278d97b8e", + "credentialSubject": { + "id": "did:key:zQ3shunN7us5oKNYKKzprW8nP5HAoTf4t2Fxyudho5zMAR1PQ", + "hasDescription": "Collaborative AI Zone is dedicated to train AI models in a collaborative and open way.", + "hasTag": [ + "AI", + "Collaboration", + "Machine Learning" + ], + "hasTitle": "Collaborative AI Zone", + "hasTopic": "https://w3id.org/axone/ontology/v4/thesaurus/topic/other" + }, + "issuanceDate": "2024-02-02T15:40:43.475304+01:00", + "issuer": { + "id": "did:key:zQ3shs7auhJSmVJpiUbQWco6bxxEhSqWnVEPvaBHBRvBKw6Q3", + "name": "OKP4" + } +} + +``` + +### Properties + +#### Has description +> +> **IRI**: [credential-zone-description:hasDescription](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/hasDescription) +> +> **Domain**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +A description of the Zone. + +#### Has image +> +> **IRI**: [credential-zone-description:hasImage](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/hasImage) +> +> **Domain**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) +> +> **Range**: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +The image associated with the Zone. + +#### Has tag +> +> **IRI**: [credential-zone-description:hasTag](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/hasTag) +> +> **Domain**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +A (free) keyword or term assigned to the Zone. + +#### Has title +> +> **IRI**: [credential-zone-description:hasTitle](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/hasTitle) +> +> **Domain**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) +> +> **Range**: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +The title of the Zone. + +#### Has topic +> +> **IRI**: [credential-zone-description:hasTopic](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/hasTopic) +> +> **Domain**: [credential-zone-description:ZoneDescriptionCredential](https://w3id.org/axone/ontology/v4/schema/credential/zone/description/ZoneDescriptionCredential) +> +> **Range**: [thesaurus:topic](https://w3id.org/axone/ontology/v4/thesaurus/topic) + +A topic of the Zone. diff --git a/ontology_versioned_sidebars/version-v4.0.0-sidebars.json b/ontology_versioned_sidebars/version-v4.0.0-sidebars.json new file mode 100644 index 00000000000..cff0c94e170 --- /dev/null +++ b/ontology_versioned_sidebars/version-v4.0.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/ontology_versions.json b/ontology_versions.json index 0fc63c34ffd..a275b114aeb 100644 --- a/ontology_versions.json +++ b/ontology_versions.json @@ -1,3 +1,4 @@ [ + "v4.0.0", "v3.0.0" ]