JS Client - OpenAPI Generator generates wrong version format and incomplete details
jzanecook opened this issue · comments
J. Zane Cook commented
Is your feature request related to a problem? Please describe.
The JS Client will override the package.json and README with details that are incorrect. The expected changes are as follows:
- The version needs to be full semantic versioning format, e.g. v1.0.0 instead of just v1
- The package.json needs to have the repository in there, currently it is incomplete.
- The README needs to include instructions for setting up the example, including what commands to run.
Steps to reproduce
- You can generate the OpenAPI tool using the
npm run generate:client:js
in the root folder of the repository - Double check the outputs of
packages/client/js/package.json
andpackages/client/js/README.md
Here is the current output of the package.json
file.
{
"name": "agent-protocol-client",
"version": "v1",
"description": "OpenAPI client for agent-protocol-client",
"author": "OpenAPI-Generator",
"repository": {
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
},
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
"scripts": {
"build": "tsc",
"prepare": "npm run build"
},
"devDependencies": {
"typescript": "^4.0"
}
}
Here is the expected output of the package.json
{
"name": "agent-protocol-client",
"version": "v1.0.0", <----- Version should use semantic
"description": "Typescript Client for the Agent Protocol", <----- Description should be more specific about the agent protocol client for the npm package.
"author": "AI Engineer Foundation", <----- Author should be AI Engineer Foundation
"repository": {
"type": "git",
"url": "https://github.com/AI-Engineer-Foundation/agent-protocol.git" <----- Repository should be the correct one
},
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
"scripts": {
"build": "tsc",
"prepare": "npm run build"
},
"devDependencies": {
"typescript": "^4.0"
}
}
About the README
The README should ideally include the instructions on setting up the minimal example and using the client to a base level. Reference the current (modified) README file for the added section on setting up the example.
J. Zane Cook commented
@wilsonianb @hackgoofer Please take a look when you get a chance 👍