Improve wording

- Remove `currently` since it adds nothing - Make sure we always refer to these as calendar versions. Signed-off-by: Ruben Aguiar <[email protected]>
lune-climate · Sep 6, 2024 · eaa6ff7 · eaa6ff7
1 parent 679739b
commit eaa6ff7
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ $ openapi --help
     -V, --version             output the version number
     -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
     -o, --output <value>      Output directory (required)
-    -v, --apiVersions <value> API Versions currently supported separated by a comma (required)
+    -v, --apiVersions <value> API calendar versions supported separated by a comma (required)
     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
     --name <value>            Custom client class name
     --useOptions              Use options instead of arguments

diff --git a/bin/index.js b/bin/index.js
@@ -12,7 +12,7 @@ const params = program
     .version(pkg.version)
     .requiredOption('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
     .requiredOption('-o, --output <value>', 'Output directory (required)')
-    .requiredOption('-v, --apiVersions <value>', 'API Versions currently supported separated by a comma (required)')
+    .requiredOption('-v, --apiVersions <value>', 'API calendar versions supported separated by a comma (required)')
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')

diff --git a/docs/basic-usage.md b/docs/basic-usage.md
@@ -9,7 +9,7 @@ $ openapi --help
     -V, --version             output the version number
     -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
     -o, --output <value>      Output directory (required)
-    -v, --apiVersions <value> API Versions currently supported separated by a comma (required)
+    -v, --apiVersions <value> API calendar versions supported separated by a comma (required)
     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
     --name <value>            Custom client class name
     --useOptions              Use options instead of arguments
@@ -30,6 +30,7 @@ $ openapi --help
 ## Example
 
 **package.json**
+
 ```json
 {
     "scripts": {

diff --git a/src/index.ts b/src/index.ts
@@ -36,7 +36,7 @@ export type Options = {
  * service layer, etc.
  * @param input The relative location of the OpenAPI spec
  * @param output The relative location of the output directory
- * @param apiVersions All API versions that are available at this point in time.
+ * @param apiVersions All API calendar versions that are available at this point in time.
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param clientName Custom client class name
  * @param useOptions Use options or arguments functions

diff --git a/src/openApi/v2/index.ts b/src/openApi/v2/index.ts
@@ -8,7 +8,7 @@ import { getServiceVersion } from './parser/getServiceVersion';
 /**
  * Parse the OpenAPI specification to a Client model that contains
  * all the models, services and schema's we should output.
- * @param apiVersions All API versions that are available at this point in time.
+ * @param apiVersions All API calendar versions that are available at this point in time.
  * @param openApi The OpenAPI spec  that we have loaded from disk.
  */
 export const parse = (apiVersions: string[], openApi: OpenApi): Client => {

diff --git a/src/openApi/v3/index.ts b/src/openApi/v3/index.ts
@@ -8,7 +8,7 @@ import { getServiceVersion } from './parser/getServiceVersion';
 /**
  * Parse the OpenAPI specification to a Client model that contains
  * all the models, services and schema's we should output.
- * @param apiVersions All API versions that are available at this point in time.
+ * @param apiVersions All API calendar versions that are available at this point in time.
  * @param openApi The OpenAPI spec  that we have loaded from disk.
  */
 export const parse = (apiVersions: string[], openApi: OpenApi): Client => {

diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -17,7 +17,7 @@ import { writeLuneClient } from './writeLuneClient';
 
 /**
  * Write our OpenAPI client, using the given templates at the given output
- * @param apiVersions All API versions that are available at this point in time.
+ * @param apiVersions All API calendar versions that are available at this point in time.
  * @param client Client object with all the models, services, etc.
  * @param templates Templates wrapper with all loaded Handlebars templates
  * @param output The relative location of the output directory

diff --git a/src/utils/writeLuneClient.ts b/src/utils/writeLuneClient.ts
@@ -9,7 +9,7 @@ import { sortServicesByName } from './sortServicesByName';
 /**
  * Generate our custom Lune client file. This is the main file used to export everything and that defines
  * how to use our client. It re exports all models and services so they become available at the base level.
- * @param apiVersions All API versions that are available at this point in time.
+ * @param apiVersions All API calendar versions that are available at this point in time.
  * @param client Client object, containing, models, schemas and services
  * @param templates The loaded handlebar templates
  * @param outputPath Directory to write the generated files to