Api client generation #6
Conversation
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-moss-0dcca7e03-6.westeurope.5.azurestaticapps.net |
generate-api-client.ts
Outdated
| name: "api.ts", | ||
| output: path.resolve(process.cwd(), "./src/api/backend"), | ||
| url: "https://dynamic-qrs.azurewebsites.net/api/swagger.json", | ||
| // 'axios' or or 'fetch' |
| /** | ||
| * No description | ||
| * | ||
| * @tags qr-code | ||
| * @name QrCodeTargetPut | ||
| * @summary Update a certain qr code target. | ||
| * @request PUT:/qr-codes/{id}/target | ||
| * @response `200` `QrCodeTargetPutResponse` Update a certain qr code target | ||
| * @response `400` `void` Request couldn't be parsed. Or missing organization identifier header. Or missing customer identifier header. | ||
| * @response `502` `void` No qr code target found with the given identifier. | ||
| */ |
There was a problem hiding this comment.
To clarify things comments could be nice. However, a description is missing from the comments blocks, yet the properties are described. I would propose to add a description to complete the comment block :)
There was a problem hiding this comment.
The files in /api/backend are all generated. Therefore we can't (and shouldn't) change them.
If you want to add some description, we need to add the description in the backend API documentation and regenerate these classes by running npm run generate-api-client
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-moss-0dcca7e03-6.westeurope.5.azurestaticapps.net |
Generate API by the swagger.json.