Files
medusa-store/packages
Patrick cdcbc064b7 chore(oas): replace response with $ref class JSDoc (Admin O-PRI) (#3018)
### Scope

Admin routes directories O to PRI.

### What

Move inline OAS response schema declaration under their respective class declarations in order to expose them through  `#/components/schemas`. Replace inline OAS response schema with a `$ref` reference pointing to the newly declared schema.

### Why

Having response declared as its own "named" schema will allow OAS code generators to output typed entities/DTO that can be consumed without having to reference the route/operation.

### How

Declare a new @schema JSDoc for each "Res" class used to parse and validate request body. Move the current inline requestBody to the new @schema.

### Test

- Ran OAS validator.
- Ran docs build script.

Expect no visible changes to the documentation.
2023-01-13 14:40:15 +00:00
..
2022-11-24 11:42:04 +01:00
2022-12-22 15:54:20 +01:00
2022-11-02 16:44:54 +01:00
2022-12-22 15:54:20 +01:00
2022-12-22 15:54:20 +01:00
2023-01-11 16:27:54 +01:00
2022-11-24 11:42:04 +01:00
2023-01-11 16:27:54 +01:00