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

BigQuery: Broken / incorrect links to REST API in reference docs #9429

Closed
tswast opened this issue Oct 8, 2019 · 0 comments · Fixed by #9436
Closed

BigQuery: Broken / incorrect links to REST API in reference docs #9429

tswast opened this issue Oct 8, 2019 · 0 comments · Fixed by #9436
Assignees
Labels
api: bigquery Issues related to the BigQuery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@tswast
Copy link
Contributor

tswast commented Oct 8, 2019

Many of the BigQuery REST docs have moved, because internally we use a new code generator for the docs. Previously, all the resource details were on a single page, such as https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs. Now the docs are split up into smaller pages by resource, for example https://cloud.google.com/bigquery/docs/reference/rest/v2/JobReference.

This issue was reported internally in issue 141542760 and 141917083.

Steps to reproduce

  1. Navigate to BigQuery reference docs.
  2. Navigate to a class, such as LoadJobConfig
  3. Click a link such as https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.autodetect
  4. Land on a page that does not include information about the desired resource property.

Proposed solution

  1. Identify all links to resources https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs, https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets, https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
  2. Update links to point to new location of the relevant type.
@tswast tswast added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. api: bigquery Issues related to the BigQuery API. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the BigQuery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants