Method: documents.get

Retrieves a single document with its full Markdown content.

HTTP request

GET https://developerknowledge.googleapis.com/v1/{name=documents/**}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Specifies the name of the document to retrieve. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

The name must not exceed 500 characters; values longer than 500 characters will result in an INVALID_ARGUMENT error.

Query parameters

Parameters
view

enum (DocumentView)

Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to DOCUMENT_VIEW_CONTENT.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Document.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.