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

Properly include OpenAPI client into project #21

Open
snkaupe opened this issue Aug 12, 2024 · 1 comment
Open

Properly include OpenAPI client into project #21

snkaupe opened this issue Aug 12, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request longterm Issues or pull requests that relevent for longterm support Ops Issues or pull requests relevant for Team 3: Ops Tooling

Comments

@snkaupe
Copy link
Member

snkaupe commented Aug 12, 2024

The simplest way to use the Angular client is to deploy it into the src directory using a Git submodule. However, a cleaner way is to still use a Git submodule, but have it in a different folder (e.g. external) and to build a NPM package that is then included in the Angular project.

This is the way it is currently done. However, this requires a few changes to the OpenAPI client (which are not yet committed) as well as manual build steps that are currently neither automated, nor documented. To simplify further development, it might be useful to switch to the "lesser" inclusion method until such a time that the necessary resources to properly use an external NPM package are available.

@snkaupe snkaupe added Ops Issues or pull requests relevant for Team 3: Ops Tooling longterm Issues or pull requests that relevent for longterm support labels Aug 12, 2024
@snkaupe snkaupe added the enhancement New feature or request label Aug 14, 2024
@snkaupe
Copy link
Member Author

snkaupe commented Aug 14, 2024

I've done as suggested and moved the Git submodule for the OpenAPI-generated Angular client into the src tree under src/external and fixed all resulting errors as part of my PR #20. The issue will remain open, as moving it back into a proper folder for external dependencies would be preferable. But, as noted before, this would require changes to the OpenAPI repository as well, so we'll move it into the uncertain future, given that everything works.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request longterm Issues or pull requests that relevent for longterm support Ops Issues or pull requests relevant for Team 3: Ops Tooling
Projects
Status: Backlog
Development

No branches or pull requests

1 participant