Skip to content

Commit

Permalink
Adjust terminology to docs (eliminate the usage of term 'match' in th…
Browse files Browse the repository at this point in the history 
…e context of conditions)
  • Loading branch information
@adams85
adams85 committed Mar 14, 2024
1 parent 98042c1 commit 4692622
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
4 changes: 2 additions & 2 deletions src/ConfigCatClient/Models/PrerequisiteFlagComparator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ namespace ConfigCat.Client;
public enum PrerequisiteFlagComparator : byte
{
/// <summary>
/// EQUALS - It matches when the evaluated value of the specified prerequisite flag is equal to the comparison value.
/// EQUALS - Checks whether the evaluated value of the specified prerequisite flag is equal to the comparison value.
/// </summary>
Equals = 0,

/// <summary>
/// NOT EQUALS - It matches when the evaluated value of the specified prerequisite flag is not equal to the comparison value.
/// NOT EQUALS - Checks whether the evaluated value of the specified prerequisite flag is not equal to the comparison value.
/// </summary>
NotEquals = 1
}
4 changes: 2 additions & 2 deletions src/ConfigCatClient/Models/SegmentComparator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ namespace ConfigCat.Client;
public enum SegmentComparator : byte
{
/// <summary>
/// IS IN SEGMENT - It matches when the conditions of the specified segment are evaluated to true.
/// IS IN SEGMENT - Checks whether the conditions of the specified segment are evaluated to true.
/// </summary>
IsIn = 0,

/// <summary>
/// IS NOT IN SEGMENT - It matches when the conditions of the specified segment are evaluated to false.
/// IS NOT IN SEGMENT - Checks whether the conditions of the specified segment are evaluated to false.
/// </summary>
IsNotIn = 1,
}
72 changes: 36 additions & 36 deletions src/ConfigCatClient/Models/UserComparator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,182 +6,182 @@ namespace ConfigCat.Client;
public enum UserComparator : byte
{
/// <summary>
/// IS ONE OF (cleartext) - It matches when the comparison attribute is equal to any of the comparison values.
/// IS ONE OF (cleartext) - Checks whether the comparison attribute is equal to any of the comparison values.
/// </summary>
TextIsOneOf = 0,

/// <summary>
/// IS NOT ONE OF (cleartext) - It matches when the comparison attribute is not equal to any of the comparison values.
/// IS NOT ONE OF (cleartext) - Checks whether the comparison attribute is not equal to any of the comparison values.
/// </summary>
TextIsNotOneOf = 1,

/// <summary>
/// CONTAINS ANY OF (cleartext) - It matches when the comparison attribute contains any comparison values as a substring.
/// CONTAINS ANY OF (cleartext) - Checks whether the comparison attribute contains any comparison values as a substring.
/// </summary>
TextContainsAnyOf = 2,

/// <summary>
/// NOT CONTAINS ANY OF (cleartext) - It matches when the comparison attribute does not contain any comparison values as a substring.
/// NOT CONTAINS ANY OF (cleartext) - Checks whether the comparison attribute does not contain any comparison values as a substring.
/// </summary>
TextNotContainsAnyOf = 3,

/// <summary>
/// IS ONE OF (semver) - It matches when the comparison attribute interpreted as a semantic version is equal to any of the comparison values.
/// IS ONE OF (semver) - Checks whether the comparison attribute interpreted as a semantic version is equal to any of the comparison values.
/// </summary>
SemVerIsOneOf = 4,

/// <summary>
/// IS NOT ONE OF (semver) - It matches when the comparison attribute interpreted as a semantic version is not equal to any of the comparison values.
/// IS NOT ONE OF (semver) - Checks whether the comparison attribute interpreted as a semantic version is not equal to any of the comparison values.
/// </summary>
SemVerIsNotOneOf = 5,

/// <summary>
/// &lt; (semver) - It matches when the comparison attribute interpreted as a semantic version is less than the comparison value.
/// &lt; (semver) - Checks whether the comparison attribute interpreted as a semantic version is less than the comparison value.
/// </summary>
SemVerLess = 6,

/// <summary>
/// &lt;= (semver) - It matches when the comparison attribute interpreted as a semantic version is less than or equal to the comparison value.
/// &lt;= (semver) - Checks whether the comparison attribute interpreted as a semantic version is less than or equal to the comparison value.
/// </summary>
SemVerLessOrEquals = 7,

/// <summary>
/// &gt; (semver) - It matches when the comparison attribute interpreted as a semantic version is greater than the comparison value.
/// &gt; (semver) - Checks whether the comparison attribute interpreted as a semantic version is greater than the comparison value.
/// </summary>
SemVerGreater = 8,

/// <summary>
/// &gt;= (semver) - It matches when the comparison attribute interpreted as a semantic version is greater than or equal to the comparison value.
/// &gt;= (semver) - Checks whether the comparison attribute interpreted as a semantic version is greater than or equal to the comparison value.
/// </summary>
SemVerGreaterOrEquals = 9,

/// <summary>
/// = (number) - It matches when the comparison attribute interpreted as a decimal number is equal to the comparison value.
/// = (number) - Checks whether the comparison attribute interpreted as a decimal number is equal to the comparison value.
/// </summary>
NumberEquals = 10,

/// <summary>
/// != (number) - It matches when the comparison attribute interpreted as a decimal number is not equal to the comparison value.
/// != (number) - Checks whether the comparison attribute interpreted as a decimal number is not equal to the comparison value.
/// </summary>
NumberNotEquals = 11,

/// <summary>
/// &lt; (number) - It matches when the comparison attribute interpreted as a decimal number is less than the comparison value.
/// &lt; (number) - Checks whether the comparison attribute interpreted as a decimal number is less than the comparison value.
/// </summary>
NumberLess = 12,

/// <summary>
/// &lt;= (number) - It matches when the comparison attribute interpreted as a decimal number is less than or equal to the comparison value.
/// &lt;= (number) - Checks whether the comparison attribute interpreted as a decimal number is less than or equal to the comparison value.
/// </summary>
NumberLessOrEquals = 13,

/// <summary>
/// &gt; (number) - It matches when the comparison attribute interpreted as a decimal number is greater than the comparison value.
/// &gt; (number) - Checks whether the comparison attribute interpreted as a decimal number is greater than the comparison value.
/// </summary>
NumberGreater = 14,

/// <summary>
/// &gt;= (number) - It matches when the comparison attribute interpreted as a decimal number is greater than or equal to the comparison value.
/// &gt;= (number) - Checks whether the comparison attribute interpreted as a decimal number is greater than or equal to the comparison value.
/// </summary>
NumberGreaterOrEquals = 15,

/// <summary>
/// IS ONE OF (hashed) - It matches when the comparison attribute is equal to any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// IS ONE OF (hashed) - Checks whether the comparison attribute is equal to any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextIsOneOf = 16,

/// <summary>
/// IS NOT ONE OF (hashed) - It matches when the comparison attribute is not equal to any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// IS NOT ONE OF (hashed) - Checks whether the comparison attribute is not equal to any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextIsNotOneOf = 17,

/// <summary>
/// BEFORE (UTC datetime) - It matches when the comparison attribute interpreted as the seconds elapsed since <see href="https://en.wikipedia.org/wiki/Unix_time">Unix Epoch</see> is less than the comparison value.
/// BEFORE (UTC datetime) - Checks whether the comparison attribute interpreted as the seconds elapsed since <see href="https://en.wikipedia.org/wiki/Unix_time">Unix Epoch</see> is less than the comparison value.
/// </summary>
DateTimeBefore = 18,

/// <summary>
/// AFTER (UTC datetime) - It matches when the comparison attribute interpreted as the seconds elapsed since <see href="https://en.wikipedia.org/wiki/Unix_time">Unix Epoch</see> is greater than the comparison value.
/// AFTER (UTC datetime) - Checks whether the comparison attribute interpreted as the seconds elapsed since <see href="https://en.wikipedia.org/wiki/Unix_time">Unix Epoch</see> is greater than the comparison value.
/// </summary>
DateTimeAfter = 19,

/// <summary>
/// EQUALS (hashed) - It matches when the comparison attribute is equal to the comparison value (where the comparison is performed using the salted SHA256 hashes of the values).
/// EQUALS (hashed) - Checks whether the comparison attribute is equal to the comparison value (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextEquals = 20,

/// <summary>
/// NOT EQUALS (hashed) - It matches when the comparison attribute is not equal to the comparison value (where the comparison is performed using the salted SHA256 hashes of the values).
/// NOT EQUALS (hashed) - Checks whether the comparison attribute is not equal to the comparison value (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextNotEquals = 21,

/// <summary>
/// STARTS WITH ANY OF (hashed) - It matches when the comparison attribute starts with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// STARTS WITH ANY OF (hashed) - Checks whether the comparison attribute starts with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextStartsWithAnyOf = 22,

/// <summary>
/// NOT STARTS WITH ANY OF (hashed) - It matches when the comparison attribute does not start with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// NOT STARTS WITH ANY OF (hashed) - Checks whether the comparison attribute does not start with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextNotStartsWithAnyOf = 23,

/// <summary>
/// ENDS WITH ANY OF (hashed) - It matches when the comparison attribute ends with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// ENDS WITH ANY OF (hashed) - Checks whether the comparison attribute ends with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextEndsWithAnyOf = 24,

/// <summary>
/// NOT ENDS WITH ANY OF (hashed) - It matches when the comparison attribute does not end with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// NOT ENDS WITH ANY OF (hashed) - Checks whether the comparison attribute does not end with any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveTextNotEndsWithAnyOf = 25,

/// <summary>
/// ARRAY CONTAINS ANY OF (hashed) - It matches when the comparison attribute interpreted as a comma-separated list contains any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// ARRAY CONTAINS ANY OF (hashed) - Checks whether the comparison attribute interpreted as a comma-separated list contains any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveArrayContainsAnyOf = 26,

/// <summary>
/// ARRAY NOT CONTAINS ANY OF (hashed) - It matches when the comparison attribute interpreted as a comma-separated list does not contain any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// ARRAY NOT CONTAINS ANY OF (hashed) - Checks whether the comparison attribute interpreted as a comma-separated list does not contain any of the comparison values (where the comparison is performed using the salted SHA256 hashes of the values).
/// </summary>
SensitiveArrayNotContainsAnyOf = 27,

/// <summary>
/// EQUALS (cleartext) - It matches when the comparison attribute is equal to the comparison value.
/// EQUALS (cleartext) - Checks whether the comparison attribute is equal to the comparison value.
/// </summary>
TextEquals = 28,

/// <summary>
/// NOT EQUALS (cleartext) - It matches when the comparison attribute is not equal to the comparison value.
/// NOT EQUALS (cleartext) - Checks whether the comparison attribute is not equal to the comparison value.
/// </summary>
TextNotEquals = 29,

/// <summary>
/// STARTS WITH ANY OF (cleartext) - It matches when the comparison attribute starts with any of the comparison values.
/// STARTS WITH ANY OF (cleartext) - Checks whether the comparison attribute starts with any of the comparison values.
/// </summary>
TextStartsWithAnyOf = 30,

/// <summary>
/// NOT STARTS WITH ANY OF (cleartext) - It matches when the comparison attribute does not start with any of the comparison values.
/// NOT STARTS WITH ANY OF (cleartext) - Checks whether the comparison attribute does not start with any of the comparison values.
/// </summary>
TextNotStartsWithAnyOf = 31,

/// <summary>
/// ENDS WITH ANY OF (cleartext) - It matches when the comparison attribute ends with any of the comparison values.
/// ENDS WITH ANY OF (cleartext) - Checks whether the comparison attribute ends with any of the comparison values.
/// </summary>
TextEndsWithAnyOf = 32,

/// <summary>
/// NOT ENDS WITH ANY OF (cleartext) - It matches when the comparison attribute does not end with any of the comparison values.
/// NOT ENDS WITH ANY OF (cleartext) - Checks whether the comparison attribute does not end with any of the comparison values.
/// </summary>
TextNotEndsWithAnyOf = 33,

/// <summary>
/// ARRAY CONTAINS ANY OF (cleartext) - It matches when the comparison attribute interpreted as a comma-separated list contains any of the comparison values.
/// ARRAY CONTAINS ANY OF (cleartext) - Checks whether the comparison attribute interpreted as a comma-separated list contains any of the comparison values.
/// </summary>
ArrayContainsAnyOf = 34,

/// <summary>
/// ARRAY NOT CONTAINS ANY OF (cleartext) - It matches when the comparison attribute interpreted as a comma-separated list does not contain any of the comparison values.
/// ARRAY NOT CONTAINS ANY OF (cleartext) - Checks whether the comparison attribute interpreted as a comma-separated list does not contain any of the comparison values.
/// </summary>
ArrayNotContainsAnyOf = 35,
}

0 comments on commit 4692622

Please sign in to comment.