Explicitly document that page index start at 0

sjoubert · sjoubert · commit 0e2c8570d935 · 2024-08-08T16:26:11.000+02:00
diff --git a/connector/src/main/openapi/connector.yaml b/connector/src/main/openapi/connector.yaml
@@ -54,7 +54,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
diff --git a/dataset/src/main/openapi/dataset.yaml b/dataset/src/main/openapi/dataset.yaml
@@ -62,7 +62,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
@@ -100,7 +100,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
diff --git a/doc/Apis/ConnectorApi.md b/doc/Apis/ConnectorApi.md
@@ -20,7 +20,7 @@ List all Connectors
 
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/DatasetApi.md b/doc/Apis/DatasetApi.md
@@ -299,7 +299,7 @@ List all Datasets
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
@@ -626,7 +626,7 @@ Search Datasets by tags
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **DatasetSearch** | [**DatasetSearch**](../Models/DatasetSearch.md)| the Dataset search parameters | |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/OrganizationApi.md b/doc/Apis/OrganizationApi.md
@@ -56,7 +56,7 @@ List all Organizations
 
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/RunApi.md b/doc/Apis/RunApi.md
@@ -138,7 +138,7 @@ get the list of Runs for the Runner
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **workspace\_id** | **String**| the Workspace identifier | [default to null] |
 | **runner\_id** | **String**| the Runner identifier | [default to null] |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/RunnerApi.md b/doc/Apis/RunnerApi.md
@@ -252,7 +252,7 @@ List all Runners
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **workspace\_id** | **String**| the Workspace identifier | [default to null] |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/SolutionApi.md b/doc/Apis/SolutionApi.md
@@ -224,7 +224,7 @@ List all Solutions
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/doc/Apis/WorkspaceApi.md b/doc/Apis/WorkspaceApi.md
@@ -222,7 +222,7 @@ List all Workspaces
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
-| **page** | **Integer**| page number to query | [optional] [default to null] |
+| **page** | **Integer**| page number to query (first page is at index 0) | [optional] [default to null] |
 | **size** | **Integer**| amount of result by page | [optional] [default to null] |
 
 ### Return type
diff --git a/organization/src/main/openapi/organization.yaml b/organization/src/main/openapi/organization.yaml
@@ -52,7 +52,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
diff --git a/run/src/main/openapi/run.yaml b/run/src/main/openapi/run.yaml
@@ -277,20 +277,21 @@ paths:
         required: true
         schema:
           type: string
-      - name: page
-        in: query
-        description: page number to query
-        required: false
-        schema:
-          type: integer
-      - name: size
-        in: query
-        description: amount of result by page
-        required: false
-        schema:
-          type: integer
     get:
       operationId: listRuns
+      parameters:
+        - name: page
+          in: query
+          description: page number to query (first page is at index 0)
+          required: false
+          schema:
+            type: integer
+        - name: size
+          in: query
+          description: amount of result by page
+          required: false
+          schema:
+            type: integer
       tags:
         - run
       summary: get the list of Runs for the Runner
diff --git a/runner/src/main/openapi/runner.yaml b/runner/src/main/openapi/runner.yaml
@@ -69,7 +69,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
diff --git a/solution/src/main/openapi/solution.yaml b/solution/src/main/openapi/solution.yaml
@@ -59,7 +59,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
diff --git a/workspace/src/main/openapi/workspace.yaml b/workspace/src/main/openapi/workspace.yaml
@@ -59,7 +59,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: page number to query
+          description: page number to query (first page is at index 0)
           required: false
           schema:
             type: integer
