Generator removes the already existing old versions content
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi, typescript
- Domain
- api, backend-api-design
Research direction
Start by reproducing the issue with both the AsyncAPI and OpenAPI generators for Service A, then inspect the generated latest and versioned folders shown in the screenshots. Done means generating version 2 with OpenAPI preserves the existing version 1 content instead of removing it, while still updating the intended service version.
Written by the indexing model from the issue text.
Description
I tried this:
Using both asyncapi and openapi generators leads to unintentional behaviors
Using asyncapi generator generates the version 1 and 2 of service "Service A"
Using openapi generator for only version 2 of same service "Service A"
This happened:
The Asyncapi generator generates both service versions , Version 2 as latest and version 1 as versioned
When openapi generator executed it removes all contents of service A v1.0.0 except the specfile
I expected this:
The generator must detect the corresponding version and extend it without touching the other versions being the latest or previous ones.
Is there a workaround?
Check if the exact version exists and verify if its newer than latest or not
Add a new api method in SDk to allow adding service as a versioned one directly and if version is
The generator will create a version in versioned folder if the current service version is lower than latest
Anything else?
TWO SCREENSHOTS RPRESENTING THE PROBLEM
During OpenApi generation
After openapi spec generation ends with success
EventCatalog Version
No response
Node.js Version
No response
Platform(s)
No response
Community Notes
- Please vote by adding a 👍 reaction to the issue to help us prioritize.
- If you are interested to work on this issue, please leave a comment.
- Dominant language
- TypeScript
- Stars
- 16
- Forks
- 15
- Avg merge
- 3m
- Merged PRs (30d)
- 7
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from event-catalog/generators
-
Difficulty 4/5 3-5 days Newbie friendliness 56/100
event-catalog/generators#458 ·
-
generator-asyncapi: option to default message (and channel) versions to the document's info.versionOpen
Difficulty 4/5 3-5 days Newbie friendliness 55/100
event-catalog/generators#457 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#451 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#450 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
event-catalog/generators#449 · 1 comment ·
All issues in event-catalog/generators
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vercel-labs/durable-harness#53 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
area/docs area/ui enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
melgarafael/DeskcommCRM#4098 ·
Maintainers usually reply within 1 day
-
bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kerti/balances-v2#801 ·
Maintainers usually reply within 1 day
-
lesson-submission pending-review
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Ikalus1988/MisakaNet#4510 ·
Maintainers usually reply within 1 day