oas: [3/n] Improve admin OAS (#8875)

Improve the OAS of admin API routes [3/n]
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-08-30 07:20:20 +00:00
1 parent 80fd20b21e
commit bab6ad4c55
15 files changed
+2037 -37

No files matched your search

@@ -1,8 +1,74 @@
/**
* @schema AdminCurrency
* type: object
* description: The supported currency's currency.
* description: The currency's currencies.
* x-schemaName: AdminCurrency
* required:
* - code
* - symbol
* - symbol_native
* - name
* - decimal_digits
* - rounding
* - raw_rounding
* - created_at
* - updated_at
* - deleted_at
* properties:
* code:
* type: string
* title: code
* description: The currency's code.
* symbol:
* type: string
* title: symbol
* description: The currency's symbol.
* symbol_native:
* type: string
* title: symbol_native
* description: The currency's symbol native.
* name:
* type: string
* title: name
* description: The currency's name.
* decimal_digits:
* type: number
* title: decimal_digits
* description: The currency's decimal digits.
* rounding:
* type: number
* title: rounding
* description: The currency's rounding.
* raw_rounding:
* type: object
* description: The currency's raw rounding.
* required:
* - value
* - precision
* properties:
* value:
* type: string
* title: value
* description: The raw rounding's value.
* precision:
* type: number
* title: precision
* description: The raw rounding's precision.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The currency's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The currency's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The currency's deleted at.
*
*/
@@ -0,0 +1,52 @@
/**
* @schema AdminCurrencyListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminCurrencyListParams
* properties:
* q:
* type: string
* title: q
* description: The currency's q.
* code:
* oneOf:
* - type: string
* title: code
* description: The currency's code.
* - type: array
* description: The currency's code.
* items:
* type: string
* title: code
* description: The code's details.
* limit:
* type: number
* title: limit
* description: The currency's limit.
* offset:
* type: number
* title: offset
* description: The currency's offset.
* order:
* type: string
* title: order
* description: The currency's order.
* fields:
* type: string
* title: fields
* description: The currency's fields.
* $and:
* type: array
* description: The currency's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The currency's $or.
* items:
* type: object
* title: $or
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminCurrencyParams
* type: object
* description: SUMMARY
* x-schemaName: AdminCurrencyParams
* properties:
* fields:
* type: string
* title: fields
* description: The currency's fields.
*
*/