oci 2.6.0 → 2.7.0

data/lib/oci/resource_manager/resource_manager_client_composite_operations.rb

@@ -27,7 +27,7 @@ module OCI
     # Calls {OCI::ResourceManager::ResourceManagerClient#cancel_job} and then waits for the {OCI::ResourceManager::Models::Job} acted upon
     # to enter the given state(s).
     #
-    # @param [String] job_id The job OCID.
+    # @param [String] job_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ResourceManager::Models::Job#lifecycle_state}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ResourceManager::ResourceManagerClient#cancel_job}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -67,8 +67,8 @@ module OCI
     # Calls {OCI::ResourceManager::ResourceManagerClient#change_stack_compartment} and then waits for the {OCI::ResourceManager::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] stack_id The stack OCID.
-    # @param [OCI::ResourceManager::Models::ChangeStackCompartmentDetails] change_stack_compartment_details
+    # @param [String] stack_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack.
+    # @param [OCI::ResourceManager::Models::ChangeStackCompartmentDetails] change_stack_compartment_details Defines the properties of changeStackCompartment operation.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ResourceManager::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ResourceManager::ResourceManagerClient#change_stack_compartment}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -195,7 +195,7 @@ module OCI
     # Calls {OCI::ResourceManager::ResourceManagerClient#delete_stack} and then waits for the {OCI::ResourceManager::Models::Stack} acted upon
     # to enter the given state(s).
     #
-    # @param [String] stack_id The stack OCID.
+    # @param [String] stack_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ResourceManager::Models::Stack#lifecycle_state}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ResourceManager::ResourceManagerClient#delete_stack}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -235,7 +235,7 @@ module OCI
     # Calls {OCI::ResourceManager::ResourceManagerClient#update_job} and then waits for the {OCI::ResourceManager::Models::Job} acted upon
     # to enter the given state(s).
     #
-    # @param [String] job_id The job OCID.
+    # @param [String] job_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
     # @param [OCI::ResourceManager::Models::UpdateJobDetails] update_job_details Updates properties for the specified job.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ResourceManager::Models::Job#lifecycle_state}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ResourceManager::ResourceManagerClient#update_job}
@@ -275,7 +275,7 @@ module OCI
     # Calls {OCI::ResourceManager::ResourceManagerClient#update_stack} and then waits for the {OCI::ResourceManager::Models::Stack} acted upon
     # to enter the given state(s).
     #
-    # @param [String] stack_id The stack OCID.
+    # @param [String] stack_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack.
     # @param [OCI::ResourceManager::Models::UpdateStackDetails] update_stack_details Updated information provided for the stack.
     #
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ResourceManager::Models::Stack#lifecycle_state}

data/lib/oci/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
 
 module OCI
-  VERSION = '2.6.0'.freeze
+  VERSION = '2.7.0'.freeze
 end

data/lib/oci/waas/models/access_rule.rb

@@ -56,7 +56,7 @@ module OCI
     #
     # - **REDIRECT:** Redirects the request to the specified URL.
     #
-    # Regardless of action, no further rules are processed once the rule is matched.
+    # Regardless of action, no further rules are processed once a rule is matched.
     # @return [String]
     attr_reader :action
 
@@ -64,7 +64,7 @@ module OCI
     # @return [String]
     attr_reader :block_action
 
-    # The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`.
+    # The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
     # @return [Integer]
     attr_accessor :block_response_code
 

data/lib/oci/waas/models/access_rule_criteria.rb

@@ -48,7 +48,7 @@ module OCI
     # - **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match.
     # *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match.
     #
-    # - **IP_IN_LIST:** Matches if the request originates from one of IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list.
+    # - **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list.
     #
     # - **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list.
     #

data/lib/oci/waas/models/address_list.rb

@@ -6,6 +6,7 @@ require 'logger'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
   # The details of the address list.
+  #
   class Waas::Models::AddressList
     LIFECYCLE_STATE_ENUM = [
       LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,

data/lib/oci/waas/models/address_rate_limiting.rb

@@ -18,7 +18,7 @@ module OCI
     # @return [Integer]
     attr_accessor :max_delayed_count_per_address
 
-    # The response status code returned when a request is blocked. If unspecified, defaults to `503`.
+    # The response status code returned when a request is blocked. If unspecified, defaults to `503`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
     # @return [Integer]
     attr_accessor :block_response_code
 

data/lib/oci/waas/models/block_challenge_settings.rb

@@ -18,7 +18,7 @@ module OCI
     # @return [String]
     attr_reader :block_action
 
-    # The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`.
+    # The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
     # @return [Integer]
     attr_accessor :block_response_code
 

data/lib/oci/waas/models/caching_rule.rb

@@ -21,24 +21,25 @@ module OCI
     # @return [String]
     attr_accessor :name
 
-    # **[Required]** The action to take on matched caching rules.
-    # - **CACHE:** Allow to set caching rule, which would be cached.
+    # **[Required]** The action to take when the criteria of a caching rule are met.
+    # - **CACHE:** Caches requested content when the criteria of the rule are met.
     #
-    # - **BYPASS_CACHE:** Allow to set caching rule, which would never be cached. e.g. all requests would be passed directly to origin for those file types.
+    # - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.
     # @return [String]
     attr_reader :action
 
-    # The caching duration (applies only to `CACHE` action) specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. Max value - 99. Mixing of multiple units is not supported.
+    # The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
+    # Example: `PT1H`
     # @return [String]
     attr_accessor :caching_duration
 
-    # Enables or disables the client caching.
-    # Browsers use the Cache-Control header value for caching content locally, in the browser.
-    # This setting will control the addition of a Cache-Control header to responses. It overrides existing Cache-Control headers.
+    # Enables or disables client caching.
+    # Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses.
     # @return [BOOLEAN]
     attr_accessor :is_client_caching_enabled
 
-    # The client caching duration (applies only to `CACHE` action) specified in ISO 8601 extended format, in case client caching enabled. It sets Cache-Control header max-age time, i.e. the local browser cache expire time. Supported units: seconds, minutes, hours, days, weeks, months. Max value - 99. Mixing of multiple units is not supported.
+    # The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
+    # Example: `PT1H`
     # @return [String]
     attr_accessor :client_caching_duration
 

data/lib/oci/waas/models/caching_rule_criteria.rb

@@ -24,11 +24,7 @@ module OCI
     #
     # - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field.
     #
-    # URL must start with /
-    #
-    # URL can't contain restricted double slashes //
-    #
-    # URL can't contain restricted ' & ? symbols
+    # URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored.
     # @return [String]
     attr_reader :condition
 

data/lib/oci/waas/models/caching_rule_summary.rb

@@ -21,24 +21,25 @@ module OCI
     # @return [String]
     attr_accessor :name
 
-    # **[Required]** The action to take on matched caching rules.
-    # - **CACHE:** Allow to set caching rule, which would be cached.
+    # **[Required]** The action to take when the criteria of a caching rule are met.
+    # - **CACHE:** Caches requested content when the criteria of the rule are met.
     #
-    # - **BYPASS_CACHE:** Allow to set caching rule, which would never be cached. e.g. all requests would be passed directly to origin for those file types.
+    # - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.
     # @return [String]
     attr_reader :action
 
-    # The caching duration (applies only to `CACHE` action) specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. Max value - 99. Mixing of multiple units is not supported.
+    # The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
+    # Example: `PT1H`
     # @return [String]
     attr_accessor :caching_duration
 
-    # Enables or disables the client caching.
-    # Browsers use the Cache-Control header value for caching content locally, in the browser.
-    # This setting will control the addition of a Cache-Control header to responses. It overrides existing Cache-Control headers.
+    # Enables or disables client caching.
+    # Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses.
     # @return [BOOLEAN]
     attr_accessor :is_client_caching_enabled
 
-    # The client caching duration (applies only to `CACHE` action) specified in ISO 8601 extended format, in case client caching enabled. It sets Cache-Control header max-age time, i.e. the local browser cache expire time. Supported units: seconds, minutes, hours, days, weeks, months. Max value - 99. Mixing of multiple units is not supported.
+    # The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
+    # Example: `PT1H`
     # @return [String]
     attr_accessor :client_caching_duration
 

data/lib/oci/waas/models/change_address_list_compartment_details.rb

@@ -6,7 +6,7 @@ require 'date'
 module OCI
   # ChangeAddressListCompartmentDetails model.
   class Waas::Models::ChangeAddressListCompartmentDetails
-    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
     #
     # @return [String]
     attr_accessor :compartment_id

data/lib/oci/waas/models/change_certificate_compartment_details.rb

@@ -7,6 +7,7 @@ module OCI
   # ChangeCertificateCompartmentDetails model.
   class Waas::Models::ChangeCertificateCompartmentDetails
     # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
+    # For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
     #
     # @return [String]
     attr_accessor :compartment_id

data/lib/oci/waas/models/change_custom_protection_rule_compartment_details.rb

@@ -6,7 +6,7 @@ require 'date'
 module OCI
   # ChangeCustomProtectionRuleCompartmentDetails model.
   class Waas::Models::ChangeCustomProtectionRuleCompartmentDetails
-    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
     #
     # @return [String]
     attr_accessor :compartment_id

data/lib/oci/waas/models/change_http_redirect_compartment_details.rb

@@ -0,0 +1,154 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # ChangeHttpRedirectCompartmentDetails model.
+  class Waas::Models::ChangeHttpRedirectCompartmentDetails
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'compartmentId'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
+
+      raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
+
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        compartment_id == other.compartment_id
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [compartment_id].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          public_method("#{key}=").call(
+            OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
+          )
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/waas/models/change_waas_policy_compartment_details.rb

@@ -7,6 +7,7 @@ module OCI
   # ChangeWaasPolicyCompartmentDetails model.
   class Waas::Models::ChangeWaasPolicyCompartmentDetails
     # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
+    # For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
     #
     # @return [String]
     attr_accessor :compartment_id

data/lib/oci/waas/models/create_address_list_details.rb

@@ -4,7 +4,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The data used to create a new address list.
+  # The data used to create a new address list of IP addresses and CIDR notations.
   class Waas::Models::CreateAddressListDetails
     # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the address list.
     # @return [String]

data/lib/oci/waas/models/create_custom_protection_rule_details.rb

@@ -4,14 +4,15 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The required data to create a Custom Protection rule.
+  # The required data to create a custom protection rule.
+  # For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
   # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
   class Waas::Models::CreateCustomProtectionRuleDetails
-    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the Custom Protection rule.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the custom protection rule.
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** A user-friendly name for the Custom Protection rule.
+    # **[Required]** A user-friendly name for the custom protection rule.
     # @return [String]
     attr_accessor :display_name
 
@@ -19,13 +20,15 @@ module OCI
     # @return [String]
     attr_accessor :description
 
-    # **[Required]** The template text of the Custom Protection rule. The syntax is based on ModSecurity Rule Language. Additionaly it needs to include two variables / placeholders which will be replaced during publishing.
+    # **[Required]** The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
     #
-    # - **{{mode}}** - rule action, defined by user in UI, like `OFF`, `DETECT` or `BLOCK`.
+    # Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
     #
-    # - **{{id_1}}** - unique rule ID which identifies a `SecRule`, generated by the system. Multiple IDs can be used by increasing the number of the variable for every `SecRule` defined in the template.
+    # `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example.
     #
-    # *Example usage:*
+    # `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated.
+    #
+    # *Example:*
     #   ```
     #   SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\
     #           \"phase:2,                                                 \\
@@ -40,13 +43,15 @@ module OCI
     #           ctl:ruleEngine={{mode}},                                  \\
     #           deny\"
     #   ```
-    #   The example contains two `SecRules` each having distinct regex expression to match
-    #   `Cookie` header value during second input analysis phase.
-    #   The disruptive `deny` action takes effect only when `{{mode}}` is set to `BLOCK`.
-    #   The message is logged either when `{{mode}}` is set to `DETECT` or `BLOCK`.
     #
     #
-    # For more information about ModSecurity's open source WAF rules, see [Mod Security's documentation](https://www.modsecurity.org/CRS/Documentation/making.html).
+    # The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase.
+    #
+    # For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/Content/WAF/tasks/customprotectionrules.htm).
+    #
+    # For more information about ModSecurity syntax, see [Making Rules: The Basic Syntax](https://www.modsecurity.org/CRS/Documentation/making.html).
+    #
+    # For more information about ModSecurity's open source WAF rules, see [Mod Security's OWASP Core Rule Set documentation](https://www.modsecurity.org/CRS/Documentation/index.html).
     # @return [String]
     attr_accessor :template