Skip to content

trpc-openapi is not generating the correct types for enums and unions of literal... #173

Description

@github-actions

https://api.github.com/BKK-WeSpace/tree-population/blob/e41a837e40ad87e41bcb6aea273205a2b298ff33/README.md#L56

This is a new wespace documentation and is under construction.

# Public Endpoints

The full Swagger docs for all public endpoints can be viewed in /api/api-docs

# Getting Started

npm install

npm run dev


# Contributing

This project uses the standard T3 folder structure. We might migrate to a monorepo structure with separate packages later. But for the time being, we see no need to do so. Those already familiar with T3 should be able to make contributions right away.

## Schemas

We use `Zod` for all request/respons schemas to make validations easier.

Instead of 

```ts
    interface SomeType {
        name: string;
    }
    // or
    type SomeType = {name: string}

We do

    const SomeSchema = z.object({
        name: z.string()
    });

    // and where needed

    function someFunc(stuff: z.infer<typeof SomeSchema>) {
        //...
    }

About

Things yet to be done

  • Bring in maplibre
  • Integrate with Vallaris (requires a good backend architecture to make it not Vallaris-dependent).
  • Integrate https://github.com/jlalmes/trpc-openapi to integrate open-api specs (and also document it here)
  • TODO trpc-openapi is not generating the correct types for enums and unions of literals.
  • TODO Code of conduct
  • TODO More stuff to this todo list
  • TODO CI/CD -> Deployment, linting, testing, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions