Skip to content

Commit cc6d4c2

Browse files
authored
refactor: rename OpenAPI endpoints (#1434)
Recently, we created new endpoints: `/v2/acts/:actorId/builds/:buildId/openapi-specification` `/v2/actor-builds/:buildId/openapi-specification` Than we've received a feedback to rename endpoints to `/openapi.json`. **This PR renames OpenAPI endpoints from `*/openapi-specification` to `*/openapi.json`* More context [here](https://apify.slack.com/archives/C01VBUV81UZ/p1737975106009729)
1 parent 5da9aa8 commit cc6d4c2

File tree

5 files changed

+26
-26
lines changed

5 files changed

+26
-26
lines changed

apify-api/openapi/components/tags.yaml

+10-10
Original file line numberDiff line numberDiff line change
@@ -255,15 +255,15 @@
255255
```
256256
257257
In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL.
258-
- name: Actors/Get OpenAPI specification
259-
x-displayName: Get OpenAPI specification
258+
- name: Actors/Get OpenAPI definition
259+
x-displayName: Get OpenAPI definition
260260
x-parent-tag-name: Actors
261261
x-trait: 'true'
262262
description: |
263-
Get the OpenAPI specification for Actor builds. Two similar endpoints are available:
263+
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
264264
265-
- [First endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
266-
- [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
265+
- [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
266+
- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
267267
- name: Actor tasks
268268
x-displayName: Actor tasks
269269
x-legacy-doc-urls:
@@ -561,15 +561,15 @@
561561
- '#tag/Actor-buildsBuild-log'
562562
x-trait: 'true'
563563
description: Check out [Logs](#/reference/logs) for full reference.
564-
- name: Actor builds/Get OpenAPI specification
565-
x-displayName: Get OpenAPI specification
564+
- name: Actor builds/Get OpenAPI definition
565+
x-displayName: Get OpenAPI definition
566566
x-parent-tag-name: Actor builds
567567
x-trait: 'true'
568568
description: |
569-
Get the OpenAPI specification for Actor builds. Two similar endpoints are available:
569+
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
570570
571-
- [First endpoint](/api/v2/act-openapi-specification-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
572-
- [Second endpoint](/api/v2/actor-build-openapi-specification-get): Requires only `buildId`.
571+
- [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
572+
- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
573573
- name: Key-value stores
574574
x-displayName: Key-value stores
575575
x-legacy-doc-urls:

apify-api/openapi/components/x-tag-groups.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
- Actors/Metamorph run
2121
- Actors/Resurrect run
2222
- Actors/Last run object and its storages
23-
- Actors/Get OpenAPI specification
23+
- Actors/Get OpenAPI definition
2424
- name: Actor tasks
2525
tags:
2626
- Actor tasks
@@ -52,7 +52,7 @@
5252
- Actor builds/Delete build
5353
- Actor builds/Abort build
5454
- Actor builds/Build log
55-
- Actor builds/Get OpenAPI specification
55+
- Actor builds/Get OpenAPI definition
5656
- name: Key-value stores
5757
tags:
5858
- Key-value stores

apify-api/openapi/openapi.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -505,8 +505,8 @@ paths:
505505
$ref: 'paths/actors/acts@{actorId}@[email protected]'
506506
'/v2/acts/{actorId}/builds/{buildId}/abort':
507507
$ref: 'paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml'
508-
'/v2/acts/{actorId}/builds/{buildId}/openapi-specification':
509-
$ref: 'paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml'
508+
'/v2/acts/{actorId}/builds/{buildId}/openapi.json':
509+
$ref: 'paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml'
510510
'/v2/acts/{actorId}/runs':
511511
$ref: 'paths/actors/acts@{actorId}@runs.yaml'
512512
'/v2/acts/{actorId}/run-sync':
@@ -559,8 +559,8 @@ paths:
559559
$ref: 'paths/actor-builds/actor-builds@{buildId}@abort.yaml'
560560
'/v2/actor-builds/{buildId}/log':
561561
$ref: 'paths/actor-builds/actor-builds@{buildId}@log.yaml'
562-
'/v2/actor-builds/{buildId}/openapi-specification':
563-
$ref: 'paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml'
562+
'/v2/actor-builds/{buildId}/openapi.json':
563+
$ref: 'paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml'
564564
/v2/key-value-stores:
565565
$ref: paths/key-value-stores/key-value-stores.yaml
566566
'/v2/key-value-stores/{storeId}':

apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
get:
22
tags:
3-
- Actor builds/Get OpenAPI specification
4-
summary: Get OpenAPI specification
3+
- Actor builds/Get OpenAPI definition
4+
summary: Get OpenAPI definition
55
description: |
6-
Get the OpenAPI specification for a specific Actor build.
6+
Get the OpenAPI definition for a specific Actor build.
77
Authentication is based on the build's unique ID. No authentication token is required.
88
9-
**Note**: You can also use the `/api/v2/act-openapi-specification-get` endpoint to get the OpenAPI specification for a build.
10-
operationId: actorBuild_openapiSpecification_get
9+
**Note**: You can also use the `/api/v2/act-openapi-json-get` endpoint to get the OpenAPI definition for a build.
10+
operationId: actorBuild_openapi_json_get
1111
security:
1212
- apiKeyActorBuilds: []
1313
- httpBearerActorBuilds: []

apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
get:
22
tags:
3-
- Actors/Get OpenAPI specification
4-
summary: Get OpenAPI specification
3+
- Actors/Get OpenAPI definition
4+
summary: Get OpenAPI definition
55
description: |
6-
Get the OpenAPI specification for a specific Actor build.
6+
Get the OpenAPI definition for a specific Actor build.
77
88
To fetch the default Actor build, simply pass `default` as the `buildId`.
99
Authentication is based on the build's unique ID. No authentication token is required.
1010
11-
**Note**: You can also use the `/api/v2/actor-build-openapi-specification-get` endpoint to get the OpenAPI specification for a build.
12-
operationId: act_openapiSpecification_get
11+
**Note**: You can also use the `/api/v2/actor-build-openapi-json-get` endpoint to get the OpenAPI definition for a build.
12+
operationId: act_openapi_json_get
1313
security:
1414
- apiKeyActorBuilds: []
1515
- httpBearerActorBuilds: []

0 commit comments

Comments
 (0)