Skip to content

Commit 682bcc0

Browse files
chore(docs): add Authorization section to Java README template (#1161) (#298)
as a part of the PR 582 for java-logging an authorization section is added to the Java README template. Fixing googleapis/java-logging#570. Source-Link: googleapis/synthtool@3d32990 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
1 parent c864950 commit 682bcc0

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41
3+
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7

java-workflows/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ Java idiomatic client for [Cloud Workflows][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11+
1112
## Quickstart
1213

1314

1415
If you are using Maven, add this to your pom.xml file:
1516

17+
1618
```xml
1719
<dependency>
1820
<groupId>com.google.cloud</groupId>
@@ -23,11 +25,13 @@ If you are using Maven, add this to your pom.xml file:
2325
```
2426

2527
If you are using Gradle without BOM, add this to your dependencies
28+
2629
```Groovy
2730
compile 'com.google.cloud:google-cloud-workflows:1.0.2'
2831
```
2932

3033
If you are using SBT, add this to your dependencies
34+
3135
```Scala
3236
libraryDependencies += "com.google.cloud" % "google-cloud-workflows" % "1.0.2"
3337
```
@@ -36,6 +40,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-workflows" % "1.0.2"
3640

3741
See the [Authentication][authentication] section in the base directory's README.
3842

43+
## Authorization
44+
45+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud Workflows APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Workflows API calls.
46+
3947
## Getting Started
4048

4149
### Prerequisites
@@ -122,6 +130,7 @@ and on [google-cloud-java][g-c-j].
122130
This library follows [Semantic Versioning](http://semver.org/).
123131

124132

133+
125134
## Contributing
126135

127136

@@ -133,6 +142,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
133142
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
134143
information.
135144

145+
136146
## License
137147

138148
Apache 2.0 - See [LICENSE][license] for more information.
@@ -165,6 +175,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
165175
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-workflows.svg
166176
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-workflows&core=gav
167177
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
178+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
179+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
180+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
168181
[developer-console]: https://console.developers.google.com/
169182
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
170183
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)