refactor(nx-plugin): update schema prompts and descriptions for clarity in update-api and openapi-client

Author: seriouslag

packages/nx-plugin/src/executors/update-api/schema.json

@@ -8,46 +8,43 @@
     "name": {
       "type": "string",
       "description": "The name of the project",
-      "x-prompt": "What is the name of the project? (e.g. my-api)",
       "$default": {
         "$source": "argv",
         "index": 0
-      }
-    },
-    "spec": {
-      "type": "string",
-      "description": "The path to the OpenAPI spec file",
-      "x-prompt": "What is the path to the OpenAPI spec file? (URI or local file path)"
+      },
+      "x-prompt": "What name would you like to use for the library? (e.g. my-api)"
     },
-    "client": {
+    "directory": {
       "type": "string",
-      "description": "The type of client to generate",
-      "x-prompt": "What is the type of client to generate? (@hey-api/client-fetch, @hey-api/client-axios)",
-      "default": "@hey-api/client-fetch"
+      "description": "Directory where the library will be created",
+      "default": "libs"
     },
     "scope": {
       "type": "string",
       "description": "The scope of the project",
       "x-prompt": "What is the scope of the project? (e.g. @my-org)"
     },
-    "directory": {
+    "spec": {
       "type": "string",
-      "description": "The directory of the project",
-      "x-prompt": "What is the directory of the project? (e.g. libs)",
-      "default": "libs"
+      "description": "Path to the OpenAPI spec file (URL or local path)",
+      "x-prompt": "What is the path to the OpenAPI spec file? (URI or local file path)"
+    },
+    "client": {
+      "type": "string",
+      "description": "The type of client to generate (@hey-api/client-fetch, @hey-api/client-axios, etc)",
+      "default": "@hey-api/client-fetch"
     },
     "plugins": {
       "type": "array",
-      "description": "The plugins to use",
-      "x-prompt": "What plugins would you like to use? (e.g. @tanstack/react-query)",
+      "description": "The plugins to be provided to @hey-api/openapi-ts",
       "default": [],
       "items": {
         "type": "string"
       }
     },
     "force": {
       "type": "boolean",
-      "description": "If true, the Client code will be regenerated even if the spec has not changed",
+      "description": "If true, the Client code will be regenerated even if the spec has not changed, also pass --skip-nx-cache to avoid caching issues",
       "default": false
     }
   },

packages/nx-plugin/src/generators/openapi-client/schema.json

@@ -8,12 +8,12 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "Library name",
+      "description": "The name of the project",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use for the library?"
+      "x-prompt": "What name would you like to use for the library? (e.g. my-api)"
     },
     "directory": {
       "type": "string",
@@ -22,45 +22,44 @@
     },
     "scope": {
       "type": "string",
-      "description": "Scope of the library",
-      "x-prompt": "What is the scope of the library?"
+      "description": "The scope of the project",
+      "x-prompt": "What is the scope of the project? (e.g. @my-org)"
     },
     "spec": {
       "type": "string",
       "description": "Path to the OpenAPI spec file (URL or local path)",
-      "x-prompt": "What is the URL or local path to the OpenAPI spec file?"
-    },
-    "tags": {
-      "type": "array",
-      "description": "Add tags to the library (comma-separated)",
-      "default": ["api", "openapi"],
-      "items": {
-        "type": "string"
-      }
+      "x-prompt": "What is the path to the OpenAPI spec file? (URI or local file path)"
     },
     "client": {
       "type": "string",
-      "description": "Type of client to generate",
-      "default": "@hey-api/client-fetch",
-      "x-prompt": "Which client type would you like to use?"
+      "description": "The type of client to generate (@hey-api/client-fetch, @hey-api/client-axios, etc)",
+      "default": "@hey-api/client-fetch"
     },
     "plugins": {
       "type": "array",
-      "description": "Plugins to use",
+      "description": "The plugins to be provided to @hey-api/openapi-ts",
       "default": [],
       "items": {
         "type": "string"
       }
     },
+    "tags": {
+      "type": "array",
+      "description": "Add tags to the library (comma-separated)",
+      "default": ["api", "openapi"],
+      "items": {
+        "type": "string"
+      }
+    },
     "test": {
       "type": "string",
-      "description": "Test to use",
+      "description": "The test runner to use",
       "default": "none",
       "enum": ["none", "vitest"]
     },
     "private": {
       "type": "boolean",
-      "description": "Whether to make the generated package private",
+      "description": "Whether to make the generated package private, put false if you want to publish the package.",
       "default": true
     }
   },