diff --git a/packages/grafeas/src/v1/doc/google/protobuf/doc_any.js b/packages/grafeas/src/v1/doc/google/protobuf/doc_any.js deleted file mode 100644 index 813682aa336..00000000000 --- a/packages/grafeas/src/v1/doc/google/protobuf/doc_any.js +++ /dev/null @@ -1,137 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * `Any` contains an arbitrary serialized protocol buffer message along with a - * URL that describes the type of the serialized message. - * - * Protobuf library provides support to pack/unpack Any values in the form - * of utility functions or additional generated methods of the Any type. - * - * Example 1: Pack and unpack a message in C++. - * - * Foo foo = ...; - * Any any; - * any.PackFrom(foo); - * ... - * if (any.UnpackTo(&foo)) { - * ... - * } - * - * Example 2: Pack and unpack a message in Java. - * - * Foo foo = ...; - * Any any = Any.pack(foo); - * ... - * if (any.is(Foo.class)) { - * foo = any.unpack(Foo.class); - * } - * - * Example 3: Pack and unpack a message in Python. - * - * foo = Foo(...) - * any = Any() - * any.Pack(foo) - * ... - * if any.Is(Foo.DESCRIPTOR): - * any.Unpack(foo) - * ... - * - * Example 4: Pack and unpack a message in Go - * - * foo := &pb.Foo{...} - * any, err := ptypes.MarshalAny(foo) - * ... - * foo := &pb.Foo{} - * if err := ptypes.UnmarshalAny(any, foo); err != nil { - * ... - * } - * - * The pack methods provided by protobuf library will by default use - * 'type.googleapis.com/full.type.name' as the type URL and the unpack - * methods only use the fully qualified type name after the last '/' - * in the type URL, for example "foo.bar.com/x/y.z" will yield type - * name "y.z". - * - * - * # JSON - * - * The JSON representation of an `Any` value uses the regular - * representation of the deserialized, embedded message, with an - * additional field `@type` which contains the type URL. Example: - * - * package google.profile; - * message Person { - * string first_name = 1; - * string last_name = 2; - * } - * - * { - * "@type": "type.googleapis.com/google.profile.Person", - * "firstName": , - * "lastName": - * } - * - * If the embedded message type is well-known and has a custom JSON - * representation, that representation will be embedded adding a field - * `value` which holds the custom JSON in addition to the `@type` - * field. Example (for message google.protobuf.Duration): - * - * { - * "@type": "type.googleapis.com/google.protobuf.Duration", - * "value": "1.212s" - * } - * - * @property {string} typeUrl - * A URL/resource name that uniquely identifies the type of the serialized - * protocol buffer message. This string must contain at least - * one "/" character. The last segment of the URL's path must represent - * the fully qualified name of the type (as in - * `path/google.protobuf.Duration`). The name should be in a canonical form - * (e.g., leading "." is not accepted). - * - * In practice, teams usually precompile into the binary all types that they - * expect it to use in the context of Any. However, for URLs which use the - * scheme `http`, `https`, or no scheme, one can optionally set up a type - * server that maps type URLs to message definitions as follows: - * - * * If no scheme is provided, `https` is assumed. - * * An HTTP GET on the URL must yield a google.protobuf.Type - * value in binary format, or produce an error. - * * Applications are allowed to cache lookup results based on the - * URL, or have them precompiled into a binary to avoid any - * lookup. Therefore, binary compatibility needs to be preserved - * on changes to types. (Use versioned type names to manage - * breaking changes.) - * - * Note: this functionality is not currently available in the official - * protobuf release, and it is not used for type URLs beginning with - * type.googleapis.com. - * - * Schemes other than `http`, `https` (or the empty scheme) might be - * used with implementation specific semantics. - * - * @property {Buffer} value - * Must be a valid serialized protocol buffer of the above specified type. - * - * @typedef Any - * @memberof google.protobuf - * @see [google.protobuf.Any definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/any.proto} - */ -const Any = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/google/protobuf/doc_empty.js b/packages/grafeas/src/v1/doc/google/protobuf/doc_empty.js deleted file mode 100644 index 1e3961d6609..00000000000 --- a/packages/grafeas/src/v1/doc/google/protobuf/doc_empty.js +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: - * - * service Foo { - * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - * } - * - * The JSON representation for `Empty` is empty JSON object `{}`. - * @typedef Empty - * @memberof google.protobuf - * @see [google.protobuf.Empty definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/empty.proto} - */ -const Empty = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/google/protobuf/doc_field_mask.js b/packages/grafeas/src/v1/doc/google/protobuf/doc_field_mask.js deleted file mode 100644 index 59e745f36c2..00000000000 --- a/packages/grafeas/src/v1/doc/google/protobuf/doc_field_mask.js +++ /dev/null @@ -1,228 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * `FieldMask` represents a set of symbolic field paths, for example: - * - * paths: "f.a" - * paths: "f.b.d" - * - * Here `f` represents a field in some root message, `a` and `b` - * fields in the message found in `f`, and `d` a field found in the - * message in `f.b`. - * - * Field masks are used to specify a subset of fields that should be - * returned by a get operation or modified by an update operation. - * Field masks also have a custom JSON encoding (see below). - * - * # Field Masks in Projections - * - * When used in the context of a projection, a response message or - * sub-message is filtered by the API to only contain those fields as - * specified in the mask. For example, if the mask in the previous - * example is applied to a response message as follows: - * - * f { - * a : 22 - * b { - * d : 1 - * x : 2 - * } - * y : 13 - * } - * z: 8 - * - * The result will not contain specific values for fields x,y and z - * (their value will be set to the default, and omitted in proto text - * output): - * - * - * f { - * a : 22 - * b { - * d : 1 - * } - * } - * - * A repeated field is not allowed except at the last position of a - * paths string. - * - * If a FieldMask object is not present in a get operation, the - * operation applies to all fields (as if a FieldMask of all fields - * had been specified). - * - * Note that a field mask does not necessarily apply to the - * top-level response message. In case of a REST get operation, the - * field mask applies directly to the response, but in case of a REST - * list operation, the mask instead applies to each individual message - * in the returned resource list. In case of a REST custom method, - * other definitions may be used. Where the mask applies will be - * clearly documented together with its declaration in the API. In - * any case, the effect on the returned resource/resources is required - * behavior for APIs. - * - * # Field Masks in Update Operations - * - * A field mask in update operations specifies which fields of the - * targeted resource are going to be updated. The API is required - * to only change the values of the fields as specified in the mask - * and leave the others untouched. If a resource is passed in to - * describe the updated values, the API ignores the values of all - * fields not covered by the mask. - * - * If a repeated field is specified for an update operation, new values will - * be appended to the existing repeated field in the target resource. Note that - * a repeated field is only allowed in the last position of a `paths` string. - * - * If a sub-message is specified in the last position of the field mask for an - * update operation, then new value will be merged into the existing sub-message - * in the target resource. - * - * For example, given the target message: - * - * f { - * b { - * d: 1 - * x: 2 - * } - * c: [1] - * } - * - * And an update message: - * - * f { - * b { - * d: 10 - * } - * c: [2] - * } - * - * then if the field mask is: - * - * paths: ["f.b", "f.c"] - * - * then the result will be: - * - * f { - * b { - * d: 10 - * x: 2 - * } - * c: [1, 2] - * } - * - * An implementation may provide options to override this default behavior for - * repeated and message fields. - * - * In order to reset a field's value to the default, the field must - * be in the mask and set to the default value in the provided resource. - * Hence, in order to reset all fields of a resource, provide a default - * instance of the resource and set all fields in the mask, or do - * not provide a mask as described below. - * - * If a field mask is not present on update, the operation applies to - * all fields (as if a field mask of all fields has been specified). - * Note that in the presence of schema evolution, this may mean that - * fields the client does not know and has therefore not filled into - * the request will be reset to their default. If this is unwanted - * behavior, a specific service may require a client to always specify - * a field mask, producing an error if not. - * - * As with get operations, the location of the resource which - * describes the updated values in the request message depends on the - * operation kind. In any case, the effect of the field mask is - * required to be honored by the API. - * - * ## Considerations for HTTP REST - * - * The HTTP kind of an update operation which uses a field mask must - * be set to PATCH instead of PUT in order to satisfy HTTP semantics - * (PUT must only be used for full updates). - * - * # JSON Encoding of Field Masks - * - * In JSON, a field mask is encoded as a single string where paths are - * separated by a comma. Fields name in each path are converted - * to/from lower-camel naming conventions. - * - * As an example, consider the following message declarations: - * - * message Profile { - * User user = 1; - * Photo photo = 2; - * } - * message User { - * string display_name = 1; - * string address = 2; - * } - * - * In proto a field mask for `Profile` may look as such: - * - * mask { - * paths: "user.display_name" - * paths: "photo" - * } - * - * In JSON, the same mask is represented as below: - * - * { - * mask: "user.displayName,photo" - * } - * - * # Field Masks and Oneof Fields - * - * Field masks treat fields in oneofs just as regular fields. Consider the - * following message: - * - * message SampleMessage { - * oneof test_oneof { - * string name = 4; - * SubMessage sub_message = 9; - * } - * } - * - * The field mask can be: - * - * mask { - * paths: "name" - * } - * - * Or: - * - * mask { - * paths: "sub_message" - * } - * - * Note that oneof type names ("test_oneof" in this case) cannot be used in - * paths. - * - * ## Field Mask Verification - * - * The implementation of any API method which has a FieldMask type field in the - * request should verify the included field paths, and return an - * `INVALID_ARGUMENT` error if any path is duplicated or unmappable. - * - * @property {string[]} paths - * The set of field mask paths. - * - * @typedef FieldMask - * @memberof google.protobuf - * @see [google.protobuf.FieldMask definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/field_mask.proto} - */ -const FieldMask = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/google/protobuf/doc_timestamp.js b/packages/grafeas/src/v1/doc/google/protobuf/doc_timestamp.js deleted file mode 100644 index c86af4e3d22..00000000000 --- a/packages/grafeas/src/v1/doc/google/protobuf/doc_timestamp.js +++ /dev/null @@ -1,119 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A Timestamp represents a point in time independent of any time zone or local - * calendar, encoded as a count of seconds and fractions of seconds at - * nanosecond resolution. The count is relative to an epoch at UTC midnight on - * January 1, 1970, in the proleptic Gregorian calendar which extends the - * Gregorian calendar backwards to year one. - * - * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - * second table is needed for interpretation, using a [24-hour linear - * smear](https://developers.google.com/time/smear). - * - * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - * restricting to that range, we ensure that we can convert to and from [RFC - * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. - * - * # Examples - * - * Example 1: Compute Timestamp from POSIX `time()`. - * - * Timestamp timestamp; - * timestamp.set_seconds(time(NULL)); - * timestamp.set_nanos(0); - * - * Example 2: Compute Timestamp from POSIX `gettimeofday()`. - * - * struct timeval tv; - * gettimeofday(&tv, NULL); - * - * Timestamp timestamp; - * timestamp.set_seconds(tv.tv_sec); - * timestamp.set_nanos(tv.tv_usec * 1000); - * - * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - * - * FILETIME ft; - * GetSystemTimeAsFileTime(&ft); - * UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; - * - * // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z - * // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. - * Timestamp timestamp; - * timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - * timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - * - * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - * - * long millis = System.currentTimeMillis(); - * - * Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) - * .setNanos((int) ((millis % 1000) * 1000000)).build(); - * - * - * Example 5: Compute Timestamp from current time in Python. - * - * timestamp = Timestamp() - * timestamp.GetCurrentTime() - * - * # JSON Mapping - * - * In JSON format, the Timestamp type is encoded as a string in the - * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" - * where {year} is always expressed using four digits while {month}, {day}, - * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional - * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone - * is required. A proto3 JSON serializer should always use UTC (as indicated by - * "Z") when printing the Timestamp type and a proto3 JSON parser should be - * able to accept both UTC and other timezones (as indicated by an offset). - * - * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past - * 01:30 UTC on January 15, 2017. - * - * In JavaScript, one can convert a Date object to this format using the - * standard - * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - * method. In Python, a standard `datetime.datetime` object can be converted - * to this format using - * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with - * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use - * the Joda Time's [`ISODateTimeFormat.dateTime()`](https://cloud.google.com - * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D - * ) to obtain a formatter capable of generating timestamps in this format. - * - * @property {number} seconds - * Represents seconds of UTC time since Unix epoch - * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - * 9999-12-31T23:59:59Z inclusive. - * - * @property {number} nanos - * Non-negative fractions of a second at nanosecond resolution. Negative - * second values with fractions must still have non-negative nanos values - * that count forward in time. Must be from 0 to 999,999,999 - * inclusive. - * - * @typedef Timestamp - * @memberof google.protobuf - * @see [google.protobuf.Timestamp definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto} - */ -const Timestamp = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/google/rpc/doc_status.js b/packages/grafeas/src/v1/doc/google/rpc/doc_status.js deleted file mode 100644 index 80ec5037662..00000000000 --- a/packages/grafeas/src/v1/doc/google/rpc/doc_status.js +++ /dev/null @@ -1,95 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - * - Simple to use and understand for most users - * - Flexible enough to meet unexpected needs - * - * # Overview - * - * The `Status` message contains three pieces of data: error code, error - * message, and error details. The error code should be an enum value of - * google.rpc.Code, but it may accept additional error codes - * if needed. The error message should be a developer-facing English message - * that helps developers *understand* and *resolve* the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may contain - * arbitrary information about the error. There is a predefined set of error - * detail types in the package `google.rpc` that can be used for common error - * conditions. - * - * # Language mapping - * - * The `Status` message is the logical representation of the error model, but it - * is not necessarily the actual wire format. When the `Status` message is - * exposed in different client libraries and different wire protocols, it can be - * mapped differently. For example, it will likely be mapped to some exceptions - * in Java, but more likely mapped to some error codes in C. - * - * # Other uses - * - * The error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a - * consistent developer experience across different environments. - * - * Example uses of this error model include: - * - * - Partial errors. If a service needs to return partial errors to the client, - * it may embed the `Status` in the normal response to indicate the partial - * errors. - * - * - Workflow errors. A typical workflow has multiple steps. Each step may - * have a `Status` message for error reporting. - * - * - Batch operations. If a client uses batch request and batch response, the - * `Status` message should be used directly inside batch response, one for - * each error sub-response. - * - * - Asynchronous operations. If an API call embeds asynchronous operation - * results in its response, the status of those operations should be - * represented directly using the `Status` message. - * - * - Logging. If some API errors are stored in logs, the message `Status` could - * be used directly after any stripping needed for security/privacy reasons. - * - * @property {number} code - * The status code, which should be an enum value of - * google.rpc.Code. - * - * @property {string} message - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized - * by the client. - * - * @property {Object[]} details - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. - * - * This object should have the same structure as [Any]{@link google.protobuf.Any} - * - * @typedef Status - * @memberof google.rpc - * @see [google.rpc.Status definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto} - */ -const Status = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_attestation.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_attestation.js deleted file mode 100644 index 2240286f20f..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_attestation.js +++ /dev/null @@ -1,90 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Note kind that represents a logical attestation "role" or "authority". For - * example, an organization might have one `Authority` for "QA" and one for - * "build". This note is intended to act strictly as a grouping mechanism for - * the attached occurrences (Attestations). This grouping mechanism also - * provides a security boundary, since IAM ACLs gate the ability for a principle - * to attach an occurrence to a given note. It also provides a single point of - * lookup to find all attached attestation occurrences, even if they don't all - * live in the same project. - * - * @property {Object} hint - * Hint hints at the purpose of the attestation authority. - * - * This object should have the same structure as [Hint]{@link grafeas.v1.Hint} - * - * @typedef AttestationNote - * @memberof grafeas.v1 - * @see [grafeas.v1.AttestationNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/attestation.proto} - */ -const AttestationNote = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * This submessage provides human-readable hints about the purpose of the - * authority. Because the name of a note acts as its resource reference, it is - * important to disambiguate the canonical name of the Note (which might be a - * UUID for security purposes) from "readable" names more suitable for debug - * output. Note that these hints should not be used to look up authorities in - * security sensitive contexts, such as when looking up attestations to - * verify. - * - * @property {string} humanReadableName - * Required. The human readable name of this attestation authority, for - * example "qa". - * - * @typedef Hint - * @memberof grafeas.v1 - * @see [grafeas.v1.AttestationNote.Hint definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/attestation.proto} - */ - Hint: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * Occurrence that represents a single "attestation". The authenticity of an - * attestation can be verified using the attached signature. If the verifier - * trusts the public key of the signer, then verifying the signature is - * sufficient to establish trust. In this circumstance, the authority to which - * this attestation is attached is primarily useful for lookup (how to find - * this attestation if you already know the authority and artifact to be - * verified) and intent (for which authority this attestation was intended to - * sign. - * - * @property {Buffer} serializedPayload - * Required. The serialized payload that is verified by one or more - * `signatures`. - * - * @property {Object[]} signatures - * One or more signatures over `serialized_payload`. Verifier implementations - * should consider this attestation message verified if at least one - * `signature` verifies `serialized_payload`. See `Signature` in common.proto - * for more details on signature structure and verification. - * - * This object should have the same structure as [Signature]{@link grafeas.v1.Signature} - * - * @typedef AttestationOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.AttestationOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/attestation.proto} - */ -const AttestationOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_build.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_build.js deleted file mode 100644 index ae056de3df5..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_build.js +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Note holding the version of the provider's builder and the signature of the - * provenance message in the build details occurrence. - * - * @property {string} builderVersion - * Required. Immutable. Version of the builder which produced this build. - * - * @typedef BuildNote - * @memberof grafeas.v1 - * @see [grafeas.v1.BuildNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/build.proto} - */ -const BuildNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Details of a build occurrence. - * - * @property {Object} provenance - * Required. The actual provenance for the build. - * - * This object should have the same structure as [BuildProvenance]{@link grafeas.v1.BuildProvenance} - * - * @property {string} provenanceBytes - * Serialized JSON representation of the provenance, used in generating the - * build signature in the corresponding build note. After verifying the - * signature, `provenance_bytes` can be unmarshalled and compared to the - * provenance to confirm that it is unchanged. A base64-encoded string - * representation of the provenance bytes is used for the signature in order - * to interoperate with openssl which expects this format for signature - * verification. - * - * The serialized form is captured both to avoid ambiguity in how the - * provenance is marshalled to json as well to prevent incompatibilities with - * future changes. - * - * @typedef BuildOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.BuildOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/build.proto} - */ -const BuildOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_common.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_common.js deleted file mode 100644 index 41766a94664..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_common.js +++ /dev/null @@ -1,146 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Metadata for any related URL information. - * - * @property {string} url - * Specific URL associated with the resource. - * - * @property {string} label - * Label to describe usage of the URL. - * - * @typedef RelatedUrl - * @memberof grafeas.v1 - * @see [grafeas.v1.RelatedUrl definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/common.proto} - */ -const RelatedUrl = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Verifiers (e.g. Kritis implementations) MUST verify signatures - * with respect to the trust anchors defined in policy (e.g. a Kritis policy). - * Typically this means that the verifier has been configured with a map from - * `public_key_id` to public key material (and any required parameters, e.g. - * signing algorithm). - * - * In particular, verification implementations MUST NOT treat the signature - * `public_key_id` as anything more than a key lookup hint. The `public_key_id` - * DOES NOT validate or authenticate a public key; it only provides a mechanism - * for quickly selecting a public key ALREADY CONFIGURED on the verifier through - * a trusted channel. Verification implementations MUST reject signatures in any - * of the following circumstances: - * * The `public_key_id` is not recognized by the verifier. - * * The public key that `public_key_id` refers to does not verify the - * signature with respect to the payload. - * - * The `signature` contents SHOULD NOT be "attached" (where the payload is - * included with the serialized `signature` bytes). Verifiers MUST ignore any - * "attached" payload and only verify signatures with respect to explicitly - * provided payload (e.g. a `payload` field on the proto message that holds - * this Signature, or the canonical serialization of the proto message that - * holds this signature). - * - * @property {Buffer} signature - * The content of the signature, an opaque bytestring. - * The payload that this signature verifies MUST be unambiguously provided - * with the Signature during verification. A wrapper message might provide - * the payload explicitly. Alternatively, a message might have a canonical - * serialization that can always be unambiguously computed to derive the - * payload. - * - * @property {string} publicKeyId - * The identifier for the public key that verifies this signature. - * * The `public_key_id` is required. - * * The `public_key_id` MUST be an RFC3986 conformant URI. - * * When possible, the `public_key_id` SHOULD be an immutable reference, - * such as a cryptographic digest. - * - * Examples of valid `public_key_id`s: - * - * OpenPGP V4 public key fingerprint: - * * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" - * See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more - * details on this scheme. - * - * RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER - * serialization): - * * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" - * * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" - * - * @typedef Signature - * @memberof grafeas.v1 - * @see [grafeas.v1.Signature definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/common.proto} - */ -const Signature = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Kind represents the kinds of notes supported. - * - * @enum {number} - * @memberof grafeas.v1 - */ -const NoteKind = { - - /** - * Unknown. - */ - NOTE_KIND_UNSPECIFIED: 0, - - /** - * The note and occurrence represent a package vulnerability. - */ - VULNERABILITY: 1, - - /** - * The note and occurrence assert build provenance. - */ - BUILD: 2, - - /** - * This represents an image basis relationship. - */ - IMAGE: 3, - - /** - * This represents a package installed via a package manager. - */ - PACKAGE: 4, - - /** - * The note and occurrence track deployment events. - */ - DEPLOYMENT: 5, - - /** - * The note and occurrence track the initial discovery status of a resource. - */ - DISCOVERY: 6, - - /** - * This represents a logical "role" that can attest to artifacts. - */ - ATTESTATION: 7, - - /** - * This represents an available package upgrade. - */ - UPGRADE: 8 -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_cvss.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_cvss.js deleted file mode 100644 index 3ae629011ed..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_cvss.js +++ /dev/null @@ -1,127 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Common Vulnerability Scoring System version 3. - * For details, see https://www.first.org/cvss/specification-document - * - * @property {number} baseScore - * The base score is a function of the base metric scores. - * - * @property {number} exploitabilityScore - * - * @property {number} impactScore - * - * @property {number} attackVector - * Base Metrics - * Represents the intrinsic characteristics of a vulnerability that are - * constant over time and across user environments. - * - * The number should be among the values of [AttackVector]{@link grafeas.v1.AttackVector} - * - * @property {number} attackComplexity - * The number should be among the values of [AttackComplexity]{@link grafeas.v1.AttackComplexity} - * - * @property {number} privilegesRequired - * The number should be among the values of [PrivilegesRequired]{@link grafeas.v1.PrivilegesRequired} - * - * @property {number} userInteraction - * The number should be among the values of [UserInteraction]{@link grafeas.v1.UserInteraction} - * - * @property {number} scope - * The number should be among the values of [Scope]{@link grafeas.v1.Scope} - * - * @property {number} confidentialityImpact - * The number should be among the values of [Impact]{@link grafeas.v1.Impact} - * - * @property {number} integrityImpact - * The number should be among the values of [Impact]{@link grafeas.v1.Impact} - * - * @property {number} availabilityImpact - * The number should be among the values of [Impact]{@link grafeas.v1.Impact} - * - * @typedef CVSSv3 - * @memberof grafeas.v1 - * @see [grafeas.v1.CVSSv3 definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/cvss.proto} - */ -const CVSSv3 = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - AttackComplexity: { - ATTACK_COMPLEXITY_UNSPECIFIED: 0, - ATTACK_COMPLEXITY_LOW: 1, - ATTACK_COMPLEXITY_HIGH: 2 - }, - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - AttackVector: { - ATTACK_VECTOR_UNSPECIFIED: 0, - ATTACK_VECTOR_NETWORK: 1, - ATTACK_VECTOR_ADJACENT: 2, - ATTACK_VECTOR_LOCAL: 3, - ATTACK_VECTOR_PHYSICAL: 4 - }, - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - Impact: { - IMPACT_UNSPECIFIED: 0, - IMPACT_HIGH: 1, - IMPACT_LOW: 2, - IMPACT_NONE: 3 - }, - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - PrivilegesRequired: { - PRIVILEGES_REQUIRED_UNSPECIFIED: 0, - PRIVILEGES_REQUIRED_NONE: 1, - PRIVILEGES_REQUIRED_LOW: 2, - PRIVILEGES_REQUIRED_HIGH: 3 - }, - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - Scope: { - SCOPE_UNSPECIFIED: 0, - SCOPE_UNCHANGED: 1, - SCOPE_CHANGED: 2 - }, - - /** - * @enum {number} - * @memberof grafeas.v1 - */ - UserInteraction: { - USER_INTERACTION_UNSPECIFIED: 0, - USER_INTERACTION_NONE: 1, - USER_INTERACTION_REQUIRED: 2 - } -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_deployment.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_deployment.js deleted file mode 100644 index 9db83566e5f..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_deployment.js +++ /dev/null @@ -1,98 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * An artifact that can be deployed in some runtime. - * - * @property {string[]} resourceUri - * Required. Resource URI for the artifact being deployed. - * - * @typedef DeploymentNote - * @memberof grafeas.v1 - * @see [grafeas.v1.DeploymentNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/deployment.proto} - */ -const DeploymentNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * The period during which some deployable was active in a runtime. - * - * @property {string} userEmail - * Identity of the user that triggered this deployment. - * - * @property {Object} deployTime - * Required. Beginning of the lifetime of this deployment. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} undeployTime - * End of the lifetime of this deployment. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {string} config - * Configuration used to create this deployment. - * - * @property {string} address - * Address of the runtime element hosting this deployment. - * - * @property {string[]} resourceUri - * Output only. Resource URI for the artifact being deployed taken from - * the deployable field with the same name. - * - * @property {number} platform - * Platform hosting this deployment. - * - * The number should be among the values of [Platform]{@link grafeas.v1.Platform} - * - * @typedef DeploymentOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.DeploymentOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/deployment.proto} - */ -const DeploymentOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Types of platforms. - * - * @enum {number} - * @memberof grafeas.v1 - */ - Platform: { - - /** - * Unknown. - */ - PLATFORM_UNSPECIFIED: 0, - - /** - * Google Container Engine. - */ - GKE: 1, - - /** - * Google App Engine: Flexible Environment. - */ - FLEX: 2, - - /** - * Custom user-defined platform. - */ - CUSTOM: 3 - } -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_discovery.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_discovery.js deleted file mode 100644 index 9550b5f1fc0..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_discovery.js +++ /dev/null @@ -1,136 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A note that indicates a type of analysis a provider would perform. This note - * exists in a provider's project. A `Discovery` occurrence is created in a - * consumer's project at the start of analysis. - * - * @property {number} analysisKind - * Required. Immutable. The kind of analysis that is handled by this - * discovery. - * - * The number should be among the values of [NoteKind]{@link grafeas.v1.NoteKind} - * - * @typedef DiscoveryNote - * @memberof grafeas.v1 - * @see [grafeas.v1.DiscoveryNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/discovery.proto} - */ -const DiscoveryNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Provides information about the analysis status of a discovered resource. - * - * @property {number} continuousAnalysis - * Whether the resource is continuously analyzed. - * - * The number should be among the values of [ContinuousAnalysis]{@link grafeas.v1.ContinuousAnalysis} - * - * @property {number} analysisStatus - * The status of discovery for the resource. - * - * The number should be among the values of [AnalysisStatus]{@link grafeas.v1.AnalysisStatus} - * - * @property {Object} analysisStatusError - * When an error is encountered this will contain a LocalizedMessage under - * details to show to the user. The LocalizedMessage is output only and - * populated by the API. - * - * This object should have the same structure as [Status]{@link google.rpc.Status} - * - * @property {string} cpe - * The CPE of the resource being scanned. - * - * @property {Object} lastScanTime - * The last time this resource was scanned. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @typedef DiscoveryOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.DiscoveryOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/discovery.proto} - */ -const DiscoveryOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Analysis status for a resource. Currently for initial analysis only (not - * updated in continuous analysis). - * - * @enum {number} - * @memberof grafeas.v1 - */ - AnalysisStatus: { - - /** - * Unknown. - */ - ANALYSIS_STATUS_UNSPECIFIED: 0, - - /** - * Resource is known but no action has been taken yet. - */ - PENDING: 1, - - /** - * Resource is being analyzed. - */ - SCANNING: 2, - - /** - * Analysis has finished successfully. - */ - FINISHED_SUCCESS: 3, - - /** - * Analysis has finished unsuccessfully, the analysis itself is in a bad - * state. - */ - FINISHED_FAILED: 4, - - /** - * The resource is known not to be supported - */ - FINISHED_UNSUPPORTED: 5 - }, - - /** - * Whether the resource is continuously analyzed. - * - * @enum {number} - * @memberof grafeas.v1 - */ - ContinuousAnalysis: { - - /** - * Unknown. - */ - CONTINUOUS_ANALYSIS_UNSPECIFIED: 0, - - /** - * The resource is continuously analyzed. - */ - ACTIVE: 1, - - /** - * The resource is ignored for continuous analysis. - */ - INACTIVE: 2 - } -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_grafeas.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_grafeas.js deleted file mode 100644 index d1bb5750292..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_grafeas.js +++ /dev/null @@ -1,566 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * An instance of an analysis type that has been found on a resource. - * - * @property {string} name - * Output only. The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - * - * @property {string} resourceUri - * Required. Immutable. A URI that represents the resource for which the - * occurrence applies. For example, - * `https://gcr.io/project/image@sha256:123abc` for a Docker image. - * - * @property {string} noteName - * Required. Immutable. The analysis note associated with this occurrence, in - * the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be - * used as a filter in list requests. - * - * @property {number} kind - * Output only. This explicitly denotes which of the occurrence details are - * specified. This field can be used as a filter in list requests. - * - * The number should be among the values of [NoteKind]{@link grafeas.v1.NoteKind} - * - * @property {string} remediation - * A description of actions that can be taken to remedy the note. - * - * @property {Object} createTime - * Output only. The time this occurrence was created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} updateTime - * Output only. The time this occurrence was last updated. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} vulnerability - * Describes a security vulnerability. - * - * This object should have the same structure as [VulnerabilityOccurrence]{@link grafeas.v1.VulnerabilityOccurrence} - * - * @property {Object} build - * Describes a verifiable build. - * - * This object should have the same structure as [BuildOccurrence]{@link grafeas.v1.BuildOccurrence} - * - * @property {Object} image - * Describes how this resource derives from the basis in the associated - * note. - * - * This object should have the same structure as [ImageOccurrence]{@link grafeas.v1.ImageOccurrence} - * - * @property {Object} package - * Describes the installation of a package on the linked resource. - * - * This object should have the same structure as [PackageOccurrence]{@link grafeas.v1.PackageOccurrence} - * - * @property {Object} deployment - * Describes the deployment of an artifact on a runtime. - * - * This object should have the same structure as [DeploymentOccurrence]{@link grafeas.v1.DeploymentOccurrence} - * - * @property {Object} discovery - * Describes when a resource was discovered. - * - * This object should have the same structure as [DiscoveryOccurrence]{@link grafeas.v1.DiscoveryOccurrence} - * - * @property {Object} attestation - * Describes an attestation of an artifact. - * - * This object should have the same structure as [AttestationOccurrence]{@link grafeas.v1.AttestationOccurrence} - * - * @property {Object} upgrade - * Describes an available package upgrade on the linked resource. - * - * This object should have the same structure as [UpgradeOccurrence]{@link grafeas.v1.UpgradeOccurrence} - * - * @typedef Occurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.Occurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const Occurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A type of analysis that can be done for a resource. - * - * @property {string} name - * Output only. The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - * - * @property {string} shortDescription - * A one sentence description of this note. - * - * @property {string} longDescription - * A detailed description of this note. - * - * @property {number} kind - * Output only. The type of analysis. This field can be used as a filter in - * list requests. - * - * The number should be among the values of [NoteKind]{@link grafeas.v1.NoteKind} - * - * @property {Object[]} relatedUrl - * URLs associated with this note. - * - * This object should have the same structure as [RelatedUrl]{@link grafeas.v1.RelatedUrl} - * - * @property {Object} expirationTime - * Time of expiration for this note. Empty if note does not expire. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} createTime - * Output only. The time this note was created. This field can be used as a - * filter in list requests. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} updateTime - * Output only. The time this note was last updated. This field can be used as - * a filter in list requests. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {string[]} relatedNoteNames - * Other notes related to this note. - * - * @property {Object} vulnerability - * A note describing a package vulnerability. - * - * This object should have the same structure as [VulnerabilityNote]{@link grafeas.v1.VulnerabilityNote} - * - * @property {Object} build - * A note describing build provenance for a verifiable build. - * - * This object should have the same structure as [BuildNote]{@link grafeas.v1.BuildNote} - * - * @property {Object} image - * A note describing a base image. - * - * This object should have the same structure as [ImageNote]{@link grafeas.v1.ImageNote} - * - * @property {Object} package - * A note describing a package hosted by various package managers. - * - * This object should have the same structure as [PackageNote]{@link grafeas.v1.PackageNote} - * - * @property {Object} deployment - * A note describing something that can be deployed. - * - * This object should have the same structure as [DeploymentNote]{@link grafeas.v1.DeploymentNote} - * - * @property {Object} discovery - * A note describing the initial analysis of a resource. - * - * This object should have the same structure as [DiscoveryNote]{@link grafeas.v1.DiscoveryNote} - * - * @property {Object} attestation - * A note describing an attestation role. - * - * This object should have the same structure as [AttestationNote]{@link grafeas.v1.AttestationNote} - * - * @property {Object} upgrade - * A note describing available package upgrades. - * - * This object should have the same structure as [UpgradeNote]{@link grafeas.v1.UpgradeNote} - * - * @typedef Note - * @memberof grafeas.v1 - * @see [grafeas.v1.Note definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const Note = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to get an occurrence. - * - * @property {string} name - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - * - * @typedef GetOccurrenceRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.GetOccurrenceRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const GetOccurrenceRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to list occurrences. - * - * @property {string} parent - * The name of the project to list occurrences for in the form of - * `projects/[PROJECT_ID]`. - * - * @property {string} filter - * The filter expression. - * - * @property {number} pageSize - * Number of occurrences to return in the list. Must be positive. Max allowed - * page size is 1000. If not specified, page size defaults to 20. - * - * @property {string} pageToken - * Token to provide to skip to a particular spot in the list. - * - * @typedef ListOccurrencesRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.ListOccurrencesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListOccurrencesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Response for listing occurrences. - * - * @property {Object[]} occurrences - * The occurrences requested. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @property {string} nextPageToken - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. - * - * @typedef ListOccurrencesResponse - * @memberof grafeas.v1 - * @see [grafeas.v1.ListOccurrencesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListOccurrencesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to delete an occurrence. - * - * @property {string} name - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - * - * @typedef DeleteOccurrenceRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.DeleteOccurrenceRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const DeleteOccurrenceRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to create a new occurrence. - * - * @property {string} parent - * The name of the project in the form of `projects/[PROJECT_ID]`, under which - * the occurrence is to be created. - * - * @property {Object} occurrence - * The occurrence to create. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @typedef CreateOccurrenceRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.CreateOccurrenceRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const CreateOccurrenceRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to update an occurrence. - * - * @property {string} name - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - * - * @property {Object} occurrence - * The updated occurrence. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @property {Object} updateMask - * The fields to update. - * - * This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask} - * - * @typedef UpdateOccurrenceRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.UpdateOccurrenceRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const UpdateOccurrenceRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to get a note. - * - * @property {string} name - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - * - * @typedef GetNoteRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.GetNoteRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const GetNoteRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to get the note to which the specified occurrence is attached. - * - * @property {string} name - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - * - * @typedef GetOccurrenceNoteRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.GetOccurrenceNoteRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const GetOccurrenceNoteRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to list notes. - * - * @property {string} parent - * The name of the project to list notes for in the form of - * `projects/[PROJECT_ID]`. - * - * @property {string} filter - * The filter expression. - * - * @property {number} pageSize - * Number of notes to return in the list. Must be positive. Max allowed page - * size is 1000. If not specified, page size defaults to 20. - * - * @property {string} pageToken - * Token to provide to skip to a particular spot in the list. - * - * @typedef ListNotesRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.ListNotesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListNotesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Response for listing notes. - * - * @property {Object[]} notes - * The notes requested. - * - * This object should have the same structure as [Note]{@link grafeas.v1.Note} - * - * @property {string} nextPageToken - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. - * - * @typedef ListNotesResponse - * @memberof grafeas.v1 - * @see [grafeas.v1.ListNotesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListNotesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to delete a note. - * - * @property {string} name - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - * - * @typedef DeleteNoteRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.DeleteNoteRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const DeleteNoteRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to create a new note. - * - * @property {string} parent - * The name of the project in the form of `projects/[PROJECT_ID]`, under which - * the note is to be created. - * - * @property {string} noteId - * The ID to use for this note. - * - * @property {Object} note - * The note to create. - * - * This object should have the same structure as [Note]{@link grafeas.v1.Note} - * - * @typedef CreateNoteRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.CreateNoteRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const CreateNoteRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to update a note. - * - * @property {string} name - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - * - * @property {Object} note - * The updated note. - * - * This object should have the same structure as [Note]{@link grafeas.v1.Note} - * - * @property {Object} updateMask - * The fields to update. - * - * This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask} - * - * @typedef UpdateNoteRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.UpdateNoteRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const UpdateNoteRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to list occurrences for a note. - * - * @property {string} name - * The name of the note to list occurrences for in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - * - * @property {string} filter - * The filter expression. - * - * @property {number} pageSize - * Number of occurrences to return in the list. - * - * @property {string} pageToken - * Token to provide to skip to a particular spot in the list. - * - * @typedef ListNoteOccurrencesRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.ListNoteOccurrencesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListNoteOccurrencesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Response for listing occurrences for a note. - * - * @property {Object[]} occurrences - * The occurrences attached to the specified note. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @property {string} nextPageToken - * Token to provide to skip to a particular spot in the list. - * - * @typedef ListNoteOccurrencesResponse - * @memberof grafeas.v1 - * @see [grafeas.v1.ListNoteOccurrencesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const ListNoteOccurrencesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to create notes in batch. - * - * @property {string} parent - * The name of the project in the form of `projects/[PROJECT_ID]`, under which - * the notes are to be created. - * - * @property {Object.} notes - * The notes to create. Max allowed length is 1000. - * - * @typedef BatchCreateNotesRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.BatchCreateNotesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const BatchCreateNotesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Response for creating notes in batch. - * - * @property {Object[]} notes - * The notes that were created. - * - * This object should have the same structure as [Note]{@link grafeas.v1.Note} - * - * @typedef BatchCreateNotesResponse - * @memberof grafeas.v1 - * @see [grafeas.v1.BatchCreateNotesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const BatchCreateNotesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request to create occurrences in batch. - * - * @property {string} parent - * The name of the project in the form of `projects/[PROJECT_ID]`, under which - * the occurrences are to be created. - * - * @property {Object[]} occurrences - * The occurrences to create. Max allowed length is 1000. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @typedef BatchCreateOccurrencesRequest - * @memberof grafeas.v1 - * @see [grafeas.v1.BatchCreateOccurrencesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const BatchCreateOccurrencesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Response for creating occurrences in batch. - * - * @property {Object[]} occurrences - * The occurrences that were created. - * - * This object should have the same structure as [Occurrence]{@link grafeas.v1.Occurrence} - * - * @typedef BatchCreateOccurrencesResponse - * @memberof grafeas.v1 - * @see [grafeas.v1.BatchCreateOccurrencesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/grafeas.proto} - */ -const BatchCreateOccurrencesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_image.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_image.js deleted file mode 100644 index fc9cc152d52..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_image.js +++ /dev/null @@ -1,115 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Layer holds metadata specific to a layer of a Docker image. - * - * @property {string} directive - * Required. The recovered Dockerfile directive used to construct this layer. - * See https://docs.docker.com/engine/reference/builder/ for more information. - * - * @property {string} arguments - * The recovered arguments to the Dockerfile directive. - * - * @typedef Layer - * @memberof grafeas.v1 - * @see [grafeas.v1.Layer definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/image.proto} - */ -const Layer = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A set of properties that uniquely identify a given Docker image. - * - * @property {string} v1Name - * Required. The layer ID of the final layer in the Docker image's v1 - * representation. - * - * @property {string[]} v2Blob - * Required. The ordered list of v2 blobs that represent a given image. - * - * @property {string} v2Name - * Output only. The name of the image's v2 blobs computed via: - * [bottom] := v2_blob[bottom] - * [N] := sha256(v2_blob[N] + " " + v2_name[N+1]) - * Only the name of the final blob is kept. - * - * @typedef Fingerprint - * @memberof grafeas.v1 - * @see [grafeas.v1.Fingerprint definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/image.proto} - */ -const Fingerprint = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Basis describes the base image portion (Note) of the DockerImage - * relationship. Linked occurrences are derived from this or an equivalent image - * via: - * FROM - * Or an equivalent reference, e.g., a tag of the resource_url. - * - * @property {string} resourceUrl - * Required. Immutable. The resource_url for the resource representing the - * basis of associated occurrence images. - * - * @property {Object} fingerprint - * Required. Immutable. The fingerprint of the base image. - * - * This object should have the same structure as [Fingerprint]{@link grafeas.v1.Fingerprint} - * - * @typedef ImageNote - * @memberof grafeas.v1 - * @see [grafeas.v1.ImageNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/image.proto} - */ -const ImageNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Details of the derived image portion of the DockerImage relationship. This - * image would be produced from a Dockerfile with FROM . - * - * @property {Object} fingerprint - * Required. The fingerprint of the derived image. - * - * This object should have the same structure as [Fingerprint]{@link grafeas.v1.Fingerprint} - * - * @property {number} distance - * Output only. The number of layers by which this image differs from the - * associated image basis. - * - * @property {Object[]} layerInfo - * This contains layer-specific metadata, if populated it has length - * "distance" and is ordered with [distance] being the layer immediately - * following the base image and [1] being the final layer. - * - * This object should have the same structure as [Layer]{@link grafeas.v1.Layer} - * - * @property {string} baseResourceUrl - * Output only. This contains the base image URL for the derived image - * occurrence. - * - * @typedef ImageOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.ImageOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/image.proto} - */ -const ImageOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_package.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_package.js deleted file mode 100644 index 81829971257..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_package.js +++ /dev/null @@ -1,201 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * This represents a particular channel of distribution for a given package. - * E.g., Debian's jessie-backports dpkg mirror. - * - * @property {string} cpeUri - * Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) - * denoting the package manager version distributing a package. - * - * @property {number} architecture - * The CPU architecture for which packages in this distribution channel were - * built. - * - * The number should be among the values of [Architecture]{@link grafeas.v1.Architecture} - * - * @property {Object} latestVersion - * The latest available version of this package in this distribution channel. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {string} maintainer - * A freeform string denoting the maintainer of this package. - * - * @property {string} url - * The distribution channel-specific homepage for this package. - * - * @property {string} description - * The distribution channel-specific description of this package. - * - * @typedef Distribution - * @memberof grafeas.v1 - * @see [grafeas.v1.Distribution definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/package.proto} - */ -const Distribution = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * An occurrence of a particular package installation found within a system's - * filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. - * - * @property {string} cpeUri - * Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) - * denoting the package manager version distributing a package. - * - * @property {Object} version - * The version installed at this location. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {string} path - * The path from which we gathered that this package/version is installed. - * - * @typedef Location - * @memberof grafeas.v1 - * @see [grafeas.v1.Location definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/package.proto} - */ -const Location = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * This represents a particular package that is distributed over various - * channels. E.g., glibc (aka libc6) is distributed by many, at various - * versions. - * - * @property {string} name - * Required. Immutable. The name of the package. - * - * @property {Object[]} distribution - * The various channels by which a package is distributed. - * - * This object should have the same structure as [Distribution]{@link grafeas.v1.Distribution} - * - * @typedef PackageNote - * @memberof grafeas.v1 - * @see [grafeas.v1.PackageNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/package.proto} - */ -const PackageNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Details on how a particular software package was installed on a system. - * - * @property {string} name - * Output only. The name of the installed package. - * - * @property {Object[]} location - * Required. All of the places within the filesystem versions of this package - * have been found. - * - * This object should have the same structure as [Location]{@link grafeas.v1.Location} - * - * @typedef PackageOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.PackageOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/package.proto} - */ -const PackageOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Version contains structured information about the version of a package. - * - * @property {number} epoch - * Used to correct mistakes in the version numbering scheme. - * - * @property {string} name - * Required only when version kind is NORMAL. The main part of the version - * name. - * - * @property {string} revision - * The iteration of the package build from the above version. - * - * @property {number} kind - * Required. Distinguishes between sentinel MIN/MAX versions and normal - * versions. - * - * The number should be among the values of [VersionKind]{@link grafeas.v1.VersionKind} - * - * @property {string} fullName - * Human readable version string. This string is of the form - * :- and is only set when kind is NORMAL. - * - * @typedef Version - * @memberof grafeas.v1 - * @see [grafeas.v1.Version definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/package.proto} - */ -const Version = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Whether this is an ordinary package version or a sentinel MIN/MAX version. - * - * @enum {number} - * @memberof grafeas.v1 - */ - VersionKind: { - - /** - * Unknown. - */ - VERSION_KIND_UNSPECIFIED: 0, - - /** - * A standard package version. - */ - NORMAL: 1, - - /** - * A special version representing negative infinity. - */ - MINIMUM: 2, - - /** - * A special version representing positive infinity. - */ - MAXIMUM: 3 - } -}; - -/** - * Instruction set architectures supported by various package managers. - * - * @enum {number} - * @memberof grafeas.v1 - */ -const Architecture = { - - /** - * Unknown architecture. - */ - ARCHITECTURE_UNSPECIFIED: 0, - - /** - * X86 architecture. - */ - X86: 1, - - /** - * X64 architecture. - */ - X64: 2 -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_provenance.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_provenance.js deleted file mode 100644 index 9f9d2443308..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_provenance.js +++ /dev/null @@ -1,398 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Provenance of a build. Contains all information needed to verify the full - * details about the build from source to completion. - * - * @property {string} id - * Required. Unique identifier of the build. - * - * @property {string} projectId - * ID of the project. - * - * @property {Object[]} commands - * Commands requested by the build. - * - * This object should have the same structure as [Command]{@link grafeas.v1.Command} - * - * @property {Object[]} builtArtifacts - * Output of the build. - * - * This object should have the same structure as [Artifact]{@link grafeas.v1.Artifact} - * - * @property {Object} createTime - * Time at which the build was created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} startTime - * Time at which execution of the build was started. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} endTime - * Time at which execution of the build was finished. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {string} creator - * E-mail address of the user who initiated this build. Note that this was the - * user's e-mail address at the time the build was initiated; this address may - * not represent the same end-user for all time. - * - * @property {string} logsUri - * URI where any logs for this provenance were written. - * - * @property {Object} sourceProvenance - * Details of the Source input to the build. - * - * This object should have the same structure as [Source]{@link grafeas.v1.Source} - * - * @property {string} triggerId - * Trigger identifier if the build was triggered automatically; empty if not. - * - * @property {Object.} buildOptions - * Special options applied to this build. This is a catch-all field where - * build providers can enter any desired additional details. - * - * @property {string} builderVersion - * Version string of the builder at the time this build was executed. - * - * @typedef BuildProvenance - * @memberof grafeas.v1 - * @see [grafeas.v1.BuildProvenance definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const BuildProvenance = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Source describes the location of the source used for the build. - * - * @property {string} artifactStorageSourceUri - * If provided, the input binary artifacts for the build came from this - * location. - * - * @property {Object.} fileHashes - * Hash(es) of the build source, which can be used to verify that the original - * source integrity was maintained in the build. - * - * The keys to this map are file paths used as build source and the values - * contain the hash values for those files. - * - * If the build source came in a single package such as a gzipped tarfile - * (.tar.gz), the FileHash will be for the single path to that file. - * - * @property {Object} context - * If provided, the source code used for the build came from this location. - * - * This object should have the same structure as [SourceContext]{@link grafeas.v1.SourceContext} - * - * @property {Object[]} additionalContexts - * If provided, some of the source code used for the build may be found in - * these locations, in the case where the source repository had multiple - * remotes or submodules. This list will not include the context specified in - * the context field. - * - * This object should have the same structure as [SourceContext]{@link grafeas.v1.SourceContext} - * - * @typedef Source - * @memberof grafeas.v1 - * @see [grafeas.v1.Source definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const Source = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container message for hashes of byte content of files, used in source - * messages to verify integrity of source input to the build. - * - * @property {Object[]} fileHash - * Required. Collection of file hashes. - * - * This object should have the same structure as [Hash]{@link grafeas.v1.Hash} - * - * @typedef FileHashes - * @memberof grafeas.v1 - * @see [grafeas.v1.FileHashes definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const FileHashes = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container message for hash values. - * - * @property {string} type - * Required. The type of hash that was performed, e.g. "SHA-256". - * - * @property {Buffer} value - * Required. The hash value. - * - * @typedef Hash - * @memberof grafeas.v1 - * @see [grafeas.v1.Hash definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const Hash = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Command describes a step performed as part of the build pipeline. - * - * @property {string} name - * Required. Name of the command, as presented on the command line, or if the - * command is packaged as a Docker container, as presented to `docker pull`. - * - * @property {string[]} env - * Environment variables set before running this command. - * - * @property {string[]} args - * Command-line arguments used when executing this command. - * - * @property {string} dir - * Working directory (relative to project source root) used when running this - * command. - * - * @property {string} id - * Optional unique identifier for this command, used in wait_for to reference - * this command as a dependency. - * - * @property {string[]} waitFor - * The ID(s) of the command(s) that this command depends on. - * - * @typedef Command - * @memberof grafeas.v1 - * @see [grafeas.v1.Command definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const Command = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Artifact describes a build product. - * - * @property {string} checksum - * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a - * container. - * - * @property {string} id - * Artifact ID, if any; for container images, this will be a URL by digest - * like `gcr.io/projectID/imagename@sha256:123456`. - * - * @property {string[]} names - * Related artifact names. This may be the path to a binary or jar file, or in - * the case of a container build, the name used to push the container image to - * Google Container Registry, as presented to `docker push`. Note that a - * single Artifact ID can have multiple names, for example if two tags are - * applied to one image. - * - * @typedef Artifact - * @memberof grafeas.v1 - * @see [grafeas.v1.Artifact definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const Artifact = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A SourceContext is a reference to a tree of files. A SourceContext together - * with a path point to a unique revision of a single file or directory. - * - * @property {Object} cloudRepo - * A SourceContext referring to a revision in a Google Cloud Source Repo. - * - * This object should have the same structure as [CloudRepoSourceContext]{@link grafeas.v1.CloudRepoSourceContext} - * - * @property {Object} gerrit - * A SourceContext referring to a Gerrit project. - * - * This object should have the same structure as [GerritSourceContext]{@link grafeas.v1.GerritSourceContext} - * - * @property {Object} git - * A SourceContext referring to any third party Git repo (e.g., GitHub). - * - * This object should have the same structure as [GitSourceContext]{@link grafeas.v1.GitSourceContext} - * - * @property {Object.} labels - * Labels with user defined metadata. - * - * @typedef SourceContext - * @memberof grafeas.v1 - * @see [grafeas.v1.SourceContext definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const SourceContext = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * An alias to a repo revision. - * - * @property {number} kind - * The alias kind. - * - * The number should be among the values of [Kind]{@link grafeas.v1.Kind} - * - * @property {string} name - * The alias name. - * - * @typedef AliasContext - * @memberof grafeas.v1 - * @see [grafeas.v1.AliasContext definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const AliasContext = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * The type of an alias. - * - * @enum {number} - * @memberof grafeas.v1 - */ - Kind: { - - /** - * Unknown. - */ - KIND_UNSPECIFIED: 0, - - /** - * Git tag. - */ - FIXED: 1, - - /** - * Git branch. - */ - MOVABLE: 2, - - /** - * Used to specify non-standard aliases. For example, if a Git repo has a - * ref named "refs/foo/bar". - */ - OTHER: 4 - } -}; - -/** - * A CloudRepoSourceContext denotes a particular revision in a Google Cloud - * Source Repo. - * - * @property {Object} repoId - * The ID of the repo. - * - * This object should have the same structure as [RepoId]{@link grafeas.v1.RepoId} - * - * @property {string} revisionId - * A revision ID. - * - * @property {Object} aliasContext - * An alias, which may be a branch or tag. - * - * This object should have the same structure as [AliasContext]{@link grafeas.v1.AliasContext} - * - * @typedef CloudRepoSourceContext - * @memberof grafeas.v1 - * @see [grafeas.v1.CloudRepoSourceContext definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const CloudRepoSourceContext = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A SourceContext referring to a Gerrit project. - * - * @property {string} hostUri - * The URI of a running Gerrit instance. - * - * @property {string} gerritProject - * The full project name within the host. Projects may be nested, so - * "project/subproject" is a valid project name. The "repo name" is the - * hostURI/project. - * - * @property {string} revisionId - * A revision (commit) ID. - * - * @property {Object} aliasContext - * An alias, which may be a branch or tag. - * - * This object should have the same structure as [AliasContext]{@link grafeas.v1.AliasContext} - * - * @typedef GerritSourceContext - * @memberof grafeas.v1 - * @see [grafeas.v1.GerritSourceContext definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const GerritSourceContext = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A GitSourceContext denotes a particular revision in a third party Git - * repository (e.g., GitHub). - * - * @property {string} url - * Git repository URL. - * - * @property {string} revisionId - * Git commit hash. - * - * @typedef GitSourceContext - * @memberof grafeas.v1 - * @see [grafeas.v1.GitSourceContext definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const GitSourceContext = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A unique identifier for a Cloud Repo. - * - * @property {Object} projectRepoId - * A combination of a project ID and a repo name. - * - * This object should have the same structure as [ProjectRepoId]{@link grafeas.v1.ProjectRepoId} - * - * @property {string} uid - * A server-assigned, globally unique identifier. - * - * @typedef RepoId - * @memberof grafeas.v1 - * @see [grafeas.v1.RepoId definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const RepoId = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Selects a repo using a Google Cloud Platform project ID (e.g., - * winged-cargo-31) and a repo name within that project. - * - * @property {string} projectId - * The ID of the project. - * - * @property {string} repoName - * The name of the repo. Leave empty for the default repo. - * - * @typedef ProjectRepoId - * @memberof grafeas.v1 - * @see [grafeas.v1.ProjectRepoId definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/provenance.proto} - */ -const ProjectRepoId = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_upgrade.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_upgrade.js deleted file mode 100644 index 23b4f458364..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_upgrade.js +++ /dev/null @@ -1,190 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * An Upgrade Note represents a potential upgrade of a package to a given - * version. For each package version combination (i.e. bash 4.0, bash 4.1, - * bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field - * represents the information related to the update. - * - * @property {string} package - * Required for non-Windows OS. The package this Upgrade is for. - * - * @property {Object} version - * Required for non-Windows OS. The version of the package in machine + human - * readable form. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {Object[]} distributions - * Metadata about the upgrade for each specific operating system. - * - * This object should have the same structure as [UpgradeDistribution]{@link grafeas.v1.UpgradeDistribution} - * - * @property {Object} windowsUpdate - * Required for Windows OS. Represents the metadata about the Windows update. - * - * This object should have the same structure as [WindowsUpdate]{@link grafeas.v1.WindowsUpdate} - * - * @typedef UpgradeNote - * @memberof grafeas.v1 - * @see [grafeas.v1.UpgradeNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ -const UpgradeNote = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * The Upgrade Distribution represents metadata about the Upgrade for each - * operating system (CPE). Some distributions have additional metadata around - * updates, classifying them into various categories and severities. - * - * @property {string} cpeUri - * Required - The specific operating system this metadata applies to. See - * https://cpe.mitre.org/specification/. - * - * @property {string} classification - * The operating system classification of this Upgrade, as specified by the - * upstream operating system upgrade feed. For Windows the classification is - * one of the category_ids listed at - * https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) - * - * @property {string} severity - * The severity as specified by the upstream operating system. - * - * @property {string[]} cve - * The cve tied to this Upgrade. - * - * @typedef UpgradeDistribution - * @memberof grafeas.v1 - * @see [grafeas.v1.UpgradeDistribution definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ -const UpgradeDistribution = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Windows Update represents the metadata about the update for the Windows - * operating system. The fields in this message come from the Windows Update API - * documented at - * https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. - * - * @property {Object} identity - * Required - The unique identifier for the update. - * - * This object should have the same structure as [Identity]{@link grafeas.v1.Identity} - * - * @property {string} title - * The localized title of the update. - * - * @property {string} description - * The localized description of the update. - * - * @property {Object[]} categories - * The list of categories to which the update belongs. - * - * This object should have the same structure as [Category]{@link grafeas.v1.Category} - * - * @property {string[]} kbArticleIds - * The Microsoft Knowledge Base article IDs that are associated with the - * update. - * - * @property {string} supportUrl - * The hyperlink to the support information for the update. - * - * @property {Object} lastPublishedTimestamp - * The last published timestamp of the update. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @typedef WindowsUpdate - * @memberof grafeas.v1 - * @see [grafeas.v1.WindowsUpdate definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ -const WindowsUpdate = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * The unique identifier of the update. - * - * @property {string} updateId - * The revision independent identifier of the update. - * - * @property {number} revision - * The revision number of the update. - * - * @typedef Identity - * @memberof grafeas.v1 - * @see [grafeas.v1.WindowsUpdate.Identity definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ - Identity: { - // This is for documentation. Actual contents will be loaded by gRPC. - }, - - /** - * The category to which the update belongs. - * - * @property {string} categoryId - * The identifier of the category. - * - * @property {string} name - * The localized name of the category. - * - * @typedef Category - * @memberof grafeas.v1 - * @see [grafeas.v1.WindowsUpdate.Category definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ - Category: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * An Upgrade Occurrence represents that a specific resource_url could install a - * specific upgrade. This presence is supplied via local sources (i.e. it is - * present in the mirror and the running system has noticed its availability). - * For Windows, both distribution and windows_update contain information for the - * Windows update. - * - * @property {string} package - * Required for non-Windows OS. The package this Upgrade is for. - * - * @property {Object} parsedVersion - * Required for non-Windows OS. The version of the package in a machine + - * human readable form. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {Object} distribution - * Metadata about the upgrade for available for the specific operating system - * for the resource_url. This allows efficient filtering, as well as - * making it easier to use the occurrence. - * - * This object should have the same structure as [UpgradeDistribution]{@link grafeas.v1.UpgradeDistribution} - * - * @property {Object} windowsUpdate - * Required for Windows OS. Represents the metadata about the Windows update. - * - * This object should have the same structure as [WindowsUpdate]{@link grafeas.v1.WindowsUpdate} - * - * @typedef UpgradeOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.UpgradeOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/upgrade.proto} - */ -const UpgradeOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/grafeas/src/v1/doc/grafeas/v1/doc_vulnerability.js b/packages/grafeas/src/v1/doc/grafeas/v1/doc_vulnerability.js deleted file mode 100644 index c73ee6d77f6..00000000000 --- a/packages/grafeas/src/v1/doc/grafeas/v1/doc_vulnerability.js +++ /dev/null @@ -1,317 +0,0 @@ -// Copyright 2020 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A security vulnerability that can be found in resources. - * - * @property {number} cvssScore - * The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 - * where 0 indicates low severity and 10 indicates high severity. - * - * @property {number} severity - * The note provider assigned severity of this vulnerability. - * - * The number should be among the values of [Severity]{@link grafeas.v1.Severity} - * - * @property {Object[]} details - * Details of all known distros and packages affected by this vulnerability. - * - * This object should have the same structure as [Detail]{@link grafeas.v1.Detail} - * - * @property {Object} cvssV3 - * The full description of the CVSSv3 for this vulnerability. - * - * This object should have the same structure as [CVSSv3]{@link grafeas.v1.CVSSv3} - * - * @property {Object[]} windowsDetails - * Windows details get their own format because the information format and - * model don't match a normal detail. Specifically Windows updates are done as - * patches, thus Windows vulnerabilities really are a missing package, rather - * than a package being at an incorrect version. - * - * This object should have the same structure as [WindowsDetail]{@link grafeas.v1.WindowsDetail} - * - * @property {Object} sourceUpdateTime - * The time this information was last changed at the source. This is an - * upstream timestamp from the underlying information source - e.g. Ubuntu - * security tracker. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @typedef VulnerabilityNote - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityNote definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ -const VulnerabilityNote = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * A detail for a distro and package affected by this vulnerability and its - * associated fix (if one is available). - * - * @property {string} severityName - * The distro assigned severity of this vulnerability. - * - * @property {string} description - * A vendor-specific description of this vulnerability. - * - * @property {string} packageType - * The type of package; whether native or non native (e.g., ruby gems, - * node.js packages, etc.). - * - * @property {string} affectedCpeUri - * Required. The [CPE URI](https://cpe.mitre.org/specification/) this - * vulnerability affects. - * - * @property {string} affectedPackage - * Required. The package this vulnerability affects. - * - * @property {Object} affectedVersionStart - * The version number at the start of an interval in which this - * vulnerability exists. A vulnerability can affect a package between - * version numbers that are disjoint sets of intervals (example: - * [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be - * represented in its own Detail. If a specific affected version is provided - * by a vulnerability database, affected_version_start and - * affected_version_end will be the same in that Detail. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {Object} affectedVersionEnd - * The version number at the end of an interval in which this vulnerability - * exists. A vulnerability can affect a package between version numbers - * that are disjoint sets of intervals (example: [1.0.0-1.1.0], - * [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its - * own Detail. If a specific affected version is provided by a vulnerability - * database, affected_version_start and affected_version_end will be the - * same in that Detail. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {string} fixedCpeUri - * The distro recommended [CPE URI](https://cpe.mitre.org/specification/) - * to update to that contains a fix for this vulnerability. It is possible - * for this to be different from the affected_cpe_uri. - * - * @property {string} fixedPackage - * The distro recommended package to update to that contains a fix for this - * vulnerability. It is possible for this to be different from the - * affected_package. - * - * @property {Object} fixedVersion - * The distro recommended version to update to that contains a - * fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no - * such version is yet available. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {boolean} isObsolete - * Whether this detail is obsolete. Occurrences are expected not to point to - * obsolete details. - * - * @property {Object} sourceUpdateTime - * The time this information was last changed at the source. This is an - * upstream timestamp from the underlying information source - e.g. Ubuntu - * security tracker. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @typedef Detail - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityNote.Detail definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ - Detail: { - // This is for documentation. Actual contents will be loaded by gRPC. - }, - - /** - * @property {string} cpeUri - * Required. The [CPE URI](https://cpe.mitre.org/specification/) this - * vulnerability affects. - * - * @property {string} name - * Required. The name of this vulnerability. - * - * @property {string} description - * The description of this vulnerability. - * - * @property {Object[]} fixingKbs - * Required. The names of the KBs which have hotfixes to mitigate this - * vulnerability. Note that there may be multiple hotfixes (and thus - * multiple KBs) that mitigate a given vulnerability. Currently any listed - * KBs presence is considered a fix. - * - * This object should have the same structure as [KnowledgeBase]{@link grafeas.v1.KnowledgeBase} - * - * @typedef WindowsDetail - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityNote.WindowsDetail definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ - WindowsDetail: { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * @property {string} name - * The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - * - * @property {string} url - * A link to the KB in the [Windows update catalog] - * (https://www.catalog.update.microsoft.com/). - * - * @typedef KnowledgeBase - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityNote.WindowsDetail.KnowledgeBase definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ - KnowledgeBase: { - // This is for documentation. Actual contents will be loaded by gRPC. - } - } -}; - -/** - * An occurrence of a severity vulnerability on a resource. - * - * @property {string} type - * The type of package; whether native or non native (e.g., ruby gems, node.js - * packages, etc.). - * - * @property {number} severity - * Output only. The note provider assigned severity of this vulnerability. - * - * The number should be among the values of [Severity]{@link grafeas.v1.Severity} - * - * @property {number} cvssScore - * Output only. The CVSS score of this vulnerability. CVSS score is on a - * scale of 0 - 10 where 0 indicates low severity and 10 indicates high - * severity. - * - * @property {Object[]} packageIssue - * Required. The set of affected locations and their fixes (if available) - * within the associated resource. - * - * This object should have the same structure as [PackageIssue]{@link grafeas.v1.PackageIssue} - * - * @property {string} shortDescription - * Output only. A one sentence description of this vulnerability. - * - * @property {string} longDescription - * Output only. A detailed description of this vulnerability. - * - * @property {Object[]} relatedUrls - * Output only. URLs related to this vulnerability. - * - * This object should have the same structure as [RelatedUrl]{@link grafeas.v1.RelatedUrl} - * - * @property {number} effectiveSeverity - * The distro assigned severity for this vulnerability when it is available, - * otherwise this is the note provider assigned severity. - * - * The number should be among the values of [Severity]{@link grafeas.v1.Severity} - * - * @property {boolean} fixAvailable - * Output only. Whether at least one of the affected packages has a fix - * available. - * - * @typedef VulnerabilityOccurrence - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityOccurrence definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ -const VulnerabilityOccurrence = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * A detail for a distro and package this vulnerability occurrence was found - * in and its associated fix (if one is available). - * - * @property {string} affectedCpeUri - * Required. The [CPE URI](https://cpe.mitre.org/specification/) this - * vulnerability was found in. - * - * @property {string} affectedPackage - * Required. The package this vulnerability was found in. - * - * @property {Object} affectedVersion - * Required. The version of the package that is installed on the resource - * affected by this vulnerability. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {string} fixedCpeUri - * The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability - * was fixed in. It is possible for this to be different from the - * affected_cpe_uri. - * - * @property {string} fixedPackage - * The package this vulnerability was fixed in. It is possible for this to - * be different from the affected_package. - * - * @property {Object} fixedVersion - * Required. The version of the package this vulnerability was fixed in. - * Setting this to VersionKind.MAXIMUM means no fix is yet available. - * - * This object should have the same structure as [Version]{@link grafeas.v1.Version} - * - * @property {boolean} fixAvailable - * Output only. Whether a fix is available for this package. - * - * @typedef PackageIssue - * @memberof grafeas.v1 - * @see [grafeas.v1.VulnerabilityOccurrence.PackageIssue definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/grafeas/v1/vulnerability.proto} - */ - PackageIssue: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * Note provider assigned severity/impact ranking. - * - * @enum {number} - * @memberof grafeas.v1 - */ -const Severity = { - - /** - * Unknown. - */ - SEVERITY_UNSPECIFIED: 0, - - /** - * Minimal severity. - */ - MINIMAL: 1, - - /** - * Low severity. - */ - LOW: 2, - - /** - * Medium severity. - */ - MEDIUM: 3, - - /** - * High severity. - */ - HIGH: 4, - - /** - * Critical severity. - */ - CRITICAL: 5 -}; \ No newline at end of file