diff --git a/ontology/schemas/credential-governance-text.md b/ontology/schemas/credential-governance-text.md index 8f82bb01d79..c948493bef7 100644 --- a/ontology/schemas/credential-governance-text.md +++ b/ontology/schemas/credential-governance-text.md @@ -1,8 +1,7 @@ --- sidebar_position: 6 --- - -[//]: # 'This file is auto-generated. Please do not modify it yourself.' +[//]: # (This file is auto-generated. Please do not modify it yourself.) # Governance description credential @@ -32,14 +31,14 @@ Governance Text Credential is a type of Credential that attests to descriptive i 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. +- 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) @@ -53,7 +52,7 @@ The Governance Text that governs a Resource in the Dataverse. This schema defines 5 classes. ### Article - +> > **IRI**: [credential-governance-text:Article](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Article) #### Description @@ -63,7 +62,7 @@ An article of a Governance Text, which states a specific (legal) rule or princip #### 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) @@ -71,7 +70,7 @@ An article of a Governance Text, which states a specific (legal) rule or princip 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) @@ -83,7 +82,7 @@ It assigns an ordinal number as a value, starting from 1, ensuring sequential co 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) @@ -91,7 +90,7 @@ The format for this numbering may vary based on the domain, for instance, employ 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) @@ -99,7 +98,7 @@ The paragraph of an article. The title of a Governance Text. ### Chapter - +> > **IRI**: [credential-governance-text:Chapter](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Chapter) #### Description @@ -109,7 +108,7 @@ 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) @@ -117,7 +116,7 @@ A chapter of a Governance Text. 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) @@ -129,7 +128,7 @@ It assigns an ordinal number as a value, starting from 1, ensuring sequential co 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) @@ -137,7 +136,7 @@ The format for this numbering may vary based on the domain, for instance, employ 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) @@ -145,21 +144,21 @@ The section of a Governance Text. 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 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) @@ -167,7 +166,7 @@ Governance Text is distinct from the Governance itself expressed using logic lan 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) @@ -175,7 +174,7 @@ The Governance that a Governance Text is derived from. 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 @@ -185,7 +184,7 @@ A paragraph of an article, which expresses a sub-rule or sub-principle of the ar #### 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) @@ -193,7 +192,7 @@ A paragraph of an article, which expresses a sub-rule or sub-principle of the ar 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) @@ -201,7 +200,7 @@ The content of a Governance Text. The title of a Governance Text. ### Section - +> > **IRI**: [credential-governance-text:Section](https://w3id.org/axone/ontology/v4/schema/credential/governance/text/Section) #### Description @@ -211,7 +210,7 @@ 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) @@ -219,7 +218,7 @@ A section of a governance text, which groups related articles together. 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) @@ -227,7 +226,7 @@ The article of a Governance Text. 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) @@ -239,7 +238,7 @@ It assigns an ordinal number as a value, starting from 1, ensuring sequential co 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) diff --git a/ontology/schemas/credential-orchestration-service-execution.md b/ontology/schemas/credential-orchestration-service-execution.md index 633381b1dac..f544ca722a6 100644 --- a/ontology/schemas/credential-orchestration-service-execution.md +++ b/ontology/schemas/credential-orchestration-service-execution.md @@ -1,8 +1,7 @@ --- sidebar_position: 7 --- - -[//]: # 'This file is auto-generated. Please do not modify it yourself.' +[//]: # (This file is auto-generated. Please do not modify it yourself.) # Orchestration service execution credential @@ -37,7 +36,7 @@ This credential is fundamental in providing a formal record of the execution of ### 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) @@ -51,7 +50,7 @@ The execution of the Orchestration Service. 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 @@ -61,7 +60,7 @@ Captures the details of the progress and outcomes of the execution of an Orchest #### 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) @@ -69,7 +68,7 @@ Captures the details of the progress and outcomes of the execution of an Orchest 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) @@ -79,17 +78,17 @@ Specifies a resource consumed during this Orchestration Service Execution. The r 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. +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) @@ -97,7 +96,7 @@ The evidence resource can be a URI pointing to a secure, immutable and verifiabl 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) @@ -105,7 +104,7 @@ Indicates the status of the service execution. 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) @@ -113,7 +112,7 @@ The time and date when the Digital Service was executed. 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) diff --git a/ontology/schemas/credential-zone-description.md b/ontology/schemas/credential-zone-description.md index 35395a85c8e..3a5622a0af7 100644 --- a/ontology/schemas/credential-zone-description.md +++ b/ontology/schemas/credential-zone-description.md @@ -1,8 +1,7 @@ --- sidebar_position: 9 --- - -[//]: # 'This file is auto-generated. Please do not modify it yourself.' +[//]: # (This file is auto-generated. Please do not modify it yourself.) # Zone description credential @@ -37,41 +36,46 @@ The primary objective of these credentials is to provide a broad overview of the ```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" - } + "@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. +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) @@ -81,7 +85,7 @@ A description of the zone. 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) @@ -91,21 +95,21 @@ The image associated with the Zone. 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. +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. +A topic of the Zone.