Skip to content

♻️ Rename "metadata" field in SubmitClaims struct to "claims" #580

Closed
@ccamel

Description

@ccamel

Proposal

The SubmitClaims struct currently has a field named metadata. This name might be misleading as it conveys the idea of a data about data, which is not the quite the case for this action.

    SubmitClaims {
        /// The serialized metadata intended for attachment.
        /// This metadata should adhere to the format specified in the `format` field.
        metadata: Binary,
        /// RDF dataset serialization format for the metadata.
        /// If not provided, the default format is [N-Quads](https://www.w3.org/TR/n-quads/) format.
        format: Option<RdfDatasetFormat>,
    },

Proposal

For clarity and precision, I propose to rename the metadata field to claims as a claim refers to a piece of information about an entity (such as a user, a service) that can be provided by one party and is potentially verifiable.

Impact

  • positive: this change will make the code more readable and self-explanatory
  • negative: this change introduces a breaking-change in the contract
  • neutral: none

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions