Link to upstream JSON API from our docs #740
Assignees
Comments
|
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. |
Merged
sofisl
pushed a commit
that referenced
this issue
Nov 17, 2022
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jsdoc-region-tag](https://togithub.com/googleapis/jsdoc-region-tag) | [`^1.1.0` -> `^2.0.0`](https://renovatebot.com/diffs/npm/jsdoc-region-tag/1.3.1/2.0.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>googleapis/jsdoc-region-tag</summary> ### [`v2.0.0`](https://togithub.com/googleapis/jsdoc-region-tag/blob/HEAD/CHANGELOG.md#​200-httpsgithubcomgoogleapisjsdoc-region-tagcomparev131v200-2022-05-20) [Compare Source](https://togithub.com/googleapis/jsdoc-region-tag/compare/v1.3.1...v2.0.0) ##### ⚠ BREAKING CHANGES - update library to use Node 12 ([#​107](https://togithub.com/googleapis/jsdoc-region-tag/issues/107)) ##### Build System - update library to use Node 12 ([#​107](https://togithub.com/googleapis/jsdoc-region-tag/issues/107)) ([5b51796](https://togithub.com/googleapis/jsdoc-region-tag/commit/5b51796771984cf8b978990025f14faa03c19923)) ##### [1.3.1](https://www.github.com/googleapis/jsdoc-region-tag/compare/v1.3.0...v1.3.1) (2021-08-11) ##### Bug Fixes - **build:** migrate to using main branch ([#​79](https://www.togithub.com/googleapis/jsdoc-region-tag/issues/79)) ([5050615](https://www.github.com/googleapis/jsdoc-region-tag/commit/50506150b7758592df5e389c6a5c3d82b3b20881)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-compute).
4 tasks
sofisl
pushed a commit
that referenced
this issue
Jan 24, 2023
sofisl
pushed a commit
that referenced
this issue
Jan 24, 2023
](https://renovatebot.com){kind=link}
🤖 I have created a release \*beep\* \*boop\* --- ### [4.5.1](https://www.github.com/googleapis/nodejs-speech/compare/v4.5.0...v4.5.1) (2021-05-20) ### Bug Fixes * **deps:** require google-gax v2.12.0 ([#740](https://www.github.com/googleapis/nodejs-speech/issues/740)) ([0c9c68f](https://www.github.com/googleapis/nodejs-speech/commit/0c9c68f79eee3a9132f0cf18c44a45928da2e809)) * use require() to load JSON protos ([#746](https://www.github.com/googleapis/nodejs-speech/issues/746)) ([689af48](https://www.github.com/googleapis/nodejs-speech/commit/689af48120572779143f16f7d1b0652bdddd931e)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
sofisl
pushed a commit
that referenced
this issue
Jan 25, 2023
sofisl
pushed a commit
that referenced
this issue
Jan 25, 2023
🤖 I have created a release \*beep\* \*boop\* --- ### [4.5.1](https://www.github.com/googleapis/nodejs-speech/compare/v4.5.0...v4.5.1) (2021-05-20) ### Bug Fixes * **deps:** require google-gax v2.12.0 ([#740](https://www.github.com/googleapis/nodejs-speech/issues/740)) ([0c9c68f](https://www.github.com/googleapis/nodejs-speech/commit/0c9c68f79eee3a9132f0cf18c44a45928da2e809)) * use require() to load JSON protos ([#746](https://www.github.com/googleapis/nodejs-speech/issues/746)) ([689af48](https://www.github.com/googleapis/nodejs-speech/commit/689af48120572779143f16f7d1b0652bdddd931e)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: