Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

Commit

Permalink
NodeJS: Metadata updates. (#1298)
Browse files Browse the repository at this point in the history
  • Loading branch information
landrito authored May 26, 2017
1 parent 8a4e817 commit dd3d83c
Show file tree
Hide file tree
Showing 18 changed files with 30 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@
@end

@private installationLines(metadata)
$ npm install {@metadata.identifier}
$ npm install --save {@metadata.identifier}
@end
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"version": "{@metadata.packageVersionBound.lower}",
"author": "{@metadata.author}",
"description": "{@metadata.fullName} client for Node.js",
"url": "{@metadata.homepage}",
"main": "src/index.js",
"files": [
"src",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@
{@comments(@service.doc.lines)}
*
* @@param {object=} options - [Configuration object](#/docs).
* @@param {number=} options.port - The port on which to connect to the remote host.
* @@param {string=} options.servicePath - The domain name of the API remote host.
* @@param {number=} options.port - The port on which to connect to
* the remote host.
* @@param {string=} options.servicePath - The domain name of the
* API remote host.
*/
function {@service.localName}(options) {
// Define the header options.
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/com/google/api/codegen/readme.snip
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the {@metadata.shortName} api.](https://console.cloud.google.com/apis/api/{@metadata.shortName})
2. [Enable the {@metadata.fullName}.](https://console.cloud.google.com/apis/api/{@metadata.shortName})
3. [Setup Authentication.]({@metadata.authDocumentationLink})

@if installationLines
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/com/google/api/codegen/readme_rst.snip
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@
In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable the monitoring api.`_
2. `Enable the {@metadata.fullName}.`_
3. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the {@metadata.shortName} api.: {@productDocumentation(metadata)}
.. _Enable the {@metadata.fullName}.: {@productDocumentation(metadata)}
.. _Setup Authentication.: {@metadata.authDocumentationLink}

@if installationLines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Idiomatic Node.js client for [Google Example Library API][Product Documentation]
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the library api.](https://console.cloud.google.com/apis/api/library)
2. [Enable the Google Example Library API.](https://console.cloud.google.com/apis/api/library)
3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-node/#/docs/google-cloud/master/guides/authentication)

### Installation
```
$ npm install @google-cloud/library
$ npm install --save @google-cloud/library
```

### Preview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Idiomatic Node.js client for [Google Fake API][Product Documentation]
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the library api.](https://console.cloud.google.com/apis/api/library)
2. [Enable the Google Fake API.](https://console.cloud.google.com/apis/api/library)
3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-node/#/docs/google-cloud/master/guides/authentication)

### Installation
```
$ npm install example
$ npm install --save example
```

### Next Steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Idiomatic Node.js client for [Google Example Library API][Product Documentation]
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the library api.](https://console.cloud.google.com/apis/api/library)
2. [Enable the Google Example Library API.](https://console.cloud.google.com/apis/api/library)
3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-node/#/docs/google-cloud/master/guides/authentication)

### Installation
```
$ npm install @google-cloud/library
$ npm install --save @google-cloud/library
```

### Preview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"version": "0.7.1",
"author": "Google, Inc.",
"description": "Google Example Library API client for Node.js",
"url": "https://github.com/googleapis/googleapis",
"main": "src/index.js",
"files": [
"src",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ const VERSION = require('../package.json').version;
* Service comment may include special characters: <>&"`'@.
*
* @param {object=} options - [Configuration object](#/docs).
* @param {number=} options.port - The port on which to connect to the remote host.
* @param {string=} options.servicePath - The domain name of the API remote host.
* @param {number=} options.port - The port on which to connect to
* the remote host.
* @param {string=} options.servicePath - The domain name of the
* API remote host.
*/
function libraryV1(options) {
// Define the header options.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"version": "0.7.1",
"author": "Google, Inc.",
"description": "Google Example Library API client for Node.js",
"url": "https://github.com/googleapis/googleapis",
"main": "src/index.js",
"files": [
"src",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"version": "0.7.1",
"author": "Google, Inc.",
"description": "Google Fake API client for Node.js",
"url": "https://github.com/googleapis/googleapis",
"main": "src/index.js",
"files": [
"src",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ const VERSION = require('../package.json').version;
* Service comment may include special characters: <>&"`'@.
*
* @param {object=} options - [Configuration object](#/docs).
* @param {number=} options.port - The port on which to connect to the remote host.
* @param {string=} options.servicePath - The domain name of the API remote host.
* @param {number=} options.port - The port on which to connect to
* the remote host.
* @param {string=} options.servicePath - The domain name of the
* API remote host.
*/
function libraryV1(options) {
// Define the header options.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Quick Start
In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable the monitoring api.`_
2. `Enable the Google Example Library API.`_
3. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the library api.: https://cloud.google.com/library
.. _Enable the Google Example Library API.: https://cloud.google.com/library
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/google-cloud-auth

Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Quick Start
In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable the monitoring api.`_
2. `Enable the Google Fake API.`_
3. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the library api.: https://cloud.google.com/library
.. _Enable the Google Fake API.: https://cloud.google.com/library
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/google-cloud-auth

Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Quick Start
In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable the monitoring api.`_
2. `Enable the Google Example Library API.`_
3. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable the library api.: https://cloud.google.com/library
.. _Enable the Google Example Library API.: https://cloud.google.com/library
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/google-cloud-auth

Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Idiomatic Ruby client for [Google Example Library API][Product Documentation]
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the library api.](https://console.cloud.google.com/apis/api/library)
2. [Enable the Google Example Library API.](https://console.cloud.google.com/apis/api/library)
3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)

### Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Idiomatic Ruby client for [Google Example Library API][Product Documentation]
In order to use this library, you first need to go through the following steps:

1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
2. [Enable the library api.](https://console.cloud.google.com/apis/api/library)
2. [Enable the Google Example Library API.](https://console.cloud.google.com/apis/api/library)
3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)

### Installation
Expand Down

0 comments on commit dd3d83c

Please sign in to comment.