@rxap/plugin-gpt 20.1.4-dev.3 → 20.2.0-dev.2

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [20.2.0-dev.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.2.0-dev.1...@rxap/plugin-gpt@20.2.0-dev.2) (2026-01-13)
+
+**Note:** Version bump only for package @rxap/plugin-gpt
+
+# [20.2.0-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.2.0-dev.0...@rxap/plugin-gpt@20.2.0-dev.1) (2026-01-12)
+
+### Bug Fixes
+
+- update package groups ([ba8753f](https://gitlab.com/rxap/packages/commit/ba8753f5f34680adc282d84c557fc43385bfa987))
+
+# [20.2.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.4-dev.3...@rxap/plugin-gpt@20.2.0-dev.0) (2026-01-12)
+
+### Features
+
+- **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
+
 ## [20.1.4-dev.3](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.4-dev.2...@rxap/plugin-gpt@20.1.4-dev.3) (2025-09-18)
 
 **Note:** Version bump only for package @rxap/plugin-gpt

package/README.md

@@ -33,13 +33,13 @@ nx g @rxap/plugin-gpt:documentation
 
 Option | Type | Default | Description
 --- | --- | --- | ---
-projects | array |  | A list of projects where the documentation should be generated
-project | string |  | 
-offline | boolean |  | If true, the openai api is not used
-filter | string |  | A filter to select the files to be processed
-openaiApiKey | string |  | The openai api key
-openaiOrgId | string |  | The openai organization id
-openaiProjectId | string |  | The openai project id
+projects | array |  | The list of projects to generate documentation for.
+project | string |  | The name of a single project to generate documentation for.
+offline | boolean |  | Whether to skip using the OpenAI API and operate in offline mode.
+filter | string |  | A glob pattern filter to select specific files for documentation generation.
+openaiApiKey | string |  | The API key for accessing OpenAI services.
+openaiOrgId | string |  | The organization ID for OpenAI API requests.
+openaiProjectId | string |  | The project ID for OpenAI API requests.
 
 ## init
 > Initialize the package in the workspace

package/package.json

@@ -1,13 +1,13 @@
 {
-  "version": "20.1.4-dev.3",
+  "version": "20.2.0-dev.2",
   "name": "@rxap/plugin-gpt",
   "description": "This package provides a generator to add JSDoc documentation to TypeScript code using the OpenAI API. It can process functions and methods, and composes a context for the AI to generate accurate documentation. The generator also includes utilities for cleaning up JSDoc comments and managing OpenAI API interactions.\n",
   "license": "GPL-3.0-or-later",
   "dependencies": {
     "@nx/devkit": "20.5.0",
-    "@rxap/ts-morph": "^1.6.0-dev.2",
-    "@rxap/workspace-ts-morph": "^19.1.13-dev.3",
-    "@rxap/workspace-utilities": "^19.8.1-dev.2",
+    "@rxap/ts-morph": "^1.6.0-dev.3",
+    "@rxap/workspace-ts-morph": "^19.1.13-dev.4",
+    "@rxap/workspace-utilities": "^19.8.1-dev.3",
     "gpt-3-encoder": "^1.1.4",
     "openai": "^4.52.0",
     "ts-morph": "18.0.0",
@@ -44,7 +44,7 @@
   },
   "schematics": "./generators.json",
   "type": "commonjs",
-  "gitHead": "ef20bc50270ad0727a111d54e48cb279ff3ed5cf",
+  "gitHead": "69d6ee61a20632f52b77de621089334a34f45e03",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"
 }

package/src/generators/documentation/schema.json

@@ -7,33 +7,37 @@
     "projects": {
       "alias": "project",
       "type": "array",
-      "description": "A list of projects where the documentation should be generated",
+      "description": "The list of projects to generate documentation for.",
       "items": {
         "type": "string"
-      }
+      },
+      "examples": [["my-app", "my-lib"]]
     },
     "project": {
-      "type": "string"
+      "type": "string",
+      "description": "The name of a single project to generate documentation for.",
+      "examples": ["my-app"]
     },
     "offline": {
       "type": "boolean",
-      "description": "If true, the openai api is not used"
+      "description": "Whether to skip using the OpenAI API and operate in offline mode."
     },
     "filter": {
       "type": "string",
-      "description": "A filter to select the files to be processed"
+      "description": "A glob pattern filter to select specific files for documentation generation.",
+      "examples": ["src/**/*.ts"]
     },
     "openaiApiKey": {
       "type": "string",
-      "description": "The openai api key"
+      "description": "The API key for accessing OpenAI services."
     },
     "openaiOrgId": {
       "type": "string",
-      "description": "The openai organization id"
+      "description": "The organization ID for OpenAI API requests."
     },
     "openaiProjectId": {
       "type": "string",
-      "description": "The openai project id"
+      "description": "The project ID for OpenAI API requests."
     }
   }
 }