chore(oas): explicitly declare type:object on schemas with properties (#2712)
### What OAS: Explicitly declare type:object on schemas with properties. ### Why While not officially required, schemas with properties should have their type explicitly declared as "object". Omitting the type translates to type: any with properties XYZ. The ambiguity can lead to issues when using code generators. ### How Multiple regex searches to identify schemas missing type: object. Manually edit each schema. Spot check generated OAS. ### Testing - Ran OAS validator. - Ran docs build script ### Proof  RESOLVES CORE-847
This commit is contained in:
@@ -14,6 +14,7 @@ import { EntityManager } from "typeorm"
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - resource_id
|
||||
* - resource_type
|
||||
@@ -65,6 +66,7 @@ import { EntityManager } from "typeorm"
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* note:
|
||||
* $ref: "#/components/schemas/note"
|
||||
|
||||
Reference in New Issue
Block a user