Skip to content

Commit

Permalink
fix: parampath and paramquery required
Browse files Browse the repository at this point in the history
  • Loading branch information
Adis Durakovic committed May 28, 2024
1 parent 89552f7 commit 0e393f6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,21 @@ This format should be a valid openapi 3.x json.
@responseBody <status> - ["foo", "bar"] //returns custom json array
```

## `@paramPath` and `@paramQuery` examples

```ts
// basicaly same as @response, just without a status
@paramPath <paramName> - Description - (meta)
@paramQuery <paramName> - Description - (meta)

@paramPath id - The ID of the source - @type(number) @required
@paramPath slug - The ID of the source - @type(string)

@paramQuery q - Search term - @type(string) @required
@paramQuery page - the Page number - @type(number)

```

## `@requestBody` examples

```ts
Expand Down

0 comments on commit 0e393f6

Please sign in to comment.