search

ts-spec / tspec

Type-driven API Documentation library. Auto-generating REST API document based on TypeScript types.
https://ts-spec.github.io/tspec/
MIT License
108 stars 5 forks source link

Not required query params #44

Closed toddla23 closed 6 months ago

toddla23 commented 6 months ago 
export type ExamAnswerApiSpec2 = Tspec.DefineApiSpec<{
  tags:['Set'],
  paths: {
    '/v2/sets/{examSetId}/answer': {
      get: {
        summary:"get sets",
        path:{examSetId:number},
        query:{
          level:string}
        responses:{200:ExamAnswer[]},
      },

    }
  }
}>;

In this code, how can i add level param "not required" option

Binghagoon commented 6 months ago

You can add "not required" as below

export type ExamAnswerApiSpec2 = Tspec.DefineApiSpec<{
  tags:['Set'],
  paths: {
    '/v2/sets/{examSetId}/answer': {
      get: {
        summary:"get sets",
        path:{examSetId:number},
        query:{
          level?:string}
        responses:{200:ExamAnswer[]},
      },

    }
  }
}>;

Just add optional in query propertys