We are now using ONLY relational operator.

[#173671473]

Co-authored-by: Reid Mitchell <rmitchell@pivotal.io>
Co-authored-by: Teal Stannard <tstannard@pivotal.io>

Author: reidmit

app/messages/events_list_message.rb

@@ -11,24 +11,24 @@ def validate(record)
             end
           else
             unless record.created_ats.is_a?(Hash)
-              record.errors[:created_ats] << 'comparison operator and timestamp must be specified'
+              record.errors[:created_ats] << 'relational operator and timestamp must be specified'
               return
             end
 
-            valid_comparision_operators = [
+            valid_relational_operators = [
               Event::LESS_THAN_COMPARATOR,
               Event::GREATER_THAN_COMPARATOR,
               Event::LESS_THAN_OR_EQUAL_COMPARATOR,
               Event::GREATER_THAN_OR_EQUAL_COMPARATOR,
             ]
 
-            record.created_ats.each do |comparison_operator, timestamp|
-              unless valid_comparision_operators.include?(comparison_operator)
-                record.errors[:created_ats] << "Invalid comparison operator: '#{comparison_operator}'"
+            record.created_ats.each do |relational_operator, timestamp|
+              unless valid_relational_operators.include?(relational_operator)
+                record.errors[:created_ats] << "Invalid relational operator: '#{relational_operator}'"
               end
 
               if timestamp.to_s.include?(',')
-                record.errors[:created_ats] << 'only accepts one value when using an inequality filter'
+                record.errors[:created_ats] << 'only accepts one value when using a relational operator'
                 next
               end
 

docs/v3/source/includes/concepts/_filters.md.erb

@@ -47,8 +47,8 @@ This will return all routes with hostname `"hostname1"`, `""` OR `"hostname2"`.
 
 #### Relational Operators (Experimental)
 
-Fields can be filtered using inequality when listing resources. Currently, this is supported only on
-the `created_at` field, using the `created_ats` filter.
+Fields can be filtered using relational operators when listing resources. Currently, this is
+supported only on the `created_at` field, using the `created_ats` filter.
 
 For example, a response to `/v3/audit_events?created_ats[lt]=2020-06-30T12:34:56Z` will contain
 audit events with a `created_at` timestamp strictly earlier than `2020-06-30T12:34:56Z`.
@@ -59,7 +59,7 @@ will return all audit events occurring on New Year's Day.
 
 Timestamps must be in [standard timestamp format](#timestamps).
 
-##### Valid inequality operators
+##### Valid relational operators
 
 **Operator** | **Description**
 -------------|-----------------
@@ -68,8 +68,8 @@ Timestamps must be in [standard timestamp format](#timestamps).
 **gt**       | Return resources strictly greater than the given value for the filtered attribute
 **gte**      | Return resources greater than or equal to the given value for the filtered attribute
 
-##### Resources with inequalities
+##### Resources with relational operators
 
-The following resources can filter using inequality operators:
+The following resources can filter using relational operators:
 
 - **[audit_events](#list-audit-events)**

spec/request/events_spec.rb

@@ -445,7 +445,7 @@
           get "/v3/audit_events?created_ats[goat]=#{timestamp}", nil, admin_header
 
           expect(last_response).to have_status_code(400)
-          expect(last_response).to have_error_message("Invalid comparison operator: 'goat'")
+          expect(last_response).to have_error_message("Invalid relational operator: 'goat'")
         end
       end
 

spec/unit/messages/events_list_message_spec.rb

@@ -68,13 +68,13 @@ module VCAP::CloudController
           it 'requires a hash or an array of timestamps' do
             message = EventsListMessage.from_params({ created_ats: 47 })
             expect(message).not_to be_valid
-            expect(message.errors[:created_ats]).to include('comparison operator and timestamp must be specified')
+            expect(message.errors[:created_ats]).to include('relational operator and timestamp must be specified')
           end
 
-          it 'requires a valid comparison operator' do
+          it 'requires a valid relational operator' do
             message = EventsListMessage.from_params({ created_ats: { garbage: Time.now.utc.iso8601 } })
             expect(message).not_to be_valid
-            expect(message.errors[:created_ats]).to include("Invalid comparison operator: 'garbage'")
+            expect(message.errors[:created_ats]).to include("Invalid relational operator: 'garbage'")
           end
 
           context 'requires a valid timestamp' do
@@ -131,7 +131,7 @@ module VCAP::CloudController
           it 'does not allow multiple timestamps with an operator' do
             message = EventsListMessage.from_params({ created_ats: { gte: "#{Time.now.utc.iso8601},#{Time.now.utc.iso8601}" } })
             expect(message).not_to be_valid
-            expect(message.errors[:created_ats]).to include('only accepts one value when using an inequality filter')
+            expect(message.errors[:created_ats]).to include('only accepts one value when using a relational operator')
           end
 
           context 'when the operator is an equals operator' do