Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use method for encryption method in ApiEncryptMetadata. #4589

Conversation

jonathanknowles
Copy link
Member

This PR changes the name for the encryption method field for ApiEncryptMetadata from enc to method.

Justification

  • In the context of the cardano-wallet HTTP API, it's idiomatic to use complete words instead of shortenings such as enc.
  • The name method is consistent with the field type ApiEncryptMetadataMethod.
  • The name method is (arguably) more self-documenting than enc.

Issue

ADP-322

@jonathanknowles jonathanknowles self-assigned this May 14, 2024
Base automatically changed from jonathanknowles/adp-322/simplify-api-encrypt-metadata-method to paweljakubas/adp-322/add-metadata-encryption-to-api May 14, 2024 08:39
Copy link
Contributor

@paweljakubas paweljakubas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have qualms here to be frank. See CIP I want to comply with https://github.com/cardano-foundation/CIPs/tree/master/CIP-0083#format they use enc although I agree method is probably less surprising. Nevertheless, I would advocate we are obliged to comply here @jonathanknowles

Copy link
Contributor

@paweljakubas paweljakubas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after 1-1 call we discussed it and now I am persuaded it is ok. Thanks

@jonathanknowles jonathanknowles merged commit fbfb5a7 into paweljakubas/adp-322/add-metadata-encryption-to-api May 16, 2024
2 of 3 checks passed
@jonathanknowles jonathanknowles deleted the jonathanknowles/adp-322/rename-field-for-api-encrypt-metadata-method branch May 16, 2024 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants