feat(common): Add utoipa attribute macro types #1924
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR adds OpenAPI schema generation capabilities by implementing the utoipa::ToSchema derive macro across multiple common types and models in the Shuttle platform.
- Changed response body type in
backends/src/metrics.rsfromBoxBodytoUnsyncBoxBody<bytes::Bytes, axum::Error>, which may impact response processing - Missing
ToSchemaderive macro onDeleteCertificateRequestincommon/src/certificate.rswhile other similar structs have it added - Added
utoipacrate v5 withchronofeature as a non-optional dependency incommon/Cargo.toml, affecting all builds regardless of feature flags
💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!
9 file(s) reviewed, 6 comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the provided information, I'll summarize the key changes in this PR, focusing only on new changes not mentioned in the previous review:
Added utoipa types for OpenAPI schema generation in the Shuttle platform's control layer:
- Updated MSRV from 1.78.0 to 1.81.0 in
.circleci/config.ymlto support new utoipa features - Added utoipa v5 with chrono feature for OpenAPI schema generation in
common/src/lib.rs - Changed Docker image version to
cimg/rust:1.81.0for CI builds
Note: I've kept this summary brief and focused only on the most recent changes not covered in the previous review, as requested.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
5867939 to
fccaf8b
Compare
There was a problem hiding this comment.
PR Summary
Based on the provided information, I'll summarize the key changes in this PR, focusing only on new changes not mentioned in the previous reviews:
Added OpenAPI schema generation support in the Shuttle platform's models:
- Added
ToSchemaderive macro to deployment-related types incommon/src/models/deployment.rsincludingDeploymentRequestBetaandBuildArgsBeta - Inconsistent
ToSchemaderive placement incommon/src/models/user.rswhereAccountTierhas it after other attributes - Missing
ToSchemaderive on core resource types incommon/src/resource.rslikeProvisionResourceRequestandShuttleResourceOutput<T>
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
10 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
fccaf8b to
0c9cd22
Compare
There was a problem hiding this comment.
PR Summary
Based on the provided information, I'll summarize only the new changes not mentioned in previous reviews:
Added OpenAPI schema generation support in the Shuttle platform's models:
- Added
ToSchemaderive macro to project-related types incommon/src/models/project.rsforProjectResponseBetaandProjectListResponseBeta - Added
ToSchemato logging types incommon/src/log.rsforLogItemBetaandLogsResponseBeta - Added
ToSchemato certificate types incommon/src/certificate.rsforAddCertificateRequestandCertificateResponse
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
9 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
0c9cd22 to
debd5a4
Compare
There was a problem hiding this comment.
PR Summary
Based on the provided information, I'll summarize only the new changes not mentioned in previous reviews:
Added OpenAPI schema generation support in the Shuttle platform:
- Added
typeshare::typeshareattribute to certificate types incommon/src/certificate.rsfor cross-language type sharing - Added
typeshare::typeshareto deployment state types incommon/src/deployment.rsforDeploymentStateBeta - Updated rust-version to "1.78" in
common/Cargo.tomlas the base MSRV for Shuttle crates
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
9 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the provided information, I'll summarize only the new changes not mentioned in previous reviews:
Increased test stability in permit integration tests:
- Doubled sleep duration after team creation in
backends/tests/integration/permit_tests.rsfromSLEEPtoSLEEP * 2to fix race condition - Added
DatabaseInfoBetastruct incommon/src/lib.rswithtypeshare::typeshareattribute for cross-language type sharing - Added
ToSchemaderive to database types incommon/src/lib.rsfor OpenAPI schema generation
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
04c5fda to
aa7bd7a
Compare
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the provided information, I'll summarize the latest changes not mentioned in previous reviews:
Further increased test stability in permit integration tests:
- Increased sleep duration after team creation in
backends/tests/integration/permit_tests.rsfromSLEEP * 2toSLEEP * 4(2000ms) to address race conditions - Added
DatabaseInfoBetaDebug implementation incommon/src/lib.rsto prevent password leakage in debug output - Added
ToSchemaderive toDatabaseInfoBetastruct for OpenAPI schema generation
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
aa7bd7a to
cdfb197
Compare
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the provided information, I'll summarize only the most recent changes not mentioned in previous reviews:
Added OpenAPI schema generation support in the Shuttle platform:
- Updated MSRV from 1.78 to 1.81 in
common/Cargo.tomlto support new utoipa features - Added
utoipav5 with chrono feature as a non-optional dependency incommon/Cargo.toml - Removed permit test stability changes as they're being addressed in another branch
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, as requested.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
28e195d to
830fbd1
Compare
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the recent changes not mentioned in previous reviews, here's a focused summary of the key updates:
Made utoipa an optional dependency with feature flag support:
- Changed utoipa to be an optional dependency in
common/Cargo.tomlwithversion = "5", features = ["chrono"] - Added conditional
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]across model structs - Removed direct utoipa imports in favor of feature-gated usage
Note: I've kept this summary brief and focused only on the most recent changes not covered in previous reviews, highlighting just the most important aspects of making utoipa optional.
8 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the recent changes not mentioned in previous reviews, here's a focused summary:
Made utoipa integration more robust with feature flag improvements:
- Added
utoipafeature flag tocommon/Cargo.tomlto control schema generation - Consistently applied conditional
cfg_attrforToSchemaacross all model types - Ensured
DeleteCertificateRequestincertificate.rshas proper schema generation support
8 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the provided files and previous reviews, I'll focus on the most recent changes not yet mentioned:
Added OpenAPI schema generation support with improved type sharing:
- Added
typeshare::typesharetoDatabaseInfoBetaincommon/src/lib.rsfor consistent cross-language type definitions - Added
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]toCertificateListResponseincommon/src/certificate.rs - Improved feature flag organization in
common/Cargo.tomlby grouping utoipa with related optional dependencies
Note: This summary focuses only on the latest changes not covered in previous reviews, maintaining brevity and specificity.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
d81ddcb to
3c9da99
Compare
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the recent changes not mentioned in previous reviews, here's a focused summary:
Enhanced OpenAPI schema generation with improved security and type handling:
- Added conditional
ToSchemaderive toSecret<T>incommon/src/secrets.rswith careful consideration for sensitive data exposure - Ensured consistent feature flag usage across all model types with
cfg_attr(feature = "utoipa") - Added proper schema generation support for resource-related types in
common/src/resource.rs
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, highlighting just the key security and consistency improvements.
9 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
3c9da99 to
dabc0da
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary:
Added OpenAPI schema generation with improved type consistency:
- Added
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]toResourceTypeBetaincommon/src/resource.rsfor consistent API documentation - Improved feature flag handling in
common/src/models/user.rsby placingToSchemaderive before other attributes - Added missing format metadata for date-time fields in
CertificateResponsefor better OpenAPI schema accuracy
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -74,6 +75,7 @@ service = ["chrono/serde", "display", "tracing", "tracing-subscriber", "uuid"] | |||
| test-utils = ["wiremock"] | |||
| tonic = ["dep:tonic"] | |||
| tracing = ["dep:tracing"] | |||
| utoipa = ["dep:utoipa"] | |||
There was a problem hiding this comment.
logic: utoipa feature only enables the dependency but doesn't include chrono feature which may be needed for the chrono integration
fussybeaver
force-pushed
the
ND/utoipa
branch
3 times, most recently
from
763f3f3 to
557167c
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type definitions:
- Added
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]toLogsResponseBetaincommon/src/log.rsfor consistent API documentation - Added
typeshare::typeshareattribute toDeploymentStateBetaincommon/src/deployment.rsfor cross-language type sharing - Updated MSRV to 1.81.0 in
.circleci/config.ymlto support new utoipa features
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
| #[serde(tag = "type", content = "content")] | ||
| #[typeshare::typeshare] |
There was a problem hiding this comment.
style: The serde tag/content attributes should be documented in the OpenAPI schema to make the serialization format clear to API consumers.
| #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] | ||
| pub struct Secret<T: Zeroize>(T); |
There was a problem hiding this comment.
logic: Ensure utoipa schema generation does not expose sensitive data in API docs. Consider adding schema customization to mask/redact the inner value.
fussybeaver
force-pushed
the
ND/utoipa
branch
2 times, most recently
from
41db531 to
4fbc7f2
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type handling:
- Added
ToSchemaderive toProjectUpdateRequestBetaincommon/src/models/project.rsfor consistent API documentation - Added proper schema generation for
ProvisionResourceRequestincommon/src/resource.rswith feature-gated attributes - Improved security handling in
common/src/secrets.rsby ensuringSecret<T>schema generation respects redaction
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -318,6 +324,7 @@ pub enum BuildArgsBeta { | |||
| } | |||
|
|
|||
| #[derive(Deserialize, Serialize)] | |||
| #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] | |||
| #[typeshare::typeshare] | |||
| pub struct BuildArgsRustBeta { | |||
| /// Version of shuttle-runtime used by this crate | |||
There was a problem hiding this comment.
style: These fields should have example values in their doc comments to help API consumers understand the expected format.
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type definitions:
- Added
ToSchemaderive toComputeTierincommon/src/models/project.rsfor consistent API schema generation - Added proper schema generation for
BuildMetaBetaincommon/src/models/deployment.rswith Git metadata support - Added
ToSchemaderive toSubscriptionTypeincommon/src/models/user.rsfor API documentation completeness
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -6,7 +6,7 @@ license.workspace = true | |||
| repository.workspace = true | |||
| description = "Common library for the shuttle platform (https://www.shuttle.rs/)" | |||
| # Base MSRV for the Shuttle crates. If some other crate has a higher MSRV, set it in that crate. | |||
| rust-version = "1.78" | |||
| rust-version = "1.81" | |||
There was a problem hiding this comment.
logic: rust-version was decreased from 1.78 to 1.81 - this appears to be a typo since 1.81 is lower than 1.78
fussybeaver
force-pushed
the
ND/utoipa
branch
from
4fbc7f2 to
b658ac4
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type handling:
- Added
ToSchemaderive toDeploymentRequestImageBetaincommon/src/models/deployment.rsfor container image request documentation - Added proper schema generation for
ResourceListResponseBetaincommon/src/resource.rsfor consistent API responses - Added
ToSchemaderive toSecretStoreincommon/src/secrets.rsfor secure secrets management documentation
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
2 times, most recently
from
e7c37ad to
5c1a2d6
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type consistency:
- Added
ToSchemaderive toBackendenum incommon/src/log.rsfor complete logging system documentation - Added proper schema generation for
DeploymentRequestBuildArchiveBetaincommon/src/models/deployment.rswith build configuration support - Improved attribute placement consistency in
common/src/models/user.rsby standardizingToSchemaderive order
Note: I've focused only on the most recent changes not covered in previous reviews, keeping it concise and specific to 3 points as requested.
11 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
PR Summary
Error: Error in underlying LLM call. Please try again.
10 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
fussybeaver
force-pushed
the
ND/utoipa
branch
from
5c1a2d6 to
abeef05
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type definitions:
- Added
ToSchemaderive toLogsRangeenum incommon/src/log.rsfor complete API documentation of log filtering options - Added proper schema generation for
BuildArgsRustBetaincommon/src/models/deployment.rswith Rust-specific build configuration support - Added missing
ToSchemaderive toDeleteCertificateRequestincommon/src/certificate.rsfor API consistency
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, maintaining brevity and specificity with exactly 3 points as requested.
10 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] | ||
| #[typeshare::typeshare] |
There was a problem hiding this comment.
style: Consider adding OpenAPI description attributes to document the purpose of this response type for API consumers
fussybeaver
force-pushed
the
ND/utoipa
branch
from
abeef05 to
c9dd6a5
Compare
There was a problem hiding this comment.
PR Summary
Based on the recent changes not mentioned in previous reviews, I'll provide a focused summary of the latest updates:
Enhanced OpenAPI schema generation with improved type handling:
- Added
ToSchemaderive toResourceInputandResourceInputBetaincommon/src/resource.rsfor proper deserialization documentation - Added proper schema generation for
ShuttleResourceOutput<T>incommon/src/resource.rswith generic type support - Added
ToSchemaderive toAccountTierincommon/src/models/user.rswith proper serialization attributes
Note: I've kept this summary focused only on the most recent changes not covered in previous reviews, maintaining brevity and specificity with exactly 3 points as requested.
10 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
Description of change
Adds utoipa types for the control layer in the new platform.
Used so that we can generate openapi types from code.
How has this been tested? (if applicable)