From 4d8fc338156ee844a060a8e31a7256ddb857a65d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= Date: Fri, 17 Jan 2025 18:11:07 +0100 Subject: [PATCH 1/4] docs: add full schema link --- apify-api/openapi/openapi.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index a0f3b23bf8..c356114b49 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -10,7 +10,9 @@ info: The Apify API (version 2) provides programmatic access to the [Apify platform](https://docs.apify.com). The API is organized around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) - HTTP endpoints. + HTTP endpoints. + + You can check the complete OpenAPI schema [here](https://docs.apify.com/api/apify-api.yaml). All requests and responses (including errors) are encoded in [JSON](http://www.json.org/) format with UTF-8 encoding, From 154c429f1ba20204aced5d3b5edd8696dc929edb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= Date: Wed, 22 Jan 2025 14:42:10 +0100 Subject: [PATCH 2/4] adjust links add separate links for YAML & JSON reformat the description to account for new links & available formats --- apify-api/openapi/openapi.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index c356114b49..079c34e561 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -12,7 +12,10 @@ info: around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) HTTP endpoints. - You can check the complete OpenAPI schema [here](https://docs.apify.com/api/apify-api.yaml). + You can check the complete OpenAPI schema in the following formats: + + - [OpenAPI YAML](http://docs.apify.com/api/openapi.yaml) + - [OpenAPI JSON](http://docs.apify.com/api/openapi.json) All requests and responses (including errors) are encoded in [JSON](http://www.json.org/) format with UTF-8 encoding, From 752c5e8f30b8dd68e336e4593d42d2d53c83c72f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 23 Jan 2025 15:20:08 +0100 Subject: [PATCH 3/4] Update apify-api/openapi/openapi.yaml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jan Čurn --- apify-api/openapi/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 079c34e561..32c390e482 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -12,7 +12,7 @@ info: around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) HTTP endpoints. - You can check the complete OpenAPI schema in the following formats: +You can download the complete OpenAPI schema of Apify API in the [YAML](http://docs.apify.com/api/openapi.yaml) or [JSON](http://docs.apify.com/api/openapi.json) formats. The source code is available on [GitHub](https://github.com/apify/apify-docs/tree/master/apify-api/openapi). - [OpenAPI YAML](http://docs.apify.com/api/openapi.yaml) - [OpenAPI JSON](http://docs.apify.com/api/openapi.json) From f66b77a89e2ab61fc146ffe048d547a934596fe8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= Date: Thu, 23 Jan 2025 15:26:33 +0100 Subject: [PATCH 4/4] fix build and lint --- apify-api/openapi/openapi.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 32c390e482..0887c8b55a 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -12,10 +12,7 @@ info: around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) HTTP endpoints. -You can download the complete OpenAPI schema of Apify API in the [YAML](http://docs.apify.com/api/openapi.yaml) or [JSON](http://docs.apify.com/api/openapi.json) formats. The source code is available on [GitHub](https://github.com/apify/apify-docs/tree/master/apify-api/openapi). - - - [OpenAPI YAML](http://docs.apify.com/api/openapi.yaml) - - [OpenAPI JSON](http://docs.apify.com/api/openapi.json) + You can download the complete OpenAPI schema of Apify API in the [YAML](http://docs.apify.com/api/openapi.yaml) or [JSON](http://docs.apify.com/api/openapi.json) formats. The source code is also available on [GitHub](https://github.com/apify/apify-docs/tree/master/apify-api/openapi). All requests and responses (including errors) are encoded in [JSON](http://www.json.org/) format with UTF-8 encoding,