chore(oas): [12/n] improve oas schemas (#9200)

- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
This commit is contained in:
Shahed Nasser
2024-09-19 14:25:16 +00:00
committed by GitHub
parent 89928dfdf3
commit 4923a6e823
20 changed files with 287 additions and 149 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminRuleAttributeOption
* type: object
* description: The attribute's attributes.
* description: The details of a potential rule attribute.
* x-schemaName: AdminRuleAttributeOption
* required:
* - id
@@ -9,33 +9,23 @@
* - label
* - field_type
* - required
* - disguised
* - operators
* properties:
* id:
* type: string
* title: id
* description: The attribute's ID.
* description: The rule attribute's ID, which is a rule's `attribute` it refers to.
* example: "customer_group"
* value:
* type: string
* title: value
* description: The attribute's value.
* description: The rule attribute's value.
* example: "customer.groups.id"
* label:
* type: string
* title: label
* description: The attribute's label.
* field_type:
* type: string
* title: field_type
* description: The attribute's field type.
* required:
* type: boolean
* title: required
* description: The attribute's required.
* disguised:
* type: boolean
* title: disguised
* description: The attribute's disguised.
* description: The rule attribute option's label.
* example: "Customer Group"
* operators:
* type: array
* description: The attribute's operators.