Skip to content

Commit b797305

Browse files
feat(ondemandscanning): update the API
#### ondemandscanning:v1beta1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1BaseImage.description - schemas.GrafeasV1BaseImage.id - schemas.GrafeasV1BaseImage.properties.layerCount.description - schemas.GrafeasV1BaseImage.properties.layerCount.format - schemas.GrafeasV1BaseImage.properties.layerCount.type - schemas.GrafeasV1BaseImage.properties.name.description - schemas.GrafeasV1BaseImage.properties.name.type - schemas.GrafeasV1BaseImage.properties.repository.description - schemas.GrafeasV1BaseImage.properties.repository.type - schemas.GrafeasV1BaseImage.type - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1FileLocation.properties.layerDetails.description - schemas.GrafeasV1LayerDetails.description - schemas.GrafeasV1LayerDetails.id - schemas.GrafeasV1LayerDetails.properties.baseImages.description - schemas.GrafeasV1LayerDetails.properties.baseImages.items.$ref - schemas.GrafeasV1LayerDetails.properties.baseImages.type - schemas.GrafeasV1LayerDetails.properties.command.description - schemas.GrafeasV1LayerDetails.properties.command.type - schemas.GrafeasV1LayerDetails.properties.diffId.description - schemas.GrafeasV1LayerDetails.properties.diffId.type - schemas.GrafeasV1LayerDetails.properties.index.description - schemas.GrafeasV1LayerDetails.properties.index.format - schemas.GrafeasV1LayerDetails.properties.index.type - schemas.GrafeasV1LayerDetails.type - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.PackageData.properties.layerDetails.$ref #### ondemandscanning:v1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1BaseImage.description - schemas.GrafeasV1BaseImage.id - schemas.GrafeasV1BaseImage.properties.layerCount.description - schemas.GrafeasV1BaseImage.properties.layerCount.format - schemas.GrafeasV1BaseImage.properties.layerCount.type - schemas.GrafeasV1BaseImage.properties.name.description - schemas.GrafeasV1BaseImage.properties.name.type - schemas.GrafeasV1BaseImage.properties.repository.description - schemas.GrafeasV1BaseImage.properties.repository.type - schemas.GrafeasV1BaseImage.type - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1FileLocation.properties.layerDetails.description - schemas.GrafeasV1LayerDetails.description - schemas.GrafeasV1LayerDetails.id - schemas.GrafeasV1LayerDetails.properties.baseImages.description - schemas.GrafeasV1LayerDetails.properties.baseImages.items.$ref - schemas.GrafeasV1LayerDetails.properties.baseImages.type - schemas.GrafeasV1LayerDetails.properties.command.description - schemas.GrafeasV1LayerDetails.properties.command.type - schemas.GrafeasV1LayerDetails.properties.diffId.description - schemas.GrafeasV1LayerDetails.properties.diffId.type - schemas.GrafeasV1LayerDetails.properties.index.description - schemas.GrafeasV1LayerDetails.properties.index.format - schemas.GrafeasV1LayerDetails.properties.index.type - schemas.GrafeasV1LayerDetails.type - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.PackageData.properties.layerDetails.$ref
1 parent 0d8b675 commit b797305

File tree

4 files changed

+374
-2
lines changed

4 files changed

+374
-2
lines changed

discovery/ondemandscanning-v1.json

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@
339339
}
340340
}
341341
},
342-
"revision": "20241209",
342+
"revision": "20250217",
343343
"rootUrl": "https://ondemandscanning.googleapis.com/",
344344
"schemas": {
345345
"AliasContext": {
@@ -507,6 +507,26 @@
507507
},
508508
"type": "object"
509509
},
510+
"BaseImage": {
511+
"description": "BaseImage describes a base image of a container image.",
512+
"id": "BaseImage",
513+
"properties": {
514+
"layerCount": {
515+
"description": "The number of layers that the base image is composed of.",
516+
"format": "int32",
517+
"type": "integer"
518+
},
519+
"name": {
520+
"description": "The name of the base image.",
521+
"type": "string"
522+
},
523+
"repository": {
524+
"description": "The repository name in which the base image is from.",
525+
"type": "string"
526+
}
527+
},
528+
"type": "object"
529+
},
510530
"BinarySourceInfo": {
511531
"id": "BinarySourceInfo",
512532
"properties": {
@@ -1174,6 +1194,9 @@
11741194
"filePath": {
11751195
"description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.",
11761196
"type": "string"
1197+
},
1198+
"layerDetails": {
1199+
"$ref": "LayerDetails"
11771200
}
11781201
},
11791202
"type": "object"
@@ -1238,13 +1261,64 @@
12381261
},
12391262
"type": "object"
12401263
},
1264+
"GrafeasV1BaseImage": {
1265+
"description": "BaseImage describes a base image of a container image.",
1266+
"id": "GrafeasV1BaseImage",
1267+
"properties": {
1268+
"layerCount": {
1269+
"description": "The number of layers that the base image is composed of.",
1270+
"format": "int32",
1271+
"type": "integer"
1272+
},
1273+
"name": {
1274+
"description": "The name of the base image.",
1275+
"type": "string"
1276+
},
1277+
"repository": {
1278+
"description": "The repository name in which the base image is from.",
1279+
"type": "string"
1280+
}
1281+
},
1282+
"type": "object"
1283+
},
12411284
"GrafeasV1FileLocation": {
12421285
"description": "Indicates the location at which a package was found.",
12431286
"id": "GrafeasV1FileLocation",
12441287
"properties": {
12451288
"filePath": {
12461289
"description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.",
12471290
"type": "string"
1291+
},
1292+
"layerDetails": {
1293+
"$ref": "GrafeasV1LayerDetails",
1294+
"description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)."
1295+
}
1296+
},
1297+
"type": "object"
1298+
},
1299+
"GrafeasV1LayerDetails": {
1300+
"description": "Details about the layer a package was found in.",
1301+
"id": "GrafeasV1LayerDetails",
1302+
"properties": {
1303+
"baseImages": {
1304+
"description": "The base images the layer is found within.",
1305+
"items": {
1306+
"$ref": "GrafeasV1BaseImage"
1307+
},
1308+
"type": "array"
1309+
},
1310+
"command": {
1311+
"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.",
1312+
"type": "string"
1313+
},
1314+
"diffId": {
1315+
"description": "The diff ID (typically a sha256 hash) of the layer in the container image.",
1316+
"type": "string"
1317+
},
1318+
"index": {
1319+
"description": "The index of the layer in the container image.",
1320+
"format": "int32",
1321+
"type": "integer"
12481322
}
12491323
},
12501324
"type": "object"
@@ -1562,6 +1636,33 @@
15621636
},
15631637
"type": "object"
15641638
},
1639+
"LayerDetails": {
1640+
"description": "Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto.",
1641+
"id": "LayerDetails",
1642+
"properties": {
1643+
"baseImages": {
1644+
"description": "The base images the layer is found within.",
1645+
"items": {
1646+
"$ref": "BaseImage"
1647+
},
1648+
"type": "array"
1649+
},
1650+
"command": {
1651+
"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.",
1652+
"type": "string"
1653+
},
1654+
"diffId": {
1655+
"description": "The diff ID (sha256 hash) of the layer in the container image.",
1656+
"type": "string"
1657+
},
1658+
"index": {
1659+
"description": "The index of the layer in the container image.",
1660+
"format": "int32",
1661+
"type": "integer"
1662+
}
1663+
},
1664+
"type": "object"
1665+
},
15651666
"License": {
15661667
"description": "License information.",
15671668
"id": "License",
@@ -1903,6 +2004,9 @@
19032004
"description": "HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.",
19042005
"type": "string"
19052006
},
2007+
"layerDetails": {
2008+
"$ref": "LayerDetails"
2009+
},
19062010
"licenses": {
19072011
"description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.",
19082012
"items": {

discovery/ondemandscanning-v1beta1.json

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@
339339
}
340340
}
341341
},
342-
"revision": "20241209",
342+
"revision": "20250217",
343343
"rootUrl": "https://ondemandscanning.googleapis.com/",
344344
"schemas": {
345345
"AliasContext": {
@@ -502,6 +502,26 @@
502502
},
503503
"type": "object"
504504
},
505+
"BaseImage": {
506+
"description": "BaseImage describes a base image of a container image.",
507+
"id": "BaseImage",
508+
"properties": {
509+
"layerCount": {
510+
"description": "The number of layers that the base image is composed of.",
511+
"format": "int32",
512+
"type": "integer"
513+
},
514+
"name": {
515+
"description": "The name of the base image.",
516+
"type": "string"
517+
},
518+
"repository": {
519+
"description": "The repository name in which the base image is from.",
520+
"type": "string"
521+
}
522+
},
523+
"type": "object"
524+
},
505525
"BinarySourceInfo": {
506526
"id": "BinarySourceInfo",
507527
"properties": {
@@ -1169,6 +1189,9 @@
11691189
"filePath": {
11701190
"description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.",
11711191
"type": "string"
1192+
},
1193+
"layerDetails": {
1194+
"$ref": "LayerDetails"
11721195
}
11731196
},
11741197
"type": "object"
@@ -1233,13 +1256,64 @@
12331256
},
12341257
"type": "object"
12351258
},
1259+
"GrafeasV1BaseImage": {
1260+
"description": "BaseImage describes a base image of a container image.",
1261+
"id": "GrafeasV1BaseImage",
1262+
"properties": {
1263+
"layerCount": {
1264+
"description": "The number of layers that the base image is composed of.",
1265+
"format": "int32",
1266+
"type": "integer"
1267+
},
1268+
"name": {
1269+
"description": "The name of the base image.",
1270+
"type": "string"
1271+
},
1272+
"repository": {
1273+
"description": "The repository name in which the base image is from.",
1274+
"type": "string"
1275+
}
1276+
},
1277+
"type": "object"
1278+
},
12361279
"GrafeasV1FileLocation": {
12371280
"description": "Indicates the location at which a package was found.",
12381281
"id": "GrafeasV1FileLocation",
12391282
"properties": {
12401283
"filePath": {
12411284
"description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.",
12421285
"type": "string"
1286+
},
1287+
"layerDetails": {
1288+
"$ref": "GrafeasV1LayerDetails",
1289+
"description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)."
1290+
}
1291+
},
1292+
"type": "object"
1293+
},
1294+
"GrafeasV1LayerDetails": {
1295+
"description": "Details about the layer a package was found in.",
1296+
"id": "GrafeasV1LayerDetails",
1297+
"properties": {
1298+
"baseImages": {
1299+
"description": "The base images the layer is found within.",
1300+
"items": {
1301+
"$ref": "GrafeasV1BaseImage"
1302+
},
1303+
"type": "array"
1304+
},
1305+
"command": {
1306+
"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.",
1307+
"type": "string"
1308+
},
1309+
"diffId": {
1310+
"description": "The diff ID (typically a sha256 hash) of the layer in the container image.",
1311+
"type": "string"
1312+
},
1313+
"index": {
1314+
"description": "The index of the layer in the container image.",
1315+
"format": "int32",
1316+
"type": "integer"
12431317
}
12441318
},
12451319
"type": "object"
@@ -1557,6 +1631,33 @@
15571631
},
15581632
"type": "object"
15591633
},
1634+
"LayerDetails": {
1635+
"description": "Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto.",
1636+
"id": "LayerDetails",
1637+
"properties": {
1638+
"baseImages": {
1639+
"description": "The base images the layer is found within.",
1640+
"items": {
1641+
"$ref": "BaseImage"
1642+
},
1643+
"type": "array"
1644+
},
1645+
"command": {
1646+
"description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.",
1647+
"type": "string"
1648+
},
1649+
"diffId": {
1650+
"description": "The diff ID (sha256 hash) of the layer in the container image.",
1651+
"type": "string"
1652+
},
1653+
"index": {
1654+
"description": "The index of the layer in the container image.",
1655+
"format": "int32",
1656+
"type": "integer"
1657+
}
1658+
},
1659+
"type": "object"
1660+
},
15601661
"License": {
15611662
"description": "License information.",
15621663
"id": "License",
@@ -1898,6 +1999,9 @@
18981999
"description": "HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.",
18992000
"type": "string"
19002001
},
2002+
"layerDetails": {
2003+
"$ref": "LayerDetails"
2004+
},
19012005
"licenses": {
19022006
"description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.",
19032007
"items": {

0 commit comments

Comments
 (0)