Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generate openapi spec api-doc #101

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Conversation

ydayagi
Copy link
Contributor

@ydayagi ydayagi commented Dec 2, 2024

@rhdh-gh-app
Copy link

rhdh-gh-app bot commented Dec 2, 2024

Changed Packages

Package Name Package Path Changeset Bump Current Version
@red-hat-developer-hub/backstage-plugin-orchestrator-common workspaces/orchestrator/plugins/orchestrator-common patch v1.24.2

@batzionb
Copy link
Contributor

batzionb commented Dec 2, 2024

@ydayagi
Is this the postinstall script we talked about?

@batzionb
Copy link
Contributor

batzionb commented Dec 2, 2024

@ydayagi
A cleaner way to do the postinstall is to add to
workspaces/orchestrator/plugins/orchestrator-common/package.json to scripts field this:
"postinstall": "openapi:generate"

and then you don't need the script

@batzionb
Copy link
Contributor

batzionb commented Dec 2, 2024

@ydayagi
I checked out the PR and saw how the orchestrator-api.yaml is generated
Can you add the final file to the source code? Same as all generated files are in the source code
Otherwise after running openapi:generated it appears as a change in the repo (it's not part of .gitignore)

@ydayagi
Copy link
Contributor Author

ydayagi commented Dec 2, 2024

@ydayagi I checked out the PR and saw how the orchestrator-api.yaml is generated Can you add the final file to the source code? Same as all generated files are in the source code Otherwise after running openapi:generated it appears as a change in the repo (it's not part of .gitignore)

I forgot to commit it

@batzionb batzionb merged commit 948e2ad into redhat-developer:main Dec 2, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants