Skip to content

docs(bigquery): fix inverted and factually outdated Javadocs - #15118

Merged
lqiu96 merged 1 commit into
googleapis:mainfrom
lqiu96:docs/bq-0c-fix-factual-javadocs
Nov 20, 2026
Merged

lqiu96 merged 1 commit into
googleapis:mainfrom
lqiu96:docs/bq-0c-fix-factual-javadocs

Conversation

@lqiu96

@lqiu96 lqiu96 commented Nov 20, 2026

Copy link
Copy Markdown
Member

Fixes seven inverted or factually outdated Javadocs across java-bigquery (documentation and comment changes only, with no behavioral or API signature changes):

  • InsertAllResponse.hasErrors(): Javadoc was inverted (stated true when no row failed, while the implementation returns !insertErrors.isEmpty()).
  • LoadConfiguration.ignoreUnknownValues() / setIgnoreUnknownValues(): Fixed duplicated If {@code true} typo on the getter (the second branch is false, matching the builder) and clarified Defaults to {@code false} on both.
  • DatasetInfo: Removed outdated claim that access cannot be controlled at the table level (BigQuery exposes table-level IAM methods) and added a link to Control access to resources with IAM.
  • TableInfo.setLabels() / getLabels(): Removed outdated "labels are experimental" text (matching DatasetInfo, leaving @BetaApi annotations untouched) and added a link to Introduction to labels.
  • QueryParameterValue: Replaced outdated "Struct parameters are currently not supported" with @link pointers to array(...) and struct(Map), which are implemented in the same class.
  • Range: Fixed [DATE, TIME, TIMESTAMP] to [DATE, DATETIME, TIMESTAMP] (matching line 86 and BigQuery SQL) and added links to BigQuery Range type.
  • BigQuery.query(): Removed obsolete QUERY_PREVIEW_ENABLED environment variable docs (removed in Release v0.67.0 #3804 / commit 8fab9f2ef4a3 when JobCreationMode reached GA).

Verification

  • Verified fmt:check, checkstyle:check@checkstyle, test-compile, and javadoc -Xdoclint:syntax,html,reference.
  • Verified all linked documentation URLs return HTTP 200.

Fix seven inverted or factually outdated Javadocs across java-bigquery:
- InsertAllResponse.hasErrors(): fix inverted boolean documentation (!insertErrors.isEmpty()).
- LoadConfiguration.ignoreUnknownValues() / setIgnoreUnknownValues(): fix duplicated 'If true' typo and clarify default is false.
- DatasetInfo: replace outdated 'cannot control access at the table level' claim with table/view access note and IAM docs link.
- TableInfo.setLabels() / getLabels(): remove outdated 'labels are experimental' wording (leaving @BetaApi unchanged) and add labels docs link.
- QueryParameterValue: replace 'Struct parameters are currently not supported' with links to array() and struct().
- Range: fix [DATE, TIME, TIMESTAMP] to [DATE, DATETIME, TIMESTAMP] and add Range type docs links.
- BigQuery.query(): remove obsolete QUERY_PREVIEW_ENABLED docs (removed in googleapis#3804 / 8fab9f2).

Verified with fmt:check, checkstyle:check@checkstyle, test-compile, and javadoc -Xdoclint:syntax,html,reference.
@lqiu96
lqiu96 requested review from a team as code owners November 20, 2026 22:33

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates and corrects the Javadoc documentation across several classes in the google-cloud-bigquery library. Key updates include removing outdated references to experimental features (such as query preview features and table labels), correcting documentation typos (such as fixing the description of InsertAllResponse.hasErrors() and LoadConfiguration's unknown values handling), updating supported types for Range (correcting TIME to DATETIME), and adding helpful links to official Google Cloud documentation. There are no review comments to address, and we have no additional feedback to provide.

@lqiu96
lqiu96 merged commit 7fca6aa into googleapis:main Nov 20, 2026
198 checks passed
lqiu96 added a commit that referenced this pull request Nov 21, 2026
Updates 157 malformed, legacy, and broken-anchor documentation URLs
across 33 files in `java-bigquery` (Javadoc and comment-only, no
behavioral changes).

### Summary of changes

- Fix malformed `hhttps://` URL in `ExternalTableDefinition.java`.
- Replace pre-`/docs/` `cloud.google.com/bigquery/...` links (which no
longer resolve to canonical documentation pages or drop section anchors)
with canonical `https://docs.cloud.google.com/bigquery/...` destinations
and exact section anchors (for example, `quotas#query_jobs`,
`sessions#create-session`, `adding-labels#adding_dataset_labels`, and
`biglake-intro#metadata_caching_for_performance`).
- Update legacy `/docs/reference/v2/...` URLs and broken camelCase
anchors to `/docs/reference/rest/v2/...` with live REST schema, field,
and enum anchors (including pointing `JobInfo` and `BigQuery.JobField`
to `/rest/v2/Job`, `LoadConfiguration.setFormatOptions` to
`Job#JobConfigurationLoad.FIELDS.source_format`,
`ExternalTableDefinition` and `CopyJobConfiguration` to exact
`.FIELDS.*` anchors, `RoutineInfo` to `#routinetype` and
`#datagovernancetype`, and `BigQuery.TableMetadataView`'s link label to
`TableMetadataView`).
- Fix wrong-topic links for `TableDefinition.Type.MATERIALIZED_VIEW`
(`materialized-views-intro`), `ModelTableDefinition`, and
`TableDefinition.Type.MODEL` (`bqml-introduction`).
- Replace the legacy `developers.google.com` Discovery Javadoc link in
`BigQueryDryRunResult.java` with the canonical REST
`Job#JobStatistics2.FIELDS.undeclared_query_parameters` anchor.
- Update broken `cloud.google.com/bigquery/pricing#storage` and
`#long-term-storage` anchors to `#storage-pricing`.
- Migrate remaining `cloud.google.com/bigquery/docs/...` and
`cloud.google.com/iam/docs/...` links to `docs.cloud.google.com`.

Note: Four lines currently touched by open PRs #15117 and #15118 are
skipped here to avoid merge conflicts (`DatasetInfo.java:41` will be
updated in a follow-up after #15118 merges). Historical GitHub issue
comments are preserved.

### Verification

- Every unique target URL (71/71) verified live with HTTP 200, 0
redirects, and matching HTML `id=` anchors where fragments are present
- `mvn -pl java-bigquery/google-cloud-bigquery
com.spotify.fmt:fmt-maven-plugin:check -Dlint
checkstyle:check@checkstyle test-compile` (0 Checkstyle violations)
- `javadoc -Xdoclint:syntax,html,reference` on all 33 modified files (0
warnings/errors)
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