Skip to content

Commit 66cdc58

Browse files
author
Gurov Ilya
authored
docs(bigquery): fix incorrect links to REST API in reference docs (#9436)
fixes issue #9429
1 parent 22c0782 commit 66cdc58

8 files changed

Lines changed: 91 additions & 91 deletions

File tree

‎bigquery/google/cloud/bigquery/client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ def list_datasets(
284284
filter (str):
285285
Optional. An expression for filtering the results by label.
286286
For syntax, see
287-
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list#filter.
287+
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list#body.QUERY_PARAMETERS.filter
288288
max_results (int):
289289
Optional. Maximum number of datasets to return.
290290
page_token (str):
@@ -1320,7 +1320,7 @@ def load_table_from_uri(
13201320
"""Starts a job for loading data into a table from CloudStorage.
13211321
13221322
See
1323-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load
1323+
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationload
13241324
13251325
Arguments:
13261326
source_uris (Union[str, Sequence[str]]):
@@ -1858,7 +1858,7 @@ def copy_table(
18581858
"""Copy one or more tables to another table.
18591859
18601860
See
1861-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.copy
1861+
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationtablecopy
18621862
18631863
Arguments:
18641864
sources (Union[ \
@@ -1949,7 +1949,7 @@ def extract_table(
19491949
"""Start a job to extract a table into Cloud Storage files.
19501950
19511951
See
1952-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract
1952+
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationextract
19531953
19541954
Arguments:
19551955
source (Union[ \
@@ -2020,7 +2020,7 @@ def query(
20202020
"""Run a SQL query.
20212021
20222022
See
2023-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query
2023+
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationquery
20242024
20252025
Arguments:
20262026
query (str):

‎bigquery/google/cloud/bigquery/dataset.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ class DatasetReference(object):
207207
"""DatasetReferences are pointers to datasets.
208208
209209
See
210-
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets
210+
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference
211211
212212
Args:
213213
project (str): The ID of the project
@@ -346,7 +346,7 @@ class Dataset(object):
346346
"""Datasets are containers for tables.
347347
348348
See
349-
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets
349+
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset
350350
351351
Args:
352352
dataset_ref (Union[google.cloud.bigquery.dataset.DatasetReference, str]):

‎bigquery/google/cloud/bigquery/job.py‎

Lines changed: 61 additions & 61 deletions
Large diffs are not rendered by default.

‎bigquery/google/cloud/bigquery/model.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ class ModelReference(object):
296296
"""ModelReferences are pointers to models.
297297
298298
See
299-
https://cloud.google.com/bigquery/docs/reference/rest/v2/models
299+
https://cloud.google.com/bigquery/docs/reference/rest/v2/models#modelreference
300300
"""
301301

302302
def __init__(self):

‎bigquery/google/cloud/bigquery/query.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ def cache_hit(self):
473473
"""Query results served from cache.
474474
475475
See
476-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#cacheHit
476+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.cache_hit
477477
478478
Returns:
479479
Optional[bool]:
@@ -487,7 +487,7 @@ def complete(self):
487487
"""Server completed query.
488488
489489
See
490-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#jobComplete
490+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.job_complete
491491
492492
Returns:
493493
Optional[bool]:
@@ -501,7 +501,7 @@ def errors(self):
501501
"""Errors generated by the query.
502502
503503
See
504-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#errors
504+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.errors
505505
506506
Returns:
507507
Optional[List[Mapping]]:
@@ -515,7 +515,7 @@ def job_id(self):
515515
"""Job ID of the query job these results are from.
516516
517517
See
518-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#jobReference
518+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.job_reference
519519
520520
Returns:
521521
str: Job ID of the query job.
@@ -527,7 +527,7 @@ def page_token(self):
527527
"""Token for fetching next bach of results.
528528
529529
See
530-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#pageToken
530+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.page_token
531531
532532
Returns:
533533
Optional[str]: Token generated on the server (None until set by the server).
@@ -539,7 +539,7 @@ def total_rows(self):
539539
"""Total number of rows returned by the query.
540540
541541
See
542-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#totalRows
542+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.total_rows
543543
544544
Returns:
545545
Optional[int}: Count generated on the server (None until set by the server).
@@ -553,7 +553,7 @@ def total_bytes_processed(self):
553553
"""Total number of bytes processed by the query.
554554
555555
See
556-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#totalBytesProcessed
556+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.total_bytes_processed
557557
558558
Returns:
559559
Optional[int]: Count generated on the server (None until set by the server).
@@ -567,7 +567,7 @@ def num_dml_affected_rows(self):
567567
"""Total number of rows affected by a DML query.
568568
569569
See
570-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#numDmlAffectedRows
570+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.num_dml_affected_rows
571571
572572
Returns:
573573
Optional[int]: Count generated on the server (None until set by the server).
@@ -581,7 +581,7 @@ def rows(self):
581581
"""Query results.
582582
583583
See
584-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#rows
584+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.rows
585585
586586
Returns:
587587
Optional[List[google.cloud.bigquery.table.Row]]:
@@ -594,7 +594,7 @@ def schema(self):
594594
"""Schema for query results.
595595
596596
See
597-
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#schema
597+
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.schema
598598
599599
Returns:
600600
Optional[List[SchemaField]]:

‎bigquery/google/cloud/bigquery/routine.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def return_type(self):
183183
time.
184184
185185
See:
186-
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#resource-routine
186+
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Routine.FIELDS.return_type
187187
"""
188188
resource = self._properties.get(self._PROPERTY_TO_API_FIELD["return_type"])
189189
if not resource:
@@ -277,7 +277,7 @@ class RoutineArgument(object):
277277
"""Input/output argument of a function or a stored procedure.
278278
279279
See
280-
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines
280+
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#argument
281281
282282
Args:
283283
``**kwargs`` (Dict):
@@ -317,7 +317,7 @@ def kind(self):
317317
``ANY_TYPE``.
318318
319319
See:
320-
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#ArgumentKind
320+
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Argument.FIELDS.argument_kind
321321
"""
322322
return self._properties.get(self._PROPERTY_TO_API_FIELD["kind"])
323323

@@ -340,7 +340,7 @@ def data_type(self):
340340
of a variable, e.g., a function argument.
341341
342342
See:
343-
https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType
343+
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Argument.FIELDS.data_type
344344
"""
345345
resource = self._properties.get(self._PROPERTY_TO_API_FIELD["data_type"])
346346
if not resource:
@@ -400,7 +400,7 @@ class RoutineReference(object):
400400
"""A pointer to a routine.
401401
402402
See
403-
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines
403+
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#routinereference
404404
"""
405405

406406
def __init__(self):

‎bigquery/google/cloud/bigquery/schema.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ class SchemaField(object):
5151
name (str): the name of the field.
5252
5353
field_type (str): the type of the field. See
54-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
54+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.type
5555
56-
mode (str): the mode of the field. See
57-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
56+
mode (str): the mode of the field. See
57+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode
5858
5959
description (Optional[str]): description for the field.
6060
@@ -103,7 +103,7 @@ def field_type(self):
103103
"""str: The type of the field.
104104
105105
See:
106-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
106+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.type
107107
"""
108108
return self._field_type
109109

@@ -112,7 +112,7 @@ def mode(self):
112112
"""str: The mode of the field.
113113
114114
See:
115-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
115+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode
116116
"""
117117
return self._mode
118118

‎bigquery/google/cloud/bigquery/table.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ class TableReference(object):
184184
"""TableReferences are pointers to tables.
185185
186186
See
187-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
187+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablereference
188188
189189
Args:
190190
dataset_ref (google.cloud.bigquery.dataset.DatasetReference):
@@ -364,7 +364,7 @@ class Table(object):
364364
"""Tables represent a set of rows whose values correspond to a schema.
365365
366366
See
367-
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
367+
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource-table
368368
369369
Args:
370370
table_ref (Union[google.cloud.bigquery.table.TableReference, str]):

0 commit comments

Comments
 (0)