Skip to content

Commit ebe8ff1

Browse files
getstrmbotgetstrmbot
committed
Commit from GitHub Actions (Docs)
1 parent 4514183 commit ebe8ff1

File tree

2 files changed

+262
-2
lines changed

2 files changed

+262
-2
lines changed

‎docs/.gitbook.yaml‎

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,32 @@
44
openapi: 3.0.3
55
info:
66
title: PACE API
7-
version: 1.0.0-alpha.40
7+
version: 1.0.0-alpha.41
88
paths:
99
/data-policies:
1010
get:
1111
tags:
1212
- DataPoliciesService
1313
description: Lists all DataPolicies for all platforms.
1414
operationId: DataPoliciesService_ListDataPolicies
15+
parameters:
16+
- name: pageParameters.skip
17+
in: query
18+
description: |-
19+
The provided skip value of the request.
20+
skip represents records to skip before returning results.
21+
If empty, skip is 0.
22+
schema:
23+
type: integer
24+
format: uint32
25+
- name: pageParameters.pageSize
26+
in: query
27+
description: |-
28+
The provided page_size value of the request.
29+
If empty, page_size is 10.
30+
schema:
31+
type: integer
32+
format: uint32
1533
responses:
1634
"200":
1735
description: OK
@@ -31,6 +49,24 @@ paths:
3149
- DataCatalogsService
3250
description: Lists all configured catalogs.
3351
operationId: DataCatalogsService_ListCatalogs
52+
parameters:
53+
- name: pageParameters.skip
54+
in: query
55+
description: |-
56+
The provided skip value of the request.
57+
skip represents records to skip before returning results.
58+
If empty, skip is 0.
59+
schema:
60+
type: integer
61+
format: uint32
62+
- name: pageParameters.pageSize
63+
in: query
64+
description: |-
65+
The provided page_size value of the request.
66+
If empty, page_size is 10.
67+
schema:
68+
type: integer
69+
format: uint32
3470
responses:
3571
"200":
3672
description: OK
@@ -96,6 +132,23 @@ paths:
96132
required: true
97133
schema:
98134
type: string
135+
- name: pageParameters.skip
136+
in: query
137+
description: |-
138+
The provided skip value of the request.
139+
skip represents records to skip before returning results.
140+
If empty, skip is 0.
141+
schema:
142+
type: integer
143+
format: uint32
144+
- name: pageParameters.pageSize
145+
in: query
146+
description: |-
147+
The provided page_size value of the request.
148+
If empty, page_size is 10.
149+
schema:
150+
type: integer
151+
format: uint32
99152
responses:
100153
"200":
101154
description: OK
@@ -125,6 +178,23 @@ paths:
125178
in: query
126179
schema:
127180
type: string
181+
- name: pageParameters.skip
182+
in: query
183+
description: |-
184+
The provided skip value of the request.
185+
skip represents records to skip before returning results.
186+
If empty, skip is 0.
187+
schema:
188+
type: integer
189+
format: uint32
190+
- name: pageParameters.pageSize
191+
in: query
192+
description: |-
193+
The provided page_size value of the request.
194+
If empty, page_size is 10.
195+
schema:
196+
type: integer
197+
format: uint32
128198
responses:
129199
"200":
130200
description: OK
@@ -158,6 +228,23 @@ paths:
158228
in: query
159229
schema:
160230
type: string
231+
- name: pageParameters.skip
232+
in: query
233+
description: |-
234+
The provided skip value of the request.
235+
skip represents records to skip before returning results.
236+
If empty, skip is 0.
237+
schema:
238+
type: integer
239+
format: uint32
240+
- name: pageParameters.pageSize
241+
in: query
242+
description: |-
243+
The provided page_size value of the request.
244+
If empty, page_size is 10.
245+
schema:
246+
type: integer
247+
format: uint32
161248
responses:
162249
"200":
163250
description: OK
@@ -539,6 +626,23 @@ paths:
539626
required: true
540627
schema:
541628
type: string
629+
- name: pageParameters.skip
630+
in: query
631+
description: |-
632+
The provided skip value of the request.
633+
skip represents records to skip before returning results.
634+
If empty, skip is 0.
635+
schema:
636+
type: integer
637+
format: uint32
638+
- name: pageParameters.pageSize
639+
in: query
640+
description: |-
641+
The provided page_size value of the request.
642+
If empty, page_size is 10.
643+
schema:
644+
type: integer
645+
format: uint32
542646
responses:
543647
"200":
544648
description: OK
@@ -564,6 +668,23 @@ paths:
564668
required: true
565669
schema:
566670
type: string
671+
- name: pageParameters.skip
672+
in: query
673+
description: |-
674+
The provided skip value of the request.
675+
skip represents records to skip before returning results.
676+
If empty, skip is 0.
677+
schema:
678+
type: integer
679+
format: uint32
680+
- name: pageParameters.pageSize
681+
in: query
682+
description: |-
683+
The provided page_size value of the request.
684+
If empty, page_size is 10.
685+
schema:
686+
type: integer
687+
format: uint32
567688
responses:
568689
"200":
569690
description: OK
@@ -1126,20 +1247,26 @@ components:
11261247
type: array
11271248
items:
11281249
$ref: '#/components/schemas/DataCatalog'
1250+
pageInfo:
1251+
$ref: '#/components/schemas/PageInfo'
11291252
ListDataPoliciesResponse:
11301253
type: object
11311254
properties:
11321255
dataPolicies:
11331256
type: array
11341257
items:
11351258
$ref: '#/components/schemas/DataPolicy'
1259+
pageInfo:
1260+
$ref: '#/components/schemas/PageInfo'
11361261
ListDatabasesResponse:
11371262
type: object
11381263
properties:
11391264
databases:
11401265
type: array
11411266
items:
11421267
$ref: '#/components/schemas/DataCatalog_Database'
1268+
pageInfo:
1269+
$ref: '#/components/schemas/PageInfo'
11431270
ListGlobalTransformsResponse:
11441271
type: object
11451272
properties:
@@ -1154,6 +1281,8 @@ components:
11541281
type: array
11551282
items:
11561283
type: string
1284+
pageInfo:
1285+
$ref: '#/components/schemas/PageInfo'
11571286
ListPluginsResponse:
11581287
type: object
11591288
properties:
@@ -1175,6 +1304,8 @@ components:
11751304
type: array
11761305
items:
11771306
$ref: '#/components/schemas/DataCatalog_Schema'
1307+
pageInfo:
1308+
$ref: '#/components/schemas/PageInfo'
11781309
description: |-
11791310
(-- api-linter: core::0158::response-plural-first-field=disabled
11801311
aip.dev/not-precedent: Schemata? Get real. --)
@@ -1185,6 +1316,8 @@ components:
11851316
type: array
11861317
items:
11871318
$ref: '#/components/schemas/DataCatalog_Table'
1319+
pageInfo:
1320+
$ref: '#/components/schemas/PageInfo'
11881321
NumericRounding_Ceil:
11891322
type: object
11901323
properties:
@@ -1206,6 +1339,13 @@ components:
12061339
type: integer
12071340
description: The precision to use for rounding. When positive, the value is rounded to the nearest decimal place. When negative, the value is rounded to the nearest power of 10.
12081341
format: int32
1342+
PageInfo:
1343+
type: object
1344+
properties:
1345+
total:
1346+
type: integer
1347+
description: The (estimated) total number of records. If the total is unknown, this value is -1.
1348+
format: int32
12091349
Plugin:
12101350
type: object
12111351
properties:

0 commit comments

Comments
 (0)