grafeas 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +61 -2
  3. data/lib/grafeas/version.rb +1 -1
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 76b8357d3f53347a325d45b4f2973f9ce2e1a527621662154765400b8b57a81d
4
- data.tar.gz: b38f6d765a4ebcf4bdc5836f3d53f7ab77b1dcb783ed1e048f24c7e3a547725f
3
+ metadata.gz: 54f137717e8b2beb7b6c2cf266cc7c8f8538fe23d5b56295daf78686ec077026
4
+ data.tar.gz: acb99978a96598f374a22cb8ee97916b91090489aa06ad531f4146232f6fd6b1
5
5
  SHA512:
6
- metadata.gz: 3995ca21a0518be93bde1964034f42550c9a884729b5304fb2cb85c939fcca3b2df5b1a7123b86e1c0d093aafd328c41b4f4abffd1662a5a07a1504de7028c6b
7
- data.tar.gz: ade5d279c0a6f348060133ed6252a982d047c824371be386c20555badf7342a3973a715f0e0e600d753816acba217eb6daa3c3605de564878c2b01921d523f5b
6
+ metadata.gz: e15491680b3a612fb7f11397bb76a0c0bae6a8c400baebfc81fefc7130289c83647d96a33fabe7413bb7a8fe050a719236c6a8b013c79d1147893d5b443e5ee0
7
+ data.tar.gz: 86e6c4776011f20dd3baa511cc1ddabfeae8c4d7b04caa8a4deb18a84ebd11a554fc68e76267ddcfedfc90568507a4383add290ba904e48bca4812f4c1dee892
data/README.md CHANGED
@@ -6,9 +6,10 @@ The Grafeas API stores, and enables querying and retrieval of, critical metadata
6
6
 
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `grafeas-v*`.
9
- The gem `grafeas` is a convenience wrapper library that brings the
9
+ The gem `grafeas` is the main client library that brings the
10
10
  verisoned gems in as dependencies, and provides high-level methods for
11
- constructing clients.
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
12
13
 
13
14
  View the [Client Library Documentation](https://googleapis.dev/ruby/grafeas/latest)
14
15
  for this library, grafeas, to see the convenience methods for
@@ -70,3 +71,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
70
71
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
71
72
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
72
73
  about the Ruby support schedule.
74
+
75
+ ## Which client should I use?
76
+
77
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
78
+ client library with a name such as `grafeas`,
79
+ and lower-level _versioned_ client libraries with names such as
80
+ `grafeas-v1`.
81
+ _In most cases, you should install the main client._
82
+
83
+ ### What's the difference between the main client and a versioned client?
84
+
85
+ A _versioned client_ provides a basic set of data types and client classes for
86
+ a _single version_ of a specific service. (That is, for a service with multiple
87
+ versions, there might be a separate versioned client for each service version.)
88
+ Most versioned clients are written and maintained by a code generator.
89
+
90
+ The _main client_ is designed to provide you with the _recommended_ client
91
+ interfaces for the service. There will be only one main client for any given
92
+ service, even a service with multiple versions. The main client includes
93
+ factory methods for constructing the client objects we recommend for most
94
+ users. In some cases, those will be classes provided by an underlying versioned
95
+ client; in other cases, they will be handwritten higher-level client objects
96
+ with additional capabilities, convenience methods, or best practices built in.
97
+ Generally, the main client will default to a recommended service version,
98
+ although in some cases you can override this if you need to talk to a specific
99
+ service version.
100
+
101
+ ### Why would I want to use the main client?
102
+
103
+ We recommend that most users install the main client gem for a service. You can
104
+ identify this gem as the one _without_ a version in its name, e.g.
105
+ `grafeas`.
106
+ The main client is recommended because it will embody the best practices for
107
+ accessing the service, and may also provide more convenient interfaces or
108
+ tighter integration into frameworks and third-party libraries. In addition, the
109
+ documentation and samples published by Google will generally demonstrate use of
110
+ the main client.
111
+
112
+ ### Why would I want to use a versioned client?
113
+
114
+ You can use a versioned client if you are content with a possibly lower-level
115
+ class interface, you explicitly want to avoid features provided by the main
116
+ client, or you want to access a specific service version not be covered by the
117
+ main client. You can identify versioned client gems because the service version
118
+ is part of the name, e.g. `grafeas-v1`.
119
+
120
+ ### What about the google-apis-<name> clients?
121
+
122
+ Client library gems with names that begin with `google-apis-` are based on an
123
+ older code generation technology. They talk to a REST/JSON backend (whereas
124
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
125
+ not offer the same performance, features, and ease of use provided by more
126
+ modern clients.
127
+
128
+ The `google-apis-` clients have wide coverage across Google services, so you
129
+ might need to use one if there is no modern client available for the service.
130
+ However, if a modern client is available, we generally recommend it over the
131
+ older `google-apis-` clients.
@@ -18,5 +18,5 @@
18
18
 
19
19
 
20
20
  module Grafeas
21
- VERSION = "1.0.0"
21
+ VERSION = "1.0.1"
22
22
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: grafeas
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-17 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
182
182
  - !ruby/object:Gem::Version
183
183
  version: '0'
184
184
  requirements: []
185
- rubygems_version: 3.1.3
185
+ rubygems_version: 3.2.6
186
186
  signing_key:
187
187
  specification_version: 4
188
188
  summary: API Client library for the Grafeas API