Add name filter to /owners

opalsecurity · Aug 31, 2023 · 5ea18cf · 5ea18cf
1 parent 19d6ac5
commit 5ea18cf
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -941,6 +941,15 @@ paths:
           maximum: 1000
           type: integer
         style: form
+      - description: Owner name to filter by.
+        example: 200
+        explode: true
+        in: query
+        name: name
+        required: false
+        schema:
+          type: string
+        style: form
       responses:
         "200":
           content:
@@ -1042,7 +1051,8 @@ paths:
       - owners
   /owners/name/{owner_name}:
     get:
-      description: Returns an `Owner` object.
+      description: "Returns an `Owner` object. Does not support owners with `/` in\
+        \ their name, use /owners?name=... instead."
       operationId: getOwnerFromName
       parameters:
       - description: The name of the owner.

diff --git a/api_owners.go b/api_owners.go
diff --git a/docs/OwnersApi.md b/docs/OwnersApi.md
@@ -361,7 +361,7 @@ Name | Type | Description  | Notes
 
 ## GetOwners
 
-> PaginatedOwnersList GetOwners(ctx).Cursor(cursor).PageSize(pageSize).Execute()
+> PaginatedOwnersList GetOwners(ctx).Cursor(cursor).PageSize(pageSize).Name(name).Execute()
 
 
 
@@ -382,10 +382,11 @@ import (
 func main() {
     cursor := "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" // string | The pagination cursor value. (optional)
     pageSize := int32(200) // int32 | Number of results to return per page. Default is 200. (optional)
+    name := "200" // string | Owner name to filter by. (optional)
 
     configuration := openapiclient.NewConfiguration()
     apiClient := openapiclient.NewAPIClient(configuration)
-    resp, r, err := apiClient.OwnersApi.GetOwners(context.Background()).Cursor(cursor).PageSize(pageSize).Execute()
+    resp, r, err := apiClient.OwnersApi.GetOwners(context.Background()).Cursor(cursor).PageSize(pageSize).Name(name).Execute()
     if err != nil {
         fmt.Fprintf(os.Stderr, "Error when calling `OwnersApi.GetOwners``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -408,6 +409,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cursor** | **string** | The pagination cursor value. | 
  **pageSize** | **int32** | Number of results to return per page. Default is 200. | 
+ **name** | **string** | Owner name to filter by. | 
 
 ### Return type