Modify posture deployment field descriptions (GoogleCloudPlatform#9900)

* modify posture dpeloyment field description * Update mmv1/products/securityposture/PostureDeployment.yaml Co-authored-by: Nick Elliot <[email protected]> * Update mmv1/products/securityposture/PostureDeployment.yaml Co-authored-by: Nick Elliot <[email protected]> --------- Co-authored-by: Sneha Prasad <[email protected]> Co-authored-by: Nick Elliot <[email protected]>
hao-nan-li · Feb 5, 2024 · 7088e24 · 7088e24
1 parent 93c0470
commit 7088e24
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/mmv1/products/securityposture/PostureDeployment.yaml b/mmv1/products/securityposture/PostureDeployment.yaml
@@ -78,13 +78,14 @@ properties:
     immutable: true
     description: |
       The resource on which the posture should be deployed. This can be in one of the following formats:
-      projects/<project_number>
-      folders/<folder_number>
-      organizations/<organization_id>
+      projects/{project_number},
+      folders/{folder_number},
+      organizations/{organization_id}
   - !ruby/object:Api::Type::Enum
     name: 'state'
     description: |
-      State of the posture deployment.
+      State of the posture deployment. A posture deployment can be in the following terminal states:
+      ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.
     output: true
     values:
       - :STATE_UNSPECIFIED
@@ -100,7 +101,7 @@ properties:
     required: true
     description: |
       Relative name of the posture which needs to be deployed. It should be in the format:
-        organizations/<ORG_ID>/locations/<LOCATION>/postures/<postureID>
+        organizations/{organization_id}/locations/{location}/postures/{posture_id}
   - !ruby/object:Api::Type::String
     name: 'postureRevisionId'
     required: true
@@ -134,15 +135,15 @@ properties:
     description: |
       This is an output only optional field which will be filled in case when
       PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-      It denotes the desired Posture to be deployed.
+      It denotes the desired posture to be deployed.
     output: true
   - !ruby/object:Api::Type::String
     name: 'desiredPostureRevisionId'
     output: true
     description: |
       This is an output only optional field which will be filled in case when
       PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-      It denotes the desired Posture revision_id to be deployed.
+      It denotes the desired posture revision_id to be deployed.
   - !ruby/object:Api::Type::String
     name: 'failureMessage'
     output: true