Skip to content

Commit

Permalink
fix(docs): fix require module in samples (#26)
Browse files Browse the repository at this point in the history
* fix(docs): fix require module

* fix module

* reverty
  • Loading branch information
jkwlui authored Jan 2, 2019
1 parent 9f5a741 commit 0a56b6b
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 213 deletions.
2 changes: 1 addition & 1 deletion packages/google-cloud-securitycenter/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const gapic = Object.freeze({
* - `SecurityCenterClient` - Reference to
* {@link v1beta1.SecurityCenterClient}
*
* @module {object} securitycenter
* @module {object} @google-cloud/securitycenter
* @alias nodejs-securitycenter
*
* @example <caption>Install the client library with <a href="https://www.npmjs.com/">npm</a>:</caption>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,48 +115,4 @@ const Policy = {
*/
const Binding = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The difference delta between two policies.
*
* @property {Object[]} bindingDeltas
* The delta for Bindings between two policies.
*
* This object should have the same structure as [BindingDelta]{@link google.iam.v1.BindingDelta}
*
* @typedef PolicyDelta
* @memberof google.iam.v1
* @see [google.iam.v1.PolicyDelta definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/iam/v1/policy.proto}
*/
const PolicyDelta = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* One delta entry for Binding. Each individual change (only one member in each
* entry) to a binding will be a separate entry.
*
* @property {number} action
* The action that was performed on a Binding.
* Required
*
* The number should be among the values of [Action]{@link google.iam.v1.Action}
*
* @property {string} role
* Role that is assigned to `members`.
* For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
* Required
*
* @property {string} member
* A single identity requesting access for a Cloud Platform resource.
* Follows the same format of Binding.members.
* Required
*
* @typedef BindingDelta
* @memberof google.iam.v1
* @see [google.iam.v1.BindingDelta definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/iam/v1/policy.proto}
*/
const BindingDelta = {
// This is for documentation. Actual contents will be loaded by gRPC.
};
Original file line number Diff line number Diff line change
Expand Up @@ -60,88 +60,4 @@
*/
const Operation = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The request message for Operations.GetOperation.
*
* @property {string} name
* The name of the operation resource.
*
* @typedef GetOperationRequest
* @memberof google.longrunning
* @see [google.longrunning.GetOperationRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto}
*/
const GetOperationRequest = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The request message for Operations.ListOperations.
*
* @property {string} name
* The name of the operation collection.
*
* @property {string} filter
* The standard list filter.
*
* @property {number} pageSize
* The standard list page size.
*
* @property {string} pageToken
* The standard list page token.
*
* @typedef ListOperationsRequest
* @memberof google.longrunning
* @see [google.longrunning.ListOperationsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto}
*/
const ListOperationsRequest = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The response message for Operations.ListOperations.
*
* @property {Object[]} operations
* A list of operations that matches the specified filter in the request.
*
* This object should have the same structure as [Operation]{@link google.longrunning.Operation}
*
* @property {string} nextPageToken
* The standard List next-page token.
*
* @typedef ListOperationsResponse
* @memberof google.longrunning
* @see [google.longrunning.ListOperationsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto}
*/
const ListOperationsResponse = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The request message for Operations.CancelOperation.
*
* @property {string} name
* The name of the operation resource to be cancelled.
*
* @typedef CancelOperationRequest
* @memberof google.longrunning
* @see [google.longrunning.CancelOperationRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto}
*/
const CancelOperationRequest = {
// This is for documentation. Actual contents will be loaded by gRPC.
};

/**
* The request message for Operations.DeleteOperation.
*
* @property {string} name
* The name of the operation resource to be deleted.
*
* @typedef DeleteOperationRequest
* @memberof google.longrunning
* @see [google.longrunning.DeleteOperationRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto}
*/
const DeleteOperationRequest = {
// This is for documentation. Actual contents will be loaded by gRPC.
};
Loading

0 comments on commit 0a56b6b

Please sign in to comment.