Skip to content

Commit

Permalink
feat(recommender): update the API
Browse files Browse the repository at this point in the history
#### recommender:v1beta1

The following keys were added:
- schemas.GoogleCloudRecommenderV1beta1Impact.properties.securityProjection.$ref
- schemas.GoogleCloudRecommenderV1beta1Impact.properties.securityProjection.description
- schemas.GoogleCloudRecommenderV1beta1Insight.properties.severity.description
- schemas.GoogleCloudRecommenderV1beta1Insight.properties.severity.enum
- schemas.GoogleCloudRecommenderV1beta1Insight.properties.severity.enumDescriptions
- schemas.GoogleCloudRecommenderV1beta1Insight.properties.severity.type
- schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.priority.description
- schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.priority.enum
- schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.priority.enumDescriptions
- schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.priority.type
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.description
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.id
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.properties.details.additionalProperties.description
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.properties.details.additionalProperties.type
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.properties.details.description
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.properties.details.type
- schemas.GoogleCloudRecommenderV1beta1SecurityProjection.type

The following keys were changed:
- resources.billingAccounts.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.billingAccounts.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.folders.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.folders.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.organizations.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.organizations.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description

#### recommender:v1

The following keys were added:
- schemas.GoogleCloudRecommenderV1Impact.properties.securityProjection.$ref
- schemas.GoogleCloudRecommenderV1Impact.properties.securityProjection.description
- schemas.GoogleCloudRecommenderV1Insight.properties.severity.description
- schemas.GoogleCloudRecommenderV1Insight.properties.severity.enum
- schemas.GoogleCloudRecommenderV1Insight.properties.severity.enumDescriptions
- schemas.GoogleCloudRecommenderV1Insight.properties.severity.type
- schemas.GoogleCloudRecommenderV1Recommendation.properties.priority.description
- schemas.GoogleCloudRecommenderV1Recommendation.properties.priority.enum
- schemas.GoogleCloudRecommenderV1Recommendation.properties.priority.enumDescriptions
- schemas.GoogleCloudRecommenderV1Recommendation.properties.priority.type
- schemas.GoogleCloudRecommenderV1SecurityProjection.description
- schemas.GoogleCloudRecommenderV1SecurityProjection.id
- schemas.GoogleCloudRecommenderV1SecurityProjection.properties.details.additionalProperties.description
- schemas.GoogleCloudRecommenderV1SecurityProjection.properties.details.additionalProperties.type
- schemas.GoogleCloudRecommenderV1SecurityProjection.properties.details.description
- schemas.GoogleCloudRecommenderV1SecurityProjection.properties.details.type
- schemas.GoogleCloudRecommenderV1SecurityProjection.type

The following keys were changed:
- resources.billingAccounts.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.billingAccounts.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.folders.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.folders.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.organizations.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.organizations.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
- resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description
- resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description
  • Loading branch information
yoshi-automation authored and sofisl committed May 21, 2021
1 parent ba531f5 commit 6755126
Show file tree
Hide file tree
Showing 4 changed files with 1,024 additions and 784 deletions.
73 changes: 64 additions & 9 deletions discovery/recommender-v1.json
Expand Up @@ -148,7 +148,7 @@
],
"parameters": {
"filter": {
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"",
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -250,7 +250,7 @@
],
"parameters": {
"filter": {
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"",
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -416,7 +416,7 @@
],
"parameters": {
"filter": {
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"",
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -518,7 +518,7 @@
],
"parameters": {
"filter": {
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"",
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -684,7 +684,7 @@
],
"parameters": {
"filter": {
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"",
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -786,7 +786,7 @@
],
"parameters": {
"filter": {
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"",
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -952,7 +952,7 @@
],
"parameters": {
"filter": {
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"",
"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -1054,7 +1054,7 @@
],
"parameters": {
"filter": {
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"",
"description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -1178,7 +1178,7 @@
}
}
},
"revision": "20210410",
"revision": "20210514",
"rootUrl": "https://recommender.googleapis.com/",
"schemas": {
"GoogleCloudRecommenderV1CostProjection": {
Expand Down Expand Up @@ -1222,6 +1222,10 @@
"costProjection": {
"$ref": "GoogleCloudRecommenderV1CostProjection",
"description": "Use with CategoryType.COST"
},
"securityProjection": {
"$ref": "GoogleCloudRecommenderV1SecurityProjection",
"description": "Use with CategoryType.SECURITY"
}
},
"type": "object"
Expand Down Expand Up @@ -1289,6 +1293,24 @@
"format": "google-duration",
"type": "string"
},
"severity": {
"description": "Insight's severity.",
"enum": [
"SEVERITY_UNSPECIFIED",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Insight has unspecified severity.",
"Insight has low severity.",
"Insight has medium severity.",
"Insight has high severity.",
"Insight has critical severity."
],
"type": "string"
},
"stateInfo": {
"$ref": "GoogleCloudRecommenderV1InsightStateInfo",
"description": "Information state and metadata."
Expand Down Expand Up @@ -1562,6 +1584,24 @@
"$ref": "GoogleCloudRecommenderV1Impact",
"description": "The primary impact that this recommendation can have while trying to optimize for one category."
},
"priority": {
"description": "Recommendation's priority.",
"enum": [
"PRIORITY_UNSPECIFIED",
"P4",
"P3",
"P2",
"P1"
],
"enumDescriptions": [
"Recommendation has unspecified priority.",
"Recommendation has P4 priority (lowest priority).",
"Recommendation has P3 priority (second lowest priority).",
"Recommendation has P2 priority (second highest priority).",
"Recommendation has P1 priority (highest priority)."
],
"type": "string"
},
"recommenderSubtype": {
"description": "Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.iam.policy.Recommender\", recommender_subtype can be one of \"REMOVE_ROLE\"/\"REPLACE_ROLE\"",
"type": "string"
Expand Down Expand Up @@ -1632,6 +1672,21 @@
},
"type": "object"
},
"GoogleCloudRecommenderV1SecurityProjection": {
"description": "Contains various ways of describing the impact on Security.",
"id": "GoogleCloudRecommenderV1SecurityProjection",
"properties": {
"details": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Additional security impact details that is provided by the recommender.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudRecommenderV1ValueMatcher": {
"description": "Contains various matching options for values for a GCP resource field.",
"id": "GoogleCloudRecommenderV1ValueMatcher",
Expand Down

0 comments on commit 6755126

Please sign in to comment.