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

refactor(robot-server,api-client): Rename GET /deck_configuration field lastUpdatedAt to lastModifiedAt #14029

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

SyntaxColoring
Copy link
Contributor

@SyntaxColoring SyntaxColoring commented Nov 20, 2023

Overview

When I added the GET /deck_configuration endpoint, I gave it a lastUpdatedAt field.

That name is accidentally inconsistent with our calibration endpoints (deck, pipette, etc.), which instead use lastModified.

This PR changes lastUpdatedAt to lastModifiedAt.

I'm deliberately keeping the At suffix because that has been an intentional naming convention of our HTTP API going forward. (Protocol Engine has createdAt, completedAt, etc.) So that's an intentional inconsistency.

Test Plan

None applicable. As far as I can tell, there's not yet any app code that reads this field.

Changelog

  • Rename the lastUpdatedAt field in GET /deck_configuration to lastModifiedAt.
  • Update the TypeScript bindings.

Review requests

None in particular.

Risk assessment

Low for now, since nothing uses this yet.

@SyntaxColoring SyntaxColoring requested review from brenthagen and a team November 20, 2023 20:30
@SyntaxColoring SyntaxColoring requested review from a team as code owners November 20, 2023 20:30
@SyntaxColoring SyntaxColoring added robot server Affects the `robot-server` project js-api-client Related to our JS robot client SDK labels Nov 20, 2023
@SyntaxColoring SyntaxColoring changed the title refactor(robot-server): Rename GET /deck_configuration field lastUpdatedAt to lastModifiedAt refactor(robot-server,api-client): Rename GET /deck_configuration field lastUpdatedAt to lastModifiedAt Nov 20, 2023
Copy link

codecov bot commented Nov 20, 2023

Codecov Report

Merging #14029 (0bb3adb) into edge (7239a53) will not change coverage.
Report is 1 commits behind head on edge.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #14029   +/-   ##
=======================================
  Coverage   70.63%   70.63%           
=======================================
  Files        2507     2507           
  Lines       70984    70984           
  Branches     8802     8802           
=======================================
  Hits        50139    50139           
  Misses      18680    18680           
  Partials     2165     2165           
Flag Coverage Δ
app 67.66% <ø> (ø)
protocol-designer 45.62% <ø> (ø)
react-api-client 65.73% <ø> (ø)
step-generation 86.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@mjhuff mjhuff left a comment

Choose a reason for hiding this comment

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

Yep, doesn't look like we're using this anywhere app side, and I can't imagine this could be an issue. LGTM!

Copy link
Collaborator

@jerader jerader left a comment

Choose a reason for hiding this comment

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

makes sense to me! thank you!

@SyntaxColoring
Copy link
Contributor Author

SyntaxColoring commented Nov 20, 2023

Will merge after #14022 to avoid a merge conflict.

@SyntaxColoring SyntaxColoring force-pushed the lastupdatedat_lastmodifiedat branch from 36f4f34 to 0bb3adb Compare November 21, 2023 15:42
@SyntaxColoring SyntaxColoring requested a review from a team as a code owner November 21, 2023 15:42
@SyntaxColoring SyntaxColoring requested a review from a team November 21, 2023 15:42
@SyntaxColoring SyntaxColoring changed the base branch from store_in_api to edge November 21, 2023 15:42
@SyntaxColoring SyntaxColoring merged commit 8bd98aa into edge Nov 21, 2023
18 checks passed
@SyntaxColoring SyntaxColoring deleted the lastupdatedat_lastmodifiedat branch November 21, 2023 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
js-api-client Related to our JS robot client SDK robot server Affects the `robot-server` project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants