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

docs: make callback.apiResponse argument a link to the upstream docs #1007

Closed
stephenplusplus opened this issue Dec 8, 2015 · 4 comments
Closed
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release.

Comments

@stephenplusplus
Copy link
Contributor

continuing from #990 (comment)

Anywhere we document an apiResponse argument, we should be able to link it to the API docs that show what the user can expect from that object.

Tip: for most of the API docs I've seen, you can append a fragment #response to the URL to deep link to the relevant section.

@callmehiphop
Copy link
Contributor

Perhaps this would be better placed in gcloud-common?

@stephenplusplus
Copy link
Contributor Author

Possibly, but the task will be actually writing link tags in the JSDocs. Unless you can think of an automated way to do this with metadata from the big JSON doc?

@callmehiphop
Copy link
Contributor

Good point, it should probably just be in both.

@jmuk jmuk added priority: p2 Moderately-important priority. Fix may not be included in next release. Status: Acknowledged labels Mar 7, 2017
@stephenplusplus
Copy link
Contributor Author

We are probably not going to make any changes to our GitHub hosted docs, as our repos start to migrate out onto cloud.google.com.

sofisl pushed a commit that referenced this issue Jan 17, 2023
[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@types/mocha](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | [`^8.0.0` -> `^9.0.0`](https://renovatebot.com/diffs/npm/@types%2fmocha/8.2.3/9.1.1) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/compatibility-slim/8.2.3)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/confidence-slim/8.2.3)](https://docs.renovatebot.com/merge-confidence/) |

---

### Configuration

📅 **Schedule**: "after 9am and before 3pm" (UTC).

🚦 **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 [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-vision).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release.
Projects
None yet
Development

No branches or pull requests

3 participants