Skip to content

Commit 68d5ffe

Browse files
docs(srsmgmt): Update registry search documentation (#91)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent f3caa56 commit 68d5ffe

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

.openapi/srs-fleet-manager.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -627,14 +627,14 @@
627627
},
628628
"search": {
629629
"style": "form",
630+
"description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement. Allowed fields in the search are: name, status. Allowed comparators are `=` or `LIKE`.\nAllowed joins are `AND` and `OR`, however there is a limit of max 10 joins in the search query.\n\nExamples:\n\nTo retrieve request with name equal `my-registry` the value should be:\n\n```\nname = my-registry \n```\n\nTo retrieve kafka request with its name starting with `my`, the value should be:\n\n```\nname like my%25\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the kafkas\nthat the user has permission to see will be returned.\n\nNote. If the query is invalid, an error will be returned\n",
630631
"explode": true,
631632
"examples": {
632633
"search": {
633-
"value": "name = my-kafka and cloud_provider = aws"
634+
"value": "name = my-registry and status = AVAILABLE"
634635
}
635636
},
636637
"name": "search",
637-
"description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of an\nSQL statement. Allowed fields in the search are: cloud_provider, name, owner, region and status. Allowed comparators are `<>`, `=` or `LIKE`.\nAllowed joins are `AND` and `OR`, however there is a limit of max 10 joins in the search query.\n\nExamples:\n\nTo retrieve kafka request with name equal `my-kafka` and region equal `aws`, the value should be:\n\n```\nname = my-kafka and cloud_provider = aws\n```\n\nTo retrieve kafka request with its name starting with `my`, the value should be:\n\n```\nname like my%25\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the kafkas\nthat the user has permission to see will be returned.\n\nNote. If the query is invalid, an error will be returned\n",
638638
"schema": {
639639
"type": "string"
640640
},

0 commit comments

Comments
 (0)