Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

Commit

Permalink
chore(docs): add Authorization section to Java README template (#1161) (
Browse files Browse the repository at this point in the history
#489)

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
  • Loading branch information
gcf-owl-bot[bot] committed Jul 28, 2021
1 parent c534566 commit afe9e36
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/.OwlBot.lock.yaml
@@ -1,3 +1,3 @@
docker:
image: gcr.io/repo-automation-bots/owlbot-java:latest
digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
18 changes: 16 additions & 2 deletions README.md
Expand Up @@ -8,9 +8,11 @@ Java idiomatic client for [Access Approval][product-docs].
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]


## Quickstart

If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file

```xml
<dependencyManagement>
<dependencies>
Expand All @@ -34,6 +36,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file

If you are using Maven without BOM, add this to your dependencies:


```xml
<dependency>
<groupId>com.google.cloud</groupId>
Expand All @@ -44,17 +47,20 @@ If you are using Maven without BOM, add this to your dependencies:
```

If you are using Gradle 5.x or later, add this to your dependencies

```Groovy
implementation platform('com.google.cloud:libraries-bom:20.9.0')
compile 'com.google.cloud:google-cloud-accessapproval'
```
If you are using Gradle without BOM, add this to your dependencies

```Groovy
compile 'com.google.cloud:google-cloud-accessapproval:1.1.3'
```

If you are using SBT, add this to your dependencies

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-accessapproval" % "1.1.3"
```
Expand All @@ -63,6 +69,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-accessapproval" % "1.1

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 Access Approval APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Access Approval API calls.

## Getting Started

### Prerequisites
Expand Down Expand Up @@ -92,8 +102,7 @@ use this Access Approval Client Library.

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/java-accessapproval/tree/master/samples) directory. The samples' `README.md`
has instructions for running the samples.
Samples are in the [`samples/`](https://github.com/googleapis/java-accessapproval/tree/master/samples) directory.

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
Expand Down Expand Up @@ -159,6 +168,7 @@ and on [google-cloud-java][g-c-j].
This library follows [Semantic Versioning](http://semver.org/).



## Contributing


Expand All @@ -170,6 +180,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.
Expand Down Expand Up @@ -202,6 +213,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-accessapproval.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-accessapproval&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/
Expand Down

0 comments on commit afe9e36

Please sign in to comment.