From aab899f785a626ae14815db8db5c564254521b4a Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Wed, 11 Aug 2021 21:16:16 +0000 Subject: [PATCH 1/2] chore: regenerate README --- .github/readme/synth.metadata/synth.metadata | 2 +- README.md | 16 ++++++++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/.github/readme/synth.metadata/synth.metadata b/.github/readme/synth.metadata/synth.metadata index 9a334bcae..e7f984cf3 100644 --- a/.github/readme/synth.metadata/synth.metadata +++ b/.github/readme/synth.metadata/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-dialogflow-cx.git", - "sha": "40571343d51c2275a556a2a45508c014f2e9aee1" + "sha": "6b2152a0fff0dc1ddee98688b511d55679eba728" } }, { diff --git a/README.md b/README.md index 560f00ecf..4bf1706cb 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,13 @@ Java idiomatic client for [Dialogflow CX][product-docs]. > Note: This client is a work-in-progress, and may occasionally > make backwards-incompatible changes. + ## Quickstart If you are using Maven, add this to your pom.xml file: + ```xml com.google.cloud @@ -25,11 +27,13 @@ If you are using Maven, add this to your pom.xml file: ``` If you are using Gradle without BOM, add this to your dependencies + ```Groovy compile 'com.google.cloud:google-cloud-dialogflow-cx:0.8.0' ``` If you are using SBT, add this to your dependencies + ```Scala libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8.0" ``` @@ -38,6 +42,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8. See the [Authentication][authentication] section in the base directory's README. +## Authorization + +The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Dialogflow CX APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Dialogflow CX API calls. + ## Getting Started ### Prerequisites @@ -67,8 +75,7 @@ use this Dialogflow CX Client Library. ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory. The samples' `README.md` -has instructions for running the samples. +Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | @@ -141,6 +148,7 @@ This library follows [Semantic Versioning](http://semver.org/). It is currently in major version zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable. + ## Contributing @@ -152,6 +160,7 @@ Please note that this project is released with a Contributor Code of Conduct. By this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information. + ## License Apache 2.0 - See [LICENSE][license] for more information. @@ -184,6 +193,9 @@ Java is a registered trademark of Oracle and/or its affiliates. [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dialogflow-cx.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-dialogflow-cx&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication +[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes +[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles +[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy [developer-console]: https://console.developers.google.com/ [create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects [cloud-sdk]: https://cloud.google.com/sdk/ From 95d9e4c5be2329ae0317db1fa9e92e8b26b1f0ad Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 11 Aug 2021 21:18:37 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- README.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 4bf1706cb..560f00ecf 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,11 @@ Java idiomatic client for [Dialogflow CX][product-docs]. > Note: This client is a work-in-progress, and may occasionally > make backwards-incompatible changes. - ## Quickstart If you are using Maven, add this to your pom.xml file: - ```xml com.google.cloud @@ -27,13 +25,11 @@ If you are using Maven, add this to your pom.xml file: ``` If you are using Gradle without BOM, add this to your dependencies - ```Groovy compile 'com.google.cloud:google-cloud-dialogflow-cx:0.8.0' ``` If you are using SBT, add this to your dependencies - ```Scala libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8.0" ``` @@ -42,10 +38,6 @@ libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8. See the [Authentication][authentication] section in the base directory's README. -## Authorization - -The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Dialogflow CX APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Dialogflow CX API calls. - ## Getting Started ### Prerequisites @@ -75,7 +67,8 @@ use this Dialogflow CX Client Library. ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory. +Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory. The samples' `README.md` +has instructions for running the samples. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | @@ -148,7 +141,6 @@ This library follows [Semantic Versioning](http://semver.org/). It is currently in major version zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable. - ## Contributing @@ -160,7 +152,6 @@ Please note that this project is released with a Contributor Code of Conduct. By this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information. - ## License Apache 2.0 - See [LICENSE][license] for more information. @@ -193,9 +184,6 @@ Java is a registered trademark of Oracle and/or its affiliates. [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dialogflow-cx.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-dialogflow-cx&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication -[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes -[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles -[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy [developer-console]: https://console.developers.google.com/ [create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects [cloud-sdk]: https://cloud.google.com/sdk/