Skip to content

Commit

Permalink
chore: Update some language prior to releasing separated clients
Browse files Browse the repository at this point in the history
  • Loading branch information
dazuma authored Jan 7, 2021
1 parent 2c145d4 commit ff33830
Show file tree
Hide file tree
Showing 1,204 changed files with 4,766 additions and 4,767 deletions.
4 changes: 2 additions & 2 deletions docs/auth-guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Authentication for Legacy REST Clients
# Authentication for Simple REST Clients

This document describes how authentication, authorization, and accounting are accomplished. For all API calls, your application needs to be authenticated. When an API accesses a user's private data, your application must also be authorized by the user to access the data. For example, accessing a public Google+ post would not require user authorization, but accessing a user's private calendar would. Also, for quota and billing purposes, all API calls involve accounting. This document summarizes the protocols used by Google APIs and provides links to more information.

> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All legacy REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All simple REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
## Access types

Expand Down
2 changes: 1 addition & 1 deletion docs/oauth-installed.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you are writing an app for Android or iOS, use [Google Sign-In](https://devel

If your app will run on devices that do not have access to a system browser, or devices with limited input capabilities (for example, if your app will run on game consoles, video cameras, or printers), then see [Using OAuth 2.0 for Devices](https://developers.google.com/accounts/docs/OAuth2ForDevices).

> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All legacy REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All simple REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/oauth-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you have a G Suite domain—if you use [G Suite](https://gsuite.google.com/),
This document describes how an application can complete the server-to-server OAuth 2.0 flow by using the Google APIs Client Library for Ruby.

> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All legacy REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All simple REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/oauth-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This OAuth 2.0 flow is specifically for user authorization. It is designed for a

Web server applications frequently also use service accounts to authorize API requests, particularly when calling Cloud APIs to access project-based data rather than user-specific data. Web server applications can use service accounts in conjunction with user authorization.

> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All legacy REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All simple REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
## Prerequisites

Expand Down
10 changes: 5 additions & 5 deletions docs/usage-guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Usage Guide for Legacy REST Clients
# Usage Guide for Simple REST Clients

This document provides all the basic information you need to start using the legacy REST clients for Google APIs. It covers important library concepts, shows examples for various use cases, and gives links to more information.
This document provides all the basic information you need to start using the simple REST clients for Google APIs. It covers important library concepts, shows examples for various use cases, and gives links to more information.

> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All legacy REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
> **Note:** this is a "general" document, and not specific to this particular service client. In particular, you may find that the examples in this document are for a different client. All simple REST clients follow the same usage patterns, and you should be able to adapt the provided examples to the client you are using.
## Before you begin

Expand Down Expand Up @@ -58,11 +58,11 @@ drive.get_file(metadata.id, download_dest: '/tmp/myfile.txt')

## Authorization

All API calls need to be authenticated, to ensure authorized access to data, and for proper accounting for quota and billing. Google legacy REST clients support several different types of authentication, including OAuth 2.0, service accounts, API keys, and default credentials. Detailed documentation, including examples of several common authentication flows, is provided in the separate [Auth Guide](auth-guide.md). In the present document, we will discuss a few basic cases to get started.
All API calls need to be authenticated, to ensure authorized access to data, and for proper accounting for quota and billing. Google simple REST clients support several different types of authentication, including OAuth 2.0, service accounts, API keys, and default credentials. Detailed documentation, including examples of several common authentication flows, is provided in the separate [Auth Guide](auth-guide.md). In the present document, we will discuss a few basic cases to get started.

### Auth libraries

Most auth functionality is provided in two separate Ruby gems, which legacy REST clients bring in as dependencies.
Most auth functionality is provided in two separate Ruby gems, which simple REST clients bring in as dependencies.

* The [signet](https://github.com/google/signet) gem is a basic implementation of [OAuth 2](https://developers.google.com/accounts/docs/OAuth2). For calls that require per-user authorization, it can be used to direct the OAuth flow needed to obtain authorization.
* The [googleauth](https://github.com/google/google-auth-library-ruby) gem builds atop signet, and offers a simple way to get credentials for use in Google APIs when auth is independent of the user. In particular, this is the recommend approach for many Cloud APIs.
Expand Down
4 changes: 2 additions & 2 deletions generated/google-apis-abusiveexperiencereport_v1/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Release history for google-apis-abusiveexperiencereport_v1

### v0.1.0 (2021-01-01)
### v0.1.0 (2021-01-07)

* Regenerated using generator version 0.1.1
* Regenerated from discovery document revision 20200803
* Regenerated using generator version 0.1.0

16 changes: 8 additions & 8 deletions generated/google-apis-abusiveexperiencereport_v1/OVERVIEW.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Legacy REST client for version V1 of the Abusive Experience Report API
# Simple REST client for version V1 of the Abusive Experience Report API

This is a simple client library for version V1 of the Abusive Experience Report API. It provides:

Expand All @@ -7,7 +7,7 @@ This is a simple client library for version V1 of the Abusive Experience Report
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
* Control of retry, pagination, and timeouts.

Note that although this client library is supported and will continue to be updated to track changes to the service, it is considered legacy. A more modern client may be available for many Google services, especially Cloud Platform services. See the section below titled *Which client should I use?* for more information.
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.

## Getting started

Expand Down Expand Up @@ -58,26 +58,26 @@ See the class reference docs for information on the methods you can call from a

## Documentation

More detailed descriptions of the Google legacy REST clients are available in two documents.
More detailed descriptions of the Google simple REST clients are available in two documents.

* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.

(Note: the above documents are written for the legacy clients in general, and their examples may not reflect the Abusiveexperiencereport service in particular.)
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Abusiveexperiencereport service in particular.)

For reference information on specific calls in the Abusive Experience Report API, see the {Google::Apis::AbusiveexperiencereportV1::AbusiveExperienceReportService class reference docs}.

## Which client should I use?

Google provides two types of Ruby API client libraries: **legacy REST clients** and **modern clients**.
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.

This library, `google-apis-abusiveexperiencereport_v1`, is a legacy REST client. You can identify legacy clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The legacy REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
This library, `google-apis-abusiveexperiencereport_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.

Modern clients are produced by a modern code generator, combined with hand-crafted functionality for some services. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Cloud Platform services, but do not yet support all the services covered by the legacy clients.
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.

Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.

**For most users, we recommend the modern client, if one is available.** Compared with legacy clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a legacy client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.

The [product documentation](https://developers.google.com/abusive-experience-report/) may provide guidance regarding the preferred client library to use.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Gem::Specification.new do |gem|
gem.version = Google::Apis::AbusiveexperiencereportV1::GEM_VERSION
gem.authors = ["Google LLC"]
gem.email = "googleapis-packages@google.com"
gem.summary = "Legacy REST client for Abusive Experience Report API V1"
gem.summary = "Simple REST client for Abusive Experience Report API V1"
gem.description =
"This is the legacy REST client for Abusive Experience Report API V1." \
" Legacy REST clients are simple Ruby libraries that provide access to" \
"This is the simple REST client for Abusive Experience Report API V1." \
" Simple REST clients are Ruby client libraries that provide access to" \
" Google services via their HTTP REST API endpoints. These libraries are" \
" generated and updated automatically based on the discovery documents" \
" published by the service, and they handle most concerns such as" \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module AbusiveexperiencereportV1
GEM_VERSION = "0.1.0"

# Version of the code generator used to generate this client
GENERATOR_VERSION = "0.1.0"
GENERATOR_VERSION = "0.1.1"

# Revision of the discovery document this client was generated from
REVISION = "20200803"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Release history for google-apis-acceleratedmobilepageurl_v1

### v0.1.0 (2021-01-01)
### v0.1.0 (2021-01-07)

* Regenerated using generator version 0.1.1
* Regenerated from discovery document revision 20200916
* Regenerated using generator version 0.1.0

Loading

0 comments on commit ff33830

Please sign in to comment.