fix: Update documentation of filter APIs (#7245)

This commit is contained in:
Pranav Raj S 2023-06-02 15:36:41 -07:00 committed by GitHub
parent f28533bc47
commit ca9d108741
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 178 additions and 162 deletions

View File

@ -10,10 +10,13 @@ parameters:
- name: page - name: page
in: query in: query
type: integer type: integer
- name: payload - name: body
in: body in: body
required: true required: true
schema: schema:
type: object
properties:
payload:
type: array type: array
items: items:
type: object type: object
@ -42,7 +45,7 @@ parameters:
- attribute_key: 'country_code' - attribute_key: 'country_code'
filter_operator: 'equal_to' filter_operator: 'equal_to'
values: ['us'] values: ['us']
query_operator: nil query_operator: null
responses: responses:
200: 200:

View File

@ -10,10 +10,13 @@ parameters:
- name: page - name: page
in: query in: query
type: integer type: integer
- name: payload - name: body
in: body in: body
required: true required: true
schema: schema:
type: object
properties:
payload:
type: array type: array
items: items:
type: object type: object
@ -42,7 +45,7 @@ parameters:
- attribute_key: 'status' - attribute_key: 'status'
filter_operator: 'eq' filter_operator: 'eq'
values: ['pending'] values: ['pending']
query_operator: nil query_operator: null
responses: responses:
200: 200:

View File

@ -2014,10 +2014,13 @@
"type": "integer" "type": "integer"
}, },
{ {
"name": "payload", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"type": "object",
"properties": {
"payload": {
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
@ -2045,13 +2048,13 @@
}, },
"query_operator": { "query_operator": {
"type": "string", "type": "string",
"description": "query operator name", "description": "query operator name"
},
"enum": [ "enum": [
"AND", "AND",
"OR" "OR"
] ]
} }
}
}, },
"example": [ "example": [
{ {
@ -2068,11 +2071,13 @@
"values": [ "values": [
"us" "us"
], ],
"query_operator": "nil" "query_operator": null
} }
] ]
} }
} }
}
}
], ],
"responses": { "responses": {
"200": { "200": {
@ -2907,10 +2912,13 @@
"type": "integer" "type": "integer"
}, },
{ {
"name": "payload", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"type": "object",
"properties": {
"payload": {
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
@ -2961,11 +2969,13 @@
"values": [ "values": [
"pending" "pending"
], ],
"query_operator": "nil" "query_operator": null
} }
] ]
} }
} }
}
}
], ],
"responses": { "responses": {
"200": { "200": {