Skip to content

Commit 5ae15ec

Browse files
authored
refactor: rename /openapi-specification -> /openapi.json (#339)
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 61b8d85 commit 5ae15ec

File tree

1 file changed

+10
-10
lines changed
  • src/apify_client/clients/resource_clients

1 file changed

+10
-10
lines changed

src/apify_client/clients/resource_clients/build.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,16 @@ def abort(self) -> dict:
4343
"""
4444
return self._abort()
4545

46-
def get_open_api_specification(self) -> dict | None:
47-
"""Return OpenAPI specification of the Actor's build.
46+
def get_open_api_definition(self) -> dict | None:
47+
"""Return OpenAPI definition of the Actor's build.
4848
49-
https://docs.apify.com/api/v2/actor-build-openapi-specification-get
49+
https://docs.apify.com/api/v2/actor-build-openapi-json-get
5050
5151
Returns:
52-
OpenAPI specification of the Actor's build.
52+
OpenAPI definition of the Actor's build.
5353
"""
5454
response = self.http_client.call(
55-
url=self._url('openapi-specification'),
55+
url=self._url('openapi.json'),
5656
method='GET',
5757
)
5858

@@ -120,16 +120,16 @@ async def delete(self) -> None:
120120
"""
121121
return await self._delete()
122122

123-
async def get_open_api_specification(self) -> dict | None:
124-
"""Return OpenAPI specification of the Actor's build.
123+
async def get_open_api_definition(self) -> dict | None:
124+
"""Return OpenAPI definition of the Actor's build.
125125
126-
https://docs.apify.com/api/v2/actor-build-openapi-specification-get
126+
https://docs.apify.com/api/v2/actor-build-openapi-json-get
127127
128128
Returns:
129-
OpenAPI specification of the Actor's build.
129+
OpenAPI definition of the Actor's build.
130130
"""
131131
response = await self.http_client.call(
132-
url=self._url('openapi-specification'),
132+
url=self._url('openapi.json'),
133133
method='GET',
134134
)
135135

0 commit comments

Comments
 (0)