Skip to content

Commit

Permalink
feat: update schema files
Browse files Browse the repository at this point in the history
  • Loading branch information
@bot-anik
bot-anik committed Nov 15, 2023
1 parent 8e912d5 commit cdf2f12
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 146 deletions.
125 changes: 33 additions & 92 deletions schema/okp4-dataverse/execute.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"oneOf": [
{
"title": "RegisterService",
"description": "Registers a new service within the dataverse. Service is a generic concept for any kind of service that can be provided through a network (e.g. a REST API, a gRPC service, etc.).\n\nEach service is identified and located by its unique URI which defines the entry point of the service.\n\n#### Examples:\n\n```rust ExecuteMsg::RegisterService { subject: \"https://ontology.okp4.space/dataverse/service/metadata/52549532-887d-409b-a9c0-fb68f9e521d2\", identity: \"did:key:z6MkrpCPVDHcsqi3aaqnemLC1aBTUwkfPwTyzc8sFWYwm1PA\", identifier: \"urn:uuid:803cd033-2eed-4db7-847b-f46715a42a70\" } ```",
"description": "Registers a new Service within the dataverse.\n\nThe term 'Service' in this context is employed to denote any form of service that is accessible over a network. This encompasses, but is not limited to, services such as REST APIs, gRPC services, and similar network-based services.\n\nA fundamental characteristic of each service is its unique Uniform Resource Identifier (URI), which serves as the definitive entry point for accessing the service. This URI is pivotal in the identification and location of the service within the network.",
"type": "object",
"required": [
"register_service"
Expand All @@ -15,16 +15,15 @@
"type": "object",
"required": [
"identifier",
"identity",
"subject"
"identity"
],
"properties": {
"identifier": {
"description": "The unique URI that identifies and locates the service.\n\nThe URI serves a dual purpose: 1. **Identification**: It provides a unique identifier for the service, ensuring that each service can be distinctly recognized within the dataverse. 2. **Endpoint**: The URI acts as the access point or endpoint for the service. It specifies where the service can be accessed and how interactions with the service should be initiated.",
"description": "The URI that identifies and locates the service.\n\nThe URI serves a dual purpose: 1. **Identification**: It provides a unique identifier for the service, ensuring that each service can be distinctly recognized within the dataverse. 2. **Endpoint**: The URI acts as the access point or endpoint for the service. It specifies where the service can be accessed and how interactions with the service should be initiated.",
"type": "string"
},
"identity": {
"description": "The decentralized identity of the service.",
"description": "The decentralized identity (DID) of the service.\n\nPreconditions: - The identity must be unique within the dataverse.",
"type": "string"
},
"registrar": {
Expand All @@ -33,10 +32,6 @@
"string",
"null"
]
},
"subject": {
"description": "The unique RDF identifier for the resource representation of the service within the dataverse.",
"type": "string"
}
},
"additionalProperties": false
Expand All @@ -45,39 +40,39 @@
"additionalProperties": false
},
{
"title": "RegisterDataset",
"description": "Registers a new dataset within the dataverse.\n\nA `Dataset` represents a collection of related data that is organized and presented in a specific format by the provider. This data can be in various forms, such as CSV files, images, videos, and more. It can also refer to data sources like databases and APIs.\n\nEach dataset is uniquely identified by its URI, which serves as both the identifier and the access point for the dataset. When accessing a dataset, it's crucial to understand the protocol and methods supported by the dataset's endpoint. For instance, a dataset with an HTTP-based URI might be accessible via GET requests and may require specific headers or parameters for successful retrieval.\n\n#### Examples:\n\n```rust ExecuteMsg::RegisterDataset { subject: \"https://ontology.okp4.space/dataverse/dataset/96a562a9-5feb-4a41-bcf2-cc8610af9f78\", identifier: \"ipfs://bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4\", provided_by: \"urn:uuid:803cd033-2eed-4db7-847b-f46715a42a70\" } ```",
"title": "RegisterDigitalResource",
"description": "Registers a new digital resource within the dataverse.\n\nA Digital Resource represents a broad category encompassing various digital entities registerable in the dataverse. This category includes, but is not limited to, datasets, algorithms, machine learning models, and other digital assets.\n\nThe unique identification of each Digital Resource is achieved through a combination of its Uniform Resource Identifier (URI) and the specific service responsible for its provision. This dual-component identification mechanism guarantees the distinct recognition and operationalization of each Digital Resource within the dataverse environment.",
"type": "object",
"required": [
"register_dataset"
"register_digital_resource"
],
"properties": {
"register_dataset": {
"register_digital_resource": {
"type": "object",
"required": [
"identifier",
"provided_by",
"subject"
"identity",
"provided_by"
],
"properties": {
"identifier": {
"description": "The unique URI that identifies the dataset.",
"description": "The URI that identifies the dataset. This URI makes sense only in the context of the service that provides the resource.\n\nPreconditions: - The URI must be unique within the dataverse.",
"type": "string"
},
"identity": {
"description": "The decentralized identity (DID) of the Digital Resource.\n\nPreconditions: - The identity must be unique within the dataverse.",
"type": "string"
},
"provided_by": {
"description": "The URI of the service, already registered in the dataverse, that provides the dataset.",
"description": "The URI of the service, already registered in the dataverse, that provides the dataset.\n\nPreconditions: - The Service must be registered in the dataverse before the resource can be registered.",
"type": "string"
},
"registrar": {
"description": "The URI of the entity responsible for registering and managing the dataset in the dataverse (i.e. on the blockchain). It's an optional field, if not provided the dataset is registered by the entity that invokes the transaction.",
"description": "The URI of the entity responsible for registering and managing the resource in the dataverse (i.e. on the blockchain). It's an optional field, if not provided the dataset is registered by the entity that invokes the transaction.",
"type": [
"string",
"null"
]
},
"subject": {
"description": "The unique RDF identifier for the resource representation of the dataset within the dataverse.",
"type": "string"
}
},
"additionalProperties": false
Expand All @@ -87,7 +82,7 @@
},
{
"title": "FoundZone",
"description": "Founds a new zone within the dataverse.\n\n`Zone` is a conceptual framework that is established based on a set of rules, within which recognized digital Resources must conform, considering associated consents.\n\n#### Example\n\n``` ExecuteMsg::FoundZone { subject: \"https://ontology.okp4.space/dataverse/zone/ef347285-e52a-430d-9679-dcb76b962ce7\", identifier: \"urn:uuid:6d1aaad8-9411-4758-a9f9-ed43358af1fd\" } ```",
"description": "Founds a new zone within the dataverse.\n\n`Zone` is a conceptual framework that is established based on a set of rules, within which recognized Resources must conform, considering associated consents.",
"type": "object",
"required": [
"found_zone"
Expand All @@ -96,12 +91,11 @@
"found_zone": {
"type": "object",
"required": [
"identifier",
"subject"
"identity"
],
"properties": {
"identifier": {
"description": "The unique URI that identifies the zone.",
"identity": {
"description": "The decentralized identity (DID) of the Zone. This identity must be unique within the dataverse.",
"type": "string"
},
"registrar": {
Expand All @@ -110,10 +104,6 @@
"string",
"null"
]
},
"subject": {
"description": "The unique RDF identifier for the resource representation of the zone within the dataverse.",
"type": "string"
}
},
"additionalProperties": false
Expand All @@ -122,18 +112,17 @@
"additionalProperties": false
},
{
"title": "AttachMetadata",
"description": "Attaches metadata to a specified resource registered in the dataverse.\n\nMetadata provides additional information or details about a resource.",
"title": "SubmitClaims",
"description": "Submits new claims about a resource to the dataverse.\n\nA claim is a statement made by an entity, the issuer (e.g. a person, an organization, or a machine) about a resource (e.g. an entity, a service, or a zone) that the issuer asserts to be true.\n\nThe claims are submitted to the dataverse in the form of Verifiable Presentations (VPs), which combine and present credentials. The data in the presentation concerns usually the same subject, but there is no limit to the number of subjects or issuers in the data.\n\nPreconditions: - The claims must be submitted in the form of Verifiable Presentations (VPs). - The subjects of the Verifiable Credentials must exist in the dataverse before the claims can be submitted. - The identifiers of the Veriable Credentials must be unique within the dataverse. - The claims must be signed by the issuer and the signature must be verifiable.",
"type": "object",
"required": [
"attach_metadata"
"submit_claims"
],
"properties": {
"attach_metadata": {
"submit_claims": {
"type": "object",
"required": [
"metadata",
"subject"
"metadata"
],
"properties": {
"format": {
Expand All @@ -154,34 +143,6 @@
"$ref": "#/definitions/Binary"
}
]
},
"subject": {
"description": "The unique RDF identifier of the resource for which the metadata should be attached.",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"title": "DetachMetadata",
"description": "Remove a previously associated metadata (from a specific resource within the dataverse). Once removed the metadata is no longer accessible.",
"type": "object",
"required": [
"detach_metadata"
],
"properties": {
"detach_metadata": {
"type": "object",
"required": [
"subject"
],
"properties": {
"subject": {
"description": "The RDF identifier of the metadata to be removed.",
"type": "string"
}
},
"additionalProperties": false
Expand All @@ -190,41 +151,21 @@
"additionalProperties": false
},
{
"title": "ReviseMetadata",
"description": "Revises a previously associated metadata in order to update it or amend it.",
"title": "RevokeClaims",
"description": "Revoke or withdraw a previously submitted claims.\n\nPreconditions: - The identifier of the claims must exist in the dataverse.",
"type": "object",
"required": [
"revise_metadata"
"revoke_claims"
],
"properties": {
"revise_metadata": {
"revoke_claims": {
"type": "object",
"required": [
"metadata",
"subject"
"identifier"
],
"properties": {
"format": {
"description": "RDF format in which the metadata is represented. If not provided, the default format is [Turtle](https://www.w3.org/TR/turtle/) format.",
"anyOf": [
{
"$ref": "#/definitions/RdfFormat"
},
{
"type": "null"
}
]
},
"metadata": {
"description": "The serialized metadata intended for revision. This metadata should adhere to the format specified in the `format` field.",
"allOf": [
{
"$ref": "#/definitions/Binary"
}
]
},
"subject": {
"description": "The RDF identifier of the metadata to be revised.",
"identifier": {
"description": "The unique identifier of the claims to be revoked.",
"type": "string"
}
},
Expand Down
2 changes: 1 addition & 1 deletion schema/okp4-dataverse/instantiate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"properties": {
"name": {
"description": "A name to give to the dataverse instantiated.",
"description": "A unique name to identify the dataverse instance.",
"type": "string"
}
},
Expand Down

0 comments on commit cdf2f12

Please sign in to comment.