From e704aa3e89b43f13c5db900134232b159743dd10 Mon Sep 17 00:00:00 2001 From: Olivier Lando Date: Wed, 4 Oct 2023 15:02:28 +0200 Subject: [PATCH] fix(doc) remove irrelevant sections from api clients doc --- templates/csharp/documentation.mustache | 11 ----------- templates/go/documentation.mustache | 10 ---------- .../java/libraries/okhttp-gson/documentation.mustache | 10 ---------- templates/nodejs/documentation.md.mustache | 11 ----------- templates/php/documentation.mustache | 11 ----------- templates/python/documentation.mustache | 10 ---------- templates/swift5/documentation.mustache | 10 ---------- 7 files changed, 73 deletions(-) diff --git a/templates/csharp/documentation.mustache b/templates/csharp/documentation.mustache index de1dc78f..b545eacb 100644 --- a/templates/csharp/documentation.mustache +++ b/templates/csharp/documentation.mustache @@ -177,14 +177,3 @@ ApiVideoClient apiVideoClient = new ApiVideoClient(); ## Recommendation It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. - -## Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/go/documentation.mustache b/templates/go/documentation.mustache index e5e57dad..0491cc52 100644 --- a/templates/go/documentation.mustache +++ b/templates/go/documentation.mustache @@ -121,13 +121,3 @@ Method | HTTP request | Description {{#models}}{{#model}} - [{{{classname}}}](https://github.com/apivideo/api.video-go-client/blob/main/{{modelDocPath}}{{{classname}}}.md) {{/model}}{{/models}} - -# Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/java/libraries/okhttp-gson/documentation.mustache b/templates/java/libraries/okhttp-gson/documentation.mustache index 1282b9cc..81ac4f5c 100644 --- a/templates/java/libraries/okhttp-gson/documentation.mustache +++ b/templates/java/libraries/okhttp-gson/documentation.mustache @@ -270,13 +270,3 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea {{#android}} For direct call with `ApiClient`: Do not call API from the main thread, otherwise you will get a `android.os.NetworkOnMainThreadException`. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this. Alternatively, APIs come with an asynchronous counterpart (`createAsync` for `create`) except for the upload endpoint. {{/android}} - -## Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/nodejs/documentation.md.mustache b/templates/nodejs/documentation.md.mustache index 183843d9..980a876a 100644 --- a/templates/nodejs/documentation.md.mustache +++ b/templates/nodejs/documentation.md.mustache @@ -102,14 +102,3 @@ Some endpoints don't require authentication. These one can be called with an Api ```js const client = new ApiVideoClient(); ``` - -# Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/php/documentation.mustache b/templates/php/documentation.mustache index 1a77053b..e6656992 100644 --- a/templates/php/documentation.mustache +++ b/templates/php/documentation.mustache @@ -144,14 +144,3 @@ These identifiers must belong to a real api.video account. ``` $ BASE_URI="" API_KEY="..." vendor/bin/phpunit ``` - - -## Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/python/documentation.mustache b/templates/python/documentation.mustache index fdf233af..231fdb8c 100644 --- a/templates/python/documentation.mustache +++ b/templates/python/documentation.mustache @@ -95,13 +95,3 @@ Method | HTTP request | Description {{#models}}{{#model}} - [{{{classname}}}](https://github.com/apivideo/api.video-python-client/blob/main/{{modelDocPath}}{{{classname}}}.md) {{/model}}{{/models}} - -# Have you gotten use from this API client? - -Please take a moment to leave a star on the client - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/templates/swift5/documentation.mustache b/templates/swift5/documentation.mustache index 293f3a2e..d31efc31 100644 --- a/templates/swift5/documentation.mustache +++ b/templates/swift5/documentation.mustache @@ -130,13 +130,3 @@ The access token generation mechanism is automatically handled by the client. Al ### Public endpoints Some endpoints don't require authentication. These one can be called without setting `{{projectName}}.apiKey`: - -## Have you gotten use from this API client? - -Please take a moment to leave a star on the client ⭐ - -This helps other users to find the clients and also helps us understand which clients are most popular. Thank you! - -# Contribution - -Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository.