Skip to content

fix: openapi docs for get object - #1350

Merged
ferhatelmas merged 1 commit into
masterfrom
ferhat/get-object-docs
Aug 31, 2026
Merged

fix: openapi docs for get object#1350
ferhatelmas merged 1 commit into
masterfrom
ferhat/get-object-docs

Conversation

@ferhatelmas

Copy link
Copy Markdown
Member

What kind of change does this PR introduce?

Bug fix

What is the current behavior?

Query params are read and handled but not exposed in openapi.

What is the new behavior?

Add query params schema and align its summaary.

Additional context

Related to #1341

Signed-off-by: Ferhat Elmas <elmas.ferhat@gmail.com>
@ferhatelmas
ferhatelmas requested a review from a team as a code owner August 31, 2026 12:22
Copilot AI lite review requested due to automatic review settings August 31, 2026 12:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good, straightforward OpenAPI documentation fix. Reviewed: the change only adds querystring: getObjectQuerySchema to the public /:bucketName/* route (matching the schema already used by the authenticated route and already consumed by the shared requestHandler), and replaces a duplicate 'Get object' string with the shared summary constant. No behavioral or validation logic changes.

Extended reasoning...

Overview

The diff touches a single file, src/http/routes/object/getObject.ts, and consists of two one-line changes inside the schema object for the public (/:bucketName/*) route registration: adding querystring: getObjectQuerySchema and replacing the literal string 'Get object' with the already-declared summary variable ('Retrieve an object').

Security risks

None. getObjectQuerySchema (properties download and versionId, both optional strings, no additionalProperties: false) was already defined and already used identically by the authenticated route in the same file. Adding it to the public route's schema is purely additive documentation/validation metadata for Fastify's OpenAPI generation — it does not restrict or loosen any existing behavior, since requestHandler (shared by both routes) already destructures download and versionId from request.query regardless of whether a query schema was declared. There is no auth, injection, or data-exposure surface introduced.

Level of scrutiny

Low. This is a mechanical, self-contained documentation alignment fix with no logic or control-flow changes, matching an existing pattern already present in the sibling authenticated route in the very same file.

Other factors

The bug hunter reported no findings, and my own reading of the full file confirms the change is limited to schema metadata with no functional impact. The PR description accurately reflects the change (aligning OpenAPI docs), and there's no CODEOWNERS restriction indicated. No outstanding review comments or third-party objections are present in the timeline.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 33391477544

Coverage decreased (-0.01%) to 81.439%

Details

  • Coverage decreased (-0.01%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 1 coverage regression across 1 file.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

1 previously-covered line in 1 file lost coverage.

File Lines Losing Coverage Coverage
src/http/routes/s3/index.ts 1 87.42%

Coverage Stats

Coverage Status
Relevant Lines: 13267
Covered Lines: 11241
Line Coverage: 84.73%
Relevant Branches: 7869
Covered Branches: 5972
Branch Coverage: 75.89%
Branches in Coverage %: Yes
Coverage Strength: 615.18 hits per line

💛 - Coveralls

@ferhatelmas
ferhatelmas merged commit b9f5d30 into master Aug 31, 2026
30 checks passed
@ferhatelmas
ferhatelmas deleted the ferhat/get-object-docs branch August 31, 2026 12:33
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.

4 participants