Skip to content

Commit

Permalink
Update refinement parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
@stephan-huttenhuis
stephan-huttenhuis committed Apr 5, 2024
1 parent 3023bb8 commit a1dd9dc
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
4 changes: 2 additions & 2 deletions definitions/openapi_latest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@
}, {
"name" : "refinement",
"in" : "query",
"description" : "**Refinement**\n\nSpecifies (URL-encoded) the refinement used to filter groups. If not specified, all groups will be returned.\n\nTo filter groups using refinements you can use the query parameter refinement. The refinement parameter is a URL-encoded JSON object that contains the refinement in the form of one or more filters.\n\n\n**Logical operators**\n\nThe logical operators used when combining multiple filters.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| AND | All filters should match |\n| OR | Any of the filters should match |\n\n**Operators**\n\nThe operators used to filter the property or objectives within a group.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| IS_EMPTY | If the given property value is empty | \n| NOT_IS_EMPTY | If the given property value is not empty |\n| CONTAINS_ANY | If the given property value contains any of the given values |\n| CONTAINS_ALL | If the given property value contains all of the given values |\n| NOT_CONTAINS_ANY | If the given property value does not contain any of the given values |\n| NOT_CONTAINS_ALL | If the given property value does not contain all of the given values |\n| IN_RANGE | If the given property value is in the given range |\n| NOT_IN_RANGE | If the given property value is not in the given range |\n| IN_LAST_DAYS | If the given property value is in the last given number of days |\n| NOT_IN_LAST_DAYS | If the given property value is not in the last given number of days |\n| IN_NEXT_DAYS | If the given property value is in the next given number of days |\n| NOT_IN_NEXT_DAYS | If the given property value is not in the next given number of days |",
"description" : "**Refinement**\n\nSpecifies (URL-encoded) the refinement used to filter groups. If not specified, all groups will be returned.\n\nTo filter groups using refinements you can use the query parameter refinement. The refinement parameter is a URL-encoded JSON object that contains the refinement in the form of one or more filters.\n\n\n**Logical operators**\n\nThe logical operators used when combining multiple filters.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| AND | All filters should match |\n| OR | Any of the filters should match |\n\n**Operators**\n\nThe operators used to filter the property or objectives within a group.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| IS_EMPTY | If the given property value is empty | \n| NOT_IS_EMPTY | If the given property value is not empty |\n| CONTAINS_ANY | If the given property value contains any of the given values |\n| CONTAINS_ALL | If the given property value contains all of the given values |\n| NOT_CONTAINS_ANY | If the given property value does not contain any of the given values |\n| NOT_CONTAINS_ALL | If the given property value does not contain all of the given values |\n| IN_RANGE | If the given property value is in the given range |\n| NOT_IN_RANGE | If the given property value is not in the given range |\n| IN_LAST_DAYS | If the given property value is in the last given number of days |\n| NOT_IN_LAST_DAYS | If the given property value is not in the last given number of days |\n| IN_NEXT_DAYS | If the given property value is in the next given number of days |\n| NOT_IN_NEXT_DAYS | If the given property value is not in the next given number of days |\n| IN_LAST_HOURS | If the given property value is in the last given number of hours |\n| NOT_IN_LAST_HOURS | If the given property value is not in the last given number of hours |\n| IN_NEXT_HOURS | If the given property value is in the next given number of hours |\n| NOT_IN_NEXT_HOURS | If the given property value is not in the next given number of hours |",
"schema" : {
"$ref" : "#/components/schemas/RefinementBean"
},
Expand Down Expand Up @@ -1559,7 +1559,7 @@
}, {
"name" : "refinement",
"in" : "query",
"description" : "**Refinement**\n\nSpecifies (URL-encoded) the refinement used to filter profiles. If not specified, all profiles of the given segment will be returned.\n\nTo filter groups using refinements you can use the query parameter refinement. The refinement parameter is a URL-encoded JSON object that contains the refinement in the form of one or more filters.\n\n**Logical operators**\n\nThe logical operators used when combining multiple filters.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| AND | All filters should match |\n| OR | Any of the filters should match |\n\n**Operators**\n\nThe operators used to filter the property or objectives within a group.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| IS_EMPTY | If the given property value is empty | \n| NOT_IS_EMPTY | If the given property value is not empty |\n| CONTAINS_ANY | If the given property value contains any of the given values |\n| CONTAINS_ALL | If the given property value contains all of the given values |\n| NOT_CONTAINS_ANY | If the given property value does not contain any of the given values |\n| NOT_CONTAINS_ALL | If the given property value does not contain all of the given values |\n| IN_RANGE | If the given property value is in the given range |\n| NOT_IN_RANGE | If the given property value is not in the given range |\n| IN_LAST_DAYS | If the given property value is in the last given number of days |\n| NOT_IN_LAST_DAYS | If the given property value is not in the last given number of days |\n| IN_NEXT_DAYS | If the given property value is in the next given number of days |\n| NOT_IN_NEXT_DAYS | If the given property value is not in the next given number of days |\n\n**Objective**\n\nThe objectives used to filter the property or objectives within a group.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| CONSENTED | Objective consented |\n| REFUSED | Objective refused |\n| UNKNOWN | Unknown |\n| REFUSED_OR_UNKNOWN | Refused or unknown | \n| CONSENTED_OR_UNNEEDED | Consented or unneeded |\n\nCan only be used with the operators CONTAINS_ANY and CONTAINS_ALL",
"description" : "**Refinement**\n\nSpecifies (URL-encoded) the refinement used to filter profiles. If not specified, all profiles of the given segment will be returned.\n\nTo filter profiles using refinements you can use the query parameter refinement. The refinement parameter is a URL-encoded JSON object that contains the refinement in the form of one or more filters.\n\n**Logical operators**\n\nThe logical operators used when combining multiple filters.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| AND | All filters should match |\n| OR | Any of the filters should match |\n\n**Operators**\n\nThe operators used to filter the property or objectives within a profile.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| IS_EMPTY | If the given property value is empty | \n| NOT_IS_EMPTY | If the given property value is not empty |\n| CONTAINS_ANY | If the given property value contains any of the given values |\n| CONTAINS_ALL | If the given property value contains all of the given values |\n| NOT_CONTAINS_ANY | If the given property value does not contain any of the given values |\n| NOT_CONTAINS_ALL | If the given property value does not contain all of the given values |\n| IN_RANGE | If the given property value is in the given range |\n| NOT_IN_RANGE | If the given property value is not in the given range |\n| IN_LAST_DAYS | If the given property value is in the last given number of days |\n| NOT_IN_LAST_DAYS | If the given property value is not in the last given number of days |\n| IN_NEXT_DAYS | If the given property value is in the next given number of days |\n| NOT_IN_NEXT_DAYS | If the given property value is not in the next given number of days |\n| IN_LAST_HOURS | If the given property value is in the last given number of hours |\n| NOT_IN_LAST_HOURS | If the given property value is not in the last given number of hours |\n| IN_NEXT_HOURS | If the given property value is in the next given number of hours |\n| NOT_IN_NEXT_HOURS | If the given property value is not in the next given number of hours |\n\n**Objective**\n\nThe objectives used to filter the property or objectives within a profile.\n\n| Name | Description |\n| :---------------------- | :---------- |\n| CONSENTED | Objective consented |\n| REFUSED | Objective refused |\n| UNKNOWN | Unknown |\n| REFUSED_OR_UNKNOWN | Refused or unknown | \n| CONSENTED_OR_UNNEEDED | Consented or unneeded |\n\nCan only be used with the operators CONTAINS_ANY and CONTAINS_ALL",
"schema" : {
"$ref" : "#/components/schemas/RefinementBean"
},
Expand Down
32 changes: 21 additions & 11 deletions definitions/openapi_latest.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,12 @@ paths:
\ given number of days |\n| IN_NEXT_DAYS | If the given property\
\ value is in the next given number of days |\n| NOT_IN_NEXT_DAYS \
\ | If the given property value is not in the next given number of days\
\ |"
\ |\n| IN_LAST_HOURS | If the given property value is in the last\
\ given number of hours |\n| NOT_IN_LAST_HOURS | If the given property\
\ value is not in the last given number of hours |\n| IN_NEXT_HOURS \
\ | If the given property value is in the next given number of hours\
\ |\n| NOT_IN_NEXT_HOURS | If the given property value is not in the\
\ next given number of hours |"
schema:
$ref: "#/components/schemas/RefinementBean"
examples:
Expand Down Expand Up @@ -2962,14 +2967,14 @@ paths:
in: query
description: "**Refinement**\n\nSpecifies (URL-encoded) the refinement used\
\ to filter profiles. If not specified, all profiles of the given segment\
\ will be returned.\n\nTo filter groups using refinements you can use the\
\ query parameter refinement. The refinement parameter is a URL-encoded\
\ will be returned.\n\nTo filter profiles using refinements you can use\
\ the query parameter refinement. The refinement parameter is a URL-encoded\
\ JSON object that contains the refinement in the form of one or more filters.\n\
\n**Logical operators**\n\nThe logical operators used when combining multiple\
\ filters.\n\n| Name | Description |\n| :----------------------\
\ | :---------- |\n| AND | All filters should match\
\ |\n| OR | Any of the filters should match |\n\n**Operators**\n\
\nThe operators used to filter the property or objectives within a group.\n\
\nThe operators used to filter the property or objectives within a profile.\n\
\n| Name | Description |\n| :---------------------- |\
\ :---------- |\n| IS_EMPTY | If the given property value\
\ is empty | \n| NOT_IS_EMPTY | If the given property value is\
Expand All @@ -2986,13 +2991,18 @@ paths:
\ given number of days |\n| IN_NEXT_DAYS | If the given property\
\ value is in the next given number of days |\n| NOT_IN_NEXT_DAYS \
\ | If the given property value is not in the next given number of days\
\ |\n\n**Objective**\n\nThe objectives used to filter the property or objectives\
\ within a group.\n\n| Name | Description |\n| :----------------------\
\ | :---------- |\n| CONSENTED | Objective consented |\n|\
\ REFUSED | Objective refused |\n| UNKNOWN \
\ | Unknown |\n| REFUSED_OR_UNKNOWN | Refused or unknown | \n| CONSENTED_OR_UNNEEDED\
\ | Consented or unneeded |\n\nCan only be used with the operators CONTAINS_ANY\
\ and CONTAINS_ALL"
\ |\n| IN_LAST_HOURS | If the given property value is in the last\
\ given number of hours |\n| NOT_IN_LAST_HOURS | If the given property\
\ value is not in the last given number of hours |\n| IN_NEXT_HOURS \
\ | If the given property value is in the next given number of hours\
\ |\n| NOT_IN_NEXT_HOURS | If the given property value is not in the\
\ next given number of hours |\n\n**Objective**\n\nThe objectives used to\
\ filter the property or objectives within a profile.\n\n| Name \
\ | Description |\n| :---------------------- | :---------- |\n\
| CONSENTED | Objective consented |\n| REFUSED \
\ | Objective refused |\n| UNKNOWN | Unknown |\n| REFUSED_OR_UNKNOWN\
\ | Refused or unknown | \n| CONSENTED_OR_UNNEEDED | Consented or\
\ unneeded |\n\nCan only be used with the operators CONTAINS_ANY and CONTAINS_ALL"
schema:
$ref: "#/components/schemas/RefinementBean"
examples:
Expand Down

0 comments on commit a1dd9dc

Please sign in to comment.