Skip to content

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

Closed

Description

@stephenplusplus

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.

Activity

  1. callmehiphop commented on Dec 8, 2015

    @callmehiphop
    Contributor

    Perhaps this would be better placed in gcloud-common?

  2. stephenplusplus commented on Dec 8, 2015

    @stephenplusplus
    ContributorAuthor

    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?

  3. callmehiphop commented on Dec 8, 2015

    @callmehiphop
    Contributor

    Good point, it should probably just be in both.

  4. stephenplusplus commented on Nov 2, 2017

    @stephenplusplus
    ContributorAuthor

    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.

  5. added a commit that references this issue on Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions