Skip to content

[Documentation Issue] gcloud.pubsub.message.Message isn't documented! #1211

Closed

Description

@ddopson

Internal Username: ddopson@google

Page Name: pubsub-subscription
Release: 0.8.0

The documentation for the pull method says that it returns instances of gcloud.pubsub.message.Message. That type doesn't link anywhere and I can't find any documentation of the Message type. This makes it really hard to use the API.

Activity

  1. ddopson commented on Oct 30, 2015

    @ddopson
    Author

    This is a 404: https://cloud.google.com/pubsub/reference/rest/google/pubsub/v1beta2/PubsubMessage

    (linked in the comments in /gcloud/pubsub/message.py)

  2. dhermes commented on Nov 8, 2015

    @dhermes
    Contributor

    @tseaver PTAL

    Thanks @ddopson!

  3. dhermes commented on Nov 8, 2015

    @dhermes
    Contributor

    Seems a few of the other links (e.g. https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions) are also 404. @tmatsuo Did the docs move?

  4. dhermes commented on Nov 8, 2015

    @dhermes
    Contributor

    @tseaver $ git grep v1beta2 gives a bunch of "old" links from before we moved from v1 to v1beta2 (I think?).

    It seems the translation is

        https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/get
    --> https://cloud.google.com/pubsub/reference/rest/v1     /projects.topics/get
    

    Also one copy-pasta (again, not 100%):

    gcloud/resource_manager/project.py:        https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/projects/get
    
  5. dhermes commented on Nov 8, 2015

    @dhermes
    Contributor

    Sent #1215 to at least get Message documented but am holding off on closing this until we can fix all the 404's. Don't have enough bandwidth (literally slow internet) to deal with right now.

    @ddopson Once #1215 gets merged you can see the "latest" docs at https://googlecloudplatform.github.io/gcloud-python/latest/ (the latest release will be at stable instead of latest).

  6. added a commit that references this issue on Dec 31, 2015
    9e6681f
  7. ddopson commented on Jan 7, 2016

    @ddopson
    Author

    Yay! Always happy to spend time reporting issues when they get looked at and fixed. :-)

    Thanks!

  8. dhermes commented on Jan 7, 2016

    @dhermes
    Contributor

    Sorry it took to long to resolve. Thanks for being observant!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

api: pubsubIssues related to the Pub/Sub API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions