Skip to content

Commit 05f0d29

Browse files
authored
refactor(openapi): Improve names of internal endpoint identifiers (#2525)
1 parent e41d625 commit 05f0d29

25 files changed

Lines changed: 40 additions & 40 deletions

apify-api/openapi/components/objects/datasets/dataset-items.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ sharedGet: &sharedGet
9292
$ref: ../../responses/BadRequest.yaml
9393
deprecated: false
9494

95-
getById:
95+
listById:
9696
<<: [*sharedGet, *sharedTagById, *parametersGetHeadById]
9797
summary: Get dataset items
9898
description: |
@@ -257,7 +257,7 @@ getById:
257257
x-py-name: stream_items
258258
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#stream_items
259259

260-
getDefault:
260+
listDefault:
261261
<<: [*sharedGet, *sharedTagDefault]
262262
summary: Get default dataset items
263263
description: |
@@ -290,7 +290,7 @@ getDefault:
290290
- $ref: "../../parameters/datasetParameters.yaml#/skipFailedPages"
291291
- $ref: "../../parameters/storageParameters.yaml#/signature"
292292

293-
getLastRun:
293+
listLastRun:
294294
<<: [*sharedGet, *sharedTagLastRun]
295295
summary: Get last run's dataset items
296296
description: |
@@ -324,7 +324,7 @@ getLastRun:
324324
- $ref: "../../parameters/datasetParameters.yaml#/skipFailedPages"
325325
- $ref: "../../parameters/storageParameters.yaml#/signature"
326326

327-
getTaskLastRun:
327+
listTaskLastRun:
328328
<<: [*sharedGet, *sharedTagTaskLastRun]
329329
summary: Get last task run's dataset items
330330
description: |

apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ sharedGet: &sharedGet
4040
$ref: ../../schemas/key-value-stores/ListOfKeysResponse.yaml
4141
deprecated: false
4242

43-
getById:
43+
listById:
4444
<<: [*sharedGet, *sharedTagById]
4545
summary: Get list of keys
4646
description: |
@@ -68,7 +68,7 @@ getById:
6868
x-py-name: list_keys
6969
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#list_keys
7070

71-
getDefault:
71+
listDefault:
7272
<<: [*sharedGet, *sharedTagDefault]
7373
summary: Get default store's list of keys
7474
description: |
@@ -85,7 +85,7 @@ getDefault:
8585
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixKeys"
8686
- $ref: "../../parameters/storageParameters.yaml#/signature"
8787

88-
getLastRun:
88+
listLastRun:
8989
<<: [*sharedGet, *sharedTagLastRun]
9090
summary: Get last run's default store's list of keys
9191
description: |
@@ -103,7 +103,7 @@ getLastRun:
103103
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixKeys"
104104
- $ref: "../../parameters/storageParameters.yaml#/signature"
105105

106-
getTaskLastRun:
106+
listTaskLastRun:
107107
<<: [*sharedGet, *sharedTagTaskLastRun]
108108
summary: Get last task run's default store's list of keys
109109
description: |

apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ sharedGet: &sharedGet
4343
<<: [*common200, *commonErrors]
4444
deprecated: false
4545

46-
getById:
46+
listById:
4747
<<: [*sharedGet, *sharedTagById]
4848
summary: Download records
4949
description: |
@@ -58,7 +58,7 @@ getById:
5858
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixRecords"
5959
- $ref: "../../parameters/storageParameters.yaml#/signature"
6060

61-
getDefault:
61+
listDefault:
6262
<<: [*sharedGet, *sharedTagDefault]
6363
summary: Download default store's records
6464
description: |
@@ -73,7 +73,7 @@ getDefault:
7373
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixRecords"
7474
- $ref: "../../parameters/storageParameters.yaml#/signature"
7575

76-
getLastRun:
76+
listLastRun:
7777
<<: [*sharedGet, *sharedTagLastRun]
7878
summary: Download last run's default store's records
7979
description: |
@@ -89,7 +89,7 @@ getLastRun:
8989
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixRecords"
9090
- $ref: "../../parameters/storageParameters.yaml#/signature"
9191

92-
getTaskLastRun:
92+
listTaskLastRun:
9393
<<: [*sharedGet, *sharedTagTaskLastRun]
9494
summary: Download last task run's default store's records
9595
description: |

apify-api/openapi/components/objects/request-queues/request-queue-head.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ sharedGet: &sharedGet
4040
<<: *commonErrors
4141
deprecated: false
4242

43-
getById:
43+
listById:
4444
<<: [*sharedGet, *sharedTagById]
4545
summary: Get head
4646
description: |
@@ -68,7 +68,7 @@ getById:
6868
x-py-name: list_head
6969
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_head
7070

71-
getDefault:
71+
listDefault:
7272
<<: [*sharedGet, *sharedTagDefault]
7373
summary: Get default request queue head
7474
description: |
@@ -82,7 +82,7 @@ getDefault:
8282
- $ref: "../../parameters/requestQueueParameters.yaml#/headLimit"
8383
- $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
8484

85-
getLastRun:
85+
listLastRun:
8686
<<: [*sharedGet, *sharedTagLastRun]
8787
summary: Get last run's default request queue head
8888
description: |
@@ -97,7 +97,7 @@ getLastRun:
9797
- $ref: "../../parameters/requestQueueParameters.yaml#/headLimit"
9898
- $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
9999

100-
getTaskLastRun:
100+
listTaskLastRun:
101101
<<: [*sharedGet, *sharedTagTaskLastRun]
102102
summary: Get last task run's default request queue head
103103
description: |

apify-api/openapi/components/objects/request-queues/request-queue-requests.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ sharedGet: &sharedGet
4040
<<: *commonErrors
4141
deprecated: false
4242

43-
getById:
43+
listById:
4444
<<: [*sharedGet, *sharedTagById]
4545
summary: List requests
4646
description: |
@@ -65,7 +65,7 @@ getById:
6565
x-py-name: list_requests
6666
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests
6767

68-
getDefault:
68+
listDefault:
6969
<<: [*sharedGet, *sharedTagDefault]
7070
summary: List default request queue's requests
7171
description: |
@@ -82,7 +82,7 @@ getDefault:
8282
- $ref: "../../parameters/requestQueueParameters.yaml#/cursor"
8383
- $ref: "../../parameters/requestQueueParameters.yaml#/filter"
8484

85-
getLastRun:
85+
listLastRun:
8686
<<: [*sharedGet, *sharedTagLastRun]
8787
summary: List last run's default request queue's requests
8888
description: |
@@ -100,7 +100,7 @@ getLastRun:
100100
- $ref: "../../parameters/requestQueueParameters.yaml#/cursor"
101101
- $ref: "../../parameters/requestQueueParameters.yaml#/filter"
102102

103-
getTaskLastRun:
103+
listTaskLastRun:
104104
<<: [*sharedGet, *sharedTagTaskLastRun]
105105
summary: List last task run's default request queue's requests
106106
description: |
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
get:
2-
$ref: "../../components/objects/datasets/dataset-items.yaml#/getDefault"
2+
$ref: "../../components/objects/datasets/dataset-items.yaml#/listDefault"
33
post:
44
$ref: "../../components/objects/datasets/dataset-items.yaml#/postDefault"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
get:
2-
$ref: "../../components/objects/key-value-stores/key-value-store-keys.yaml#/getDefault"
2+
$ref: "../../components/objects/key-value-stores/key-value-store-keys.yaml#/listDefault"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
get:
2-
$ref: "../../components/objects/key-value-stores/key-value-store-records.yaml#/getDefault"
2+
$ref: "../../components/objects/key-value-stores/key-value-store-records.yaml#/listDefault"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
get:
2-
$ref: "../../components/objects/request-queues/request-queue-head.yaml#/getDefault"
2+
$ref: "../../components/objects/request-queues/request-queue-head.yaml#/listDefault"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
get:
2-
$ref: "../../components/objects/request-queues/request-queue-requests.yaml#/getDefault"
2+
$ref: "../../components/objects/request-queues/request-queue-requests.yaml#/listDefault"
33
post:
44
$ref: "../../components/objects/request-queues/request-queue-requests.yaml#/postDefault"

0 commit comments

Comments
 (0)