Skip to content

Commit

Permalink
updated open api spec to use the array for comma separated list of st…
Browse files Browse the repository at this point in the history 
…ring
  • Loading branch information
@petracihalova
petracihalova committed Apr 7, 2024
1 parent 6b4b6da commit 39bd617
Showing 1 changed file with 72 additions and 19 deletions.
91 changes: 72 additions & 19 deletions docs/source/specs/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,10 @@
"required": false,
"description": "Parameter for filtering resource by an account number. Value can be a comma-separated list of ids. To be used in tandem with ?query_by=user_id to further filter a user's requests by account number.",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -88,7 +91,10 @@
"required": false,
"description": "Parameter for filtering resource by an org id. Value can be a comma-separated list of ids. To be used in tandem with ?query_by=user_id to further filter a user's requests by org id.",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -264,7 +270,10 @@
"required": false,
"description": "Parameter for filtering resource by an account number. Value can be a comma-separated list of ids. To be used in tandem with ?query_by=user_id to further filter a user's requests by account number.",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -565,8 +574,10 @@
"description": "Comma separated usernames of principals to get. If match_criteria is specified, only the first username will be picked up for search.",
"required": false,
"schema": {
"type": "string",
"example": "userA,userB"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -1279,7 +1290,10 @@
"required": false,
"description": "By specifying a comma separated list of client IDs with this query parameter, RBAC will return an object with the specified client ID and it's matching boolean value to flag whether the client ID is present in the group or not. This query parameter cannot be used along with any other query parameter.",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -1372,15 +1386,21 @@
"in": "query",
"description": "A comma separated list of usernames for principals to remove from the group",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "service-accounts",
"in": "query",
"description": "A comma separated list of usernames for service accounts to remove from the group",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
}
],
Expand Down Expand Up @@ -1663,7 +1683,10 @@
"description": "A comma separated list of role UUIDs for roles to remove from the group",
"required": true,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
}
],
Expand Down Expand Up @@ -1848,7 +1871,10 @@
"description": "The application name(s) to filter roles by, from permissions or external tenant name. This is an exact match. You may also use a comma-separated list to match on multiple applications.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -1857,7 +1883,10 @@
"description": "The permission(s) to filter roles by. This is an exact match. You may also use a comma-separated list to match on multiple permissions.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -2542,7 +2571,10 @@
"required": true,
"allowEmptyValue": true,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -2663,7 +2695,10 @@
"description": "Exact match for the application name of a permission. You may also use a comma-separated list to match on multiple applications.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -2672,7 +2707,10 @@
"description": "Exact match for the resource type name of a permission. You may also use a comma-separated list to match on multiple resource_types.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -2681,7 +2719,10 @@
"description": "Exact match for the operation verb name of a permission You may also use a comma-separated list to match on multiple verbs.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -2713,7 +2754,10 @@
"description": "An optional string filter which accepts one or more role UUIDs, comma-separated, to return permissions not associated with the supplied role(s).",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -2803,7 +2847,10 @@
"description": "Filter returned options based on application. You may also use a comma-separated list to filter on multiple applications.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -2812,7 +2859,10 @@
"description": "Filter returned options based on resource_type. You may also use a comma-separated list to filter on multiple resource_types.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand All @@ -2821,7 +2871,10 @@
"description": "Filter returned options based on verb. You may also use a comma-separated list to filter on multiple verbs.",
"required": false,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down

0 comments on commit 39bd617

Please sign in to comment.