Repository navigation
Link to upstream JSON API from our docs #740
Copy link
Copy link
Closed
Description
Activity
Is this something you only want to do where we don't provide a complete list of the available options or should we just link every method to it's upstream counterpart?
Always link. I don't know if any of our method docs are actually 1:1 with the upstream. But yeah, either way, it will still be helpful for the user to see exactly what's going on from the official docs. It also will help them see exactly what our apiResponse argument will hold.
Is search documented anywhere? I saw a few links scattered throughout the JSDoc but they're all dead now.
- added a commit that references this issue
on Nov 17, 2022 - added a commit that references this issue
on Jul 23, 2025 - added a commit that references this issue
on Jan 28, 2026 - added a commit that references this issue
on Feb 5, 2026 - added a commit that references this issue
on Feb 17, 2026 - added a commit that references this issue
on Feb 25, 2026 - added a commit that references this issue
on Mar 11, 2026 - added a commit that references this issue
on Mar 17, 2026 - added a commit that references this issue
on Mar 18, 2026 - added a commit that references this issue
on Mar 27, 2026 - added a commit that references this issue
on May 5, 2026
Metadata
Metadata
Assignees
Labels
No labels
Introduced in #721 (comment)
Our APIs will generally try to make the upstream API a little more user-friendly by using more logical names or trimming some of the verbosity. And then we document the things we handle (things like
maxResults,pageSize,pageToken, etc). But, most of our APIs are also a pass-through to the upstream API, which will have many more options that we don't document.I don't think we should document everything, as there's already a place for that. And I don't think we have to limit the user's input to include only the things "we approve". We should just link to the upstream API's docs to show the full list of options and their official descriptions.
Example:
Link https://googlecloudplatform.github.io/gcloud-node/#/docs/v0.16.0/bigquery/dataset?method=createTable to https://cloud.google.com/bigquery/docs/reference/v2/tables/insert