Auto-generate frontend types from OpenApi endpoint

As a developer, I need the up-to-date types for the backend responses so that the typescript compiler finds bugs in my processing of responses.

---

Current situation: We have a types.ts file that was created manually created.

Problem: A lot of types don't match with the response and there is no validation in place, so frontend components fail silently when they expect the manually typed schema.

---

Acceptance criteria:

• front/generated/types.ts is auto-generated on build and develop. It's a superset of the current front/src/types.ts
• All components that process the funkwhale data import front/generated/types.ts to type this data
• front/src/types.ts is deleted

added Area::Frontend label

assigned to @ArneBo

apiSchema.d.ts

I used https://github.com/openapi-ts/openapi-typescript/tree/main/packages/openapi-typescript on https://docs.funkwhale.audio/develop/swagger/schema.yml

yarn run openapi-typescript https://docs.funkwhale.audio/develop/swagger/schema.yml -o apiSchema.d.ts

mentioned in commit 7eae1340

mentioned in commit 6eabf140

marked the checklist item front/generated/types.ts is auto-generated on build and develop. It's a superset of the current front/src/types.ts as completed

mentioned in commit 92b1467d

mentioned in issue #2375 (closed)

"generate-local-schema": "yarn run openapi-typescript ../api/schema.yml -o src/generated/types.ts"

yeaaaay this is smart o/

mentioned in commit 7e61a59b

mentioned in commit ff2fc917

mentioned in merge request !2900 (merged)

Instead of only Types, it is also possible to also create full API clients in the same go.

in which language ?

TypeScript! See Replace axios with openapi-fetch (#2398).

mentioned in commit 6be6854d

mentioned in commit 87cbcd8b

mentioned in commit 7d35d7c6

mentioned in commit 06813a24

mentioned in commit 63b64ada

mentioned in commit c7bd63d1

closed with merge request !2900 (merged)

mentioned in merge request !2805 (closed)

Acceptance criteria (2) and (3) are in the frontend. I'll create a new issue for them so that this issue can stay closed. They are a lot of work and central to the upcoming refactor-work. The refactor will be guided by the generated types.

oups sorry did't see that. Do you want me to close this issue then ?

mentioned in issue #2431

follow-up (frontend only) #2431

reopened

marked this issue as related to #2431

Let's post-scribe a story that is validated by !2900 (merged) and hook it up here, too.

I'd like to revisit the whole story holistically from the PoV here, while fanning out into stories for the platform-specific implementations for frontend app related components in #2431 + for backend API related improvements through #2435 + the new one.

marked this issue as related to #2435

mentioned in commit a6168193

mentioned in merge request !2909 (merged)

mentioned in commit 3e9d75d0

closed with commit 3e9d75d0