package cheqd.resource.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Query defines the gRPC querier service for the resource module

• rpc Resource (QueryResourceRequest, QueryResourceResponse)

  query.proto:11

  Fetch data/payload for a specific resource (without metadata)

  message QueryResourceRequest

  query.proto:24

  QueryResourceRequest is the request type for the Query/Resource RPC method

  • string collection_id = 1

    collection_id is an identifier of the DidDocument the resource belongs to. Format: <unique-identifier> Examples: - c82f2b02-bdab-4dd7-b833-3e143745d612 - wGHEXrZvJxR8vw5P3UWH1j

  • string id = 2

    id is a unique id of the resource. Format: <uuid>

  message QueryResourceResponse

  query.proto:37

  QueryResourceResponse is the response type for the Query/Resource RPC method

  • optional ResourceWithMetadata resource = 1

    Successful resolution of the resource returns the following: - resource is the requested resource - metadata is the resource metadata associated with the requested resource

• rpc ResourceMetadata (QueryResourceMetadataRequest, QueryResourceMetadataResponse)

  query.proto:15

  Fetch only metadata for a specific resource

  message QueryResourceMetadataRequest

  query.proto:44

  QueryResourceMetadataRequest is the request type for the Query/ResourceMetadata RPC method

  • string collection_id = 1

    collection_id is an identifier of the DidDocument the resource belongs to. Format: <unique-identifier> Examples: - c82f2b02-bdab-4dd7-b833-3e143745d612 - wGHEXrZvJxR8vw5P3UWH1j

  • string id = 2

    id is a unique id of the resource. Format: <uuid>

  message QueryResourceMetadataResponse

  query.proto:57

  QueryResourceMetadataResponse is the response type for the Query/ResourceMetadata RPC method

  • optional Metadata resource = 1

    resource is the requested resource metadata

• rpc CollectionResources (QueryCollectionResourcesRequest, QueryCollectionResourcesResponse)

  query.proto:19

  Fetch metadata for all resources in a collection

  message QueryCollectionResourcesRequest

  query.proto:62

  QueryCollectionResourcesRequest is the request type for the Query/CollectionResources RPC method

  • string collection_id = 1

    collection_id is an identifier of the DidDocument the resource belongs to. Format: <unique-identifier> Examples: - c82f2b02-bdab-4dd7-b833-3e143745d612 - wGHEXrZvJxR8vw5P3UWH1j

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryCollectionResourcesResponse

  query.proto:74

  QueryCollectionResourcesResponse is the response type for the Query/CollectionResources RPC method

  • repeated Metadata resources = 1

    resources is the requested collection of resource metadata

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

AlternativeUri are alternative URIs that can be used to access the Resource. By default, at least the DID URI equivalent of the Resource is populated.

Used in: Metadata

• string uri = 1

  uri is the URI of the Resource. Examples: - did:cheqd:testnet:MjYxNzYKMjYxNzYK/resources/4600ea35-8916-4ac4-b412-55b8f49dd94e - https://resolver..cheqd.net/1.0/identifiers/did:cheqd:testnet:MjYxNzYKMjYxNzYK/resources/4600ea35-8916-4ac4-b412-55b8f49dd94e - https://example.com/example.json - https://gateway.ipfs.io/ipfs/bafybeihetj2ng3d74k7t754atv2s5dk76pcqtvxls6dntef3xa6rax25xe - ipfs://bafybeihetj2ng3d74k7t754atv2s5dk76pcqtvxls6dntef3xa6rax25xe

• string description = 2

  description is a human-readable description of the URI. Defined client-side. Examples: - did-uri - http-uri - ipfs-uri

Metadata stores the metadata of a DID-Linked Resource

Used in: QueryCollectionResourcesResponse, QueryResourceMetadataResponse, ResourceWithMetadata

• string collection_id = 1

  collection_id is the ID of the collection that the Resource belongs to. Defined client-side. This field is the unique identifier of the DID linked to this Resource Format: <unique-identifier> Examples: - c82f2b02-bdab-4dd7-b833-3e143745d612 - wGHEXrZvJxR8vw5P3UWH1j

• string id = 2

  id is the ID of the Resource. Defined client-side. This field is a unique identifier for this specific version of the Resource. Format: <uuid>

• string name = 3

  name is a human-readable name for the Resource. Defined client-side. Does not change between different versions. Example: PassportSchema, EducationTrustRegistry

• string version = 4

  version is a human-readable semantic version for the Resource. Defined client-side. Stored as a string. OPTIONAL. Example: 1.0.0, v2.1.0

• string resource_type = 5

  resource_type is a Resource type that identifies what the Resource is. Defined client-side. This is NOT the same as the resource's media type. Example: AnonCredsSchema, StatusList2021

• repeated AlternativeUri also_known_as = 6

  List of alternative URIs for the SAME Resource.

• string media_type = 7

  media_type is IANA media type of the Resource. Defined ledger-side. Example: application/json, image/png

• optional google.protobuf.Timestamp created = 8

  created is the time at which the Resource was created. Defined ledger-side. Format: RFC3339 Example: 2021-01-01T00:00:00Z

• string checksum = 9

  checksum is a SHA-256 checksum hash of the Resource. Defined ledger-side. Example: d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f

• string previous_version_id = 10

  previous_version_id is the ID of the previous version of the Resource. Defined ledger-side. This is based on the Resource's name and Resource type to determine whether it's the same Resource. Format: <uuid>

• string next_version_id = 11

  next_version_id is the ID of the next version of the Resource. Defined ledger-side. This is based on the Resource's name and Resource type to determine whether it's the same Resource. Format: <uuid>

Resource stores the contents of a DID-Linked Resource

Used in: ResourceWithMetadata

• bytes data = 1

  bytes is the raw data of the Resource

ResourceWithMetadata describes the overall structure of a DID-Linked Resource

Used in: QueryResourceResponse

• optional Resource resource = 1

• optional Metadata metadata = 2