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

feat: [M3-8005] – Add disk_encryption to types & validation schemas #10413

Merged

Conversation

dwiley-akamai
Copy link
Contributor

@dwiley-akamai dwiley-akamai commented Apr 26, 2024

Description 📝

Add disk_encryption to types & validation schemas as appropriate based on the API spec (see ticket for link)

Changes 🔄

  • EncryptionStatus type added; disk_encryption field added to Linode, Disk, CreateLinodeRequest, and RebuildRequest interfaces
  • disk_encryption added to CreateLinodeSchema and RebuildLinodeSchema; it is nullable and optional, but if provided should have a value of either "enabled" or "disabled"

Note

@TODO LDE: remove optionality once LDE is fully rolled out was added as a comment to a few new properties. These are instances where, when LDE is fully rolled out, disk_encryption will always be included on that object. I think marking them as optional at this point is fair because not doing so would be premature, and also likely confuse consumers of the JS Client.

Target release date 🗓️

5/13/24

How to test 🧪

Verification steps

  • Ensure that Create Linode and Rebuild Linode functionality have not been adversely impacted (should still go through as expected with no errors related to the the disk_encryption field)
  • Confirm the changes align with the API spec

As an Author I have considered 🤔

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@dwiley-akamai dwiley-akamai added @linode/api-v4 Changes are made to the @linode/api-v4 package Linode Disk Encryption (LDE) Relating to LDE project labels Apr 26, 2024
@dwiley-akamai dwiley-akamai self-assigned this Apr 26, 2024
@dwiley-akamai dwiley-akamai force-pushed the M3-8005-types-updates-for-lde branch from d70c4f6 to 17d34d1 Compare April 26, 2024 17:42
@bnussman-akamai
Copy link
Member

Is there a justification for using enabled | disabled as compared to a boolean? It kind of breaks the Boolean pattern like private_ip, backups_enabled in the Linode Create payload

@dwiley-akamai
Copy link
Contributor Author

Is there a justification for using enabled | disabled as compared to a boolean? It kind of breaks the Boolean pattern like private_ip, backups_enabled in the Linode Create payload

I can't go into much detail here (see page 6 of the spec for more in-depth discussion on it by members of the API team), but essentially it has to do with future-proofing.

@dwiley-akamai dwiley-akamai marked this pull request as ready for review April 26, 2024 18:02
@dwiley-akamai dwiley-akamai requested a review from a team as a code owner April 26, 2024 18:02
@dwiley-akamai dwiley-akamai requested review from cpathipa and abailly-akamai and removed request for a team April 26, 2024 18:02
Copy link

Coverage Report:
Base Coverage: 81.82%
Current Coverage: 81.82%

@dwiley-akamai dwiley-akamai merged commit 13b858c into linode:develop Apr 29, 2024
18 checks passed
@dwiley-akamai dwiley-akamai deleted the M3-8005-types-updates-for-lde branch April 29, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@linode/api-v4 Changes are made to the @linode/api-v4 package Linode Disk Encryption (LDE) Relating to LDE project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants