@ama-openapi/create 14.4.0-prerelease.4 → 14.4.0-prerelease.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ama-openapi/create",
|
|
3
|
-
"version": "14.4.0-prerelease.
|
|
3
|
+
"version": "14.4.0-prerelease.5",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -38,8 +38,8 @@
|
|
|
38
38
|
}
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@ama-openapi/core": "~14.4.0-prerelease.
|
|
42
|
-
"@o3r/telemetry": "~14.4.0-prerelease.
|
|
41
|
+
"@ama-openapi/core": "~14.4.0-prerelease.5",
|
|
42
|
+
"@o3r/telemetry": "~14.4.0-prerelease.5",
|
|
43
43
|
"ejs": "~3.1.9",
|
|
44
44
|
"globby": "^11.1.0",
|
|
45
45
|
"tslib": "^2.6.2",
|
|
@@ -53,10 +53,10 @@
|
|
|
53
53
|
"@nx/eslint-plugin": "~22.7.0",
|
|
54
54
|
"@nx/jest": "~22.7.0",
|
|
55
55
|
"@nx/js": "~22.7.0",
|
|
56
|
-
"@o3r/build-helpers": "~14.4.0-prerelease.
|
|
57
|
-
"@o3r/eslint-config": "~14.4.0-prerelease.
|
|
58
|
-
"@o3r/eslint-plugin": "~14.4.0-prerelease.
|
|
59
|
-
"@o3r/test-helpers": "~14.4.0-prerelease.
|
|
56
|
+
"@o3r/build-helpers": "~14.4.0-prerelease.5",
|
|
57
|
+
"@o3r/eslint-config": "~14.4.0-prerelease.5",
|
|
58
|
+
"@o3r/eslint-plugin": "~14.4.0-prerelease.5",
|
|
59
|
+
"@o3r/test-helpers": "~14.4.0-prerelease.5",
|
|
60
60
|
"@schematics/angular": "~21.2.0",
|
|
61
61
|
"@stylistic/eslint-plugin": "~5.10.0",
|
|
62
62
|
"@types/ejs": "^3.1.2",
|
|
@@ -2,6 +2,40 @@
|
|
|
2
2
|
|
|
3
3
|
This package exposes [OpenApi specification](https://swagger.io/specification/) which can be used to use to generate an SDK or be referred in another specification.
|
|
4
4
|
|
|
5
|
+
## LLM Integration
|
|
6
|
+
|
|
7
|
+
This project uses the **`ama-openapi`** plugin from the Otter marketplace to enhance LLM-powered coding assistants with
|
|
8
|
+
OpenAPI specification operations.
|
|
9
|
+
|
|
10
|
+
**What the plugin provides:**
|
|
11
|
+
|
|
12
|
+
- OpenAPI spec editing, validation, and linting assistance
|
|
13
|
+
- Model generation and SDK scaffolding support
|
|
14
|
+
- Intelligent suggestions for API design and spec operations
|
|
15
|
+
- Integration with the Redocly workflow used in this project
|
|
16
|
+
|
|
17
|
+
**Setup for VS Code with GitHub Copilot:**
|
|
18
|
+
|
|
19
|
+
The plugin is already configured in this project's `.claude/` instructions. To use it with GitHub Copilot in VS Code:
|
|
20
|
+
|
|
21
|
+
1. **Install GitHub Copilot Extension:**
|
|
22
|
+
- Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
|
|
23
|
+
- Or search for "GitHub Copilot" in VS Code Extensions
|
|
24
|
+
|
|
25
|
+
2. **Verify Plugin Configuration:**
|
|
26
|
+
- The plugin instructions are configured in the `.claude/` directory
|
|
27
|
+
- The Otter marketplace is configured to use the GitHub repo `AmadeusITGroup/otter`
|
|
28
|
+
|
|
29
|
+
3. **Usage:**
|
|
30
|
+
- When working in the `spec/` directory, Copilot will automatically use the plugin for OpenAPI-related tasks
|
|
31
|
+
- Ask Copilot to help with spec editing, validation, or model generation
|
|
32
|
+
- The plugin understands the Redocly workflow and project structure
|
|
33
|
+
|
|
34
|
+
**Documentation:**
|
|
35
|
+
|
|
36
|
+
- [Otter Plugin Documentation](https://github.com/AmadeusITGroup/otter/tree/main/tools/llm/plugins/ama-openapi)
|
|
37
|
+
- [GitHub Copilot Documentation](https://docs.github.com/en/copilot)
|
|
38
|
+
|
|
5
39
|
## How to work on it
|
|
6
40
|
|
|
7
41
|
**Requirements:**
|