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

Update release TypeScript models script #957

Closed
schultzp2020 opened this issue Sep 29, 2022 · 6 comments
Closed

Update release TypeScript models script #957

schultzp2020 opened this issue Sep 29, 2022 · 6 comments
Labels
area/api Enhancement or issue related to the api/devfile specification area/registry Devfile registry for stacks and infrastructure lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.

Comments

@schultzp2020
Copy link
Contributor

schultzp2020 commented Sep 29, 2022

Which area/kind this issue is related to?
/area api
/area registry

Issue Description

Currently the workflow release-typescript-models releases TypeScript models only for the latest version of the devfile spec. As a consumer of devfiles, it would be nice to have TypeScript model support for all releases of the devfile spec, as well as TypeScript model support for the REST API responses.

Possible solutions

  1. Generate an OpenAPI JSON (soon to be a complete superset of JSON schema - 90% there and in our case it shouldn't matter) either by converting the preexisting JSON schema or use swaggest/rest. Then convert to TypeScript models by openapi-typescript.
  2. Use typescriptify-golang-structs on Go source code to generate TypeScript models.

Method 1 is preferred because it can be extended to easily test the API responses.

@openshift-ci openshift-ci bot added the area/api Enhancement or issue related to the api/devfile specification label Sep 29, 2022
@schultzp2020
Copy link
Contributor Author

@sleshchenko, @JPinkney, @l0rd do we still need to keep type support for devworkspace inside of the @devfile/api npm package?

@schultzp2020 schultzp2020 added the area/registry Devfile registry for stacks and infrastructure label Sep 30, 2022
@l0rd
Copy link
Contributor

l0rd commented Oct 3, 2022

@benoitf @azatsarynnyy do we use the @devfile/api npm package in our editors?
@schultzp2020 FYI @sleshchenko and @JPinkney has left Red Hat and are not working on Devfile/DevWorkspaces anymore.

@benoitf
Copy link
Contributor

benoitf commented Oct 3, 2022

yes we are using it in dashboard and in the "libraries" to enhance devfiles (theia and vscode)

@l0rd
Copy link
Contributor

l0rd commented Oct 3, 2022

@schultzp2020 we still do need the DevWorkspace type support

@schultzp2020
Copy link
Contributor Author

Sounds good, I'll keep them included when I add the other types.

Copy link

github-actions bot commented Aug 1, 2024

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Aug 1, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Oct 1, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 1, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done ✅ in Devfile Project Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Enhancement or issue related to the api/devfile specification area/registry Devfile registry for stacks and infrastructure lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.
Projects
Status: Done ✅
Development

No branches or pull requests

5 participants