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 ![Screen Shot 2022-12-01 at 1 46 13 PM](https://user-images.githubusercontent.com/116003638/205137671-7a6770dd-4f9b-456c-99a6-ac654f6d0f59.png) RESOLVES CORE-847
medusajs · Dec 2, 2022 · 1dc8160 · 1dc8160
1 parent 198fe78
commit 1dc8160
Show file tree

Hide file tree

Showing 351 changed files with 460 additions and 1 deletion.
diff --git a/.changeset/shiny-tips-teach.md b/.changeset/shiny-tips-teach.md
@@ -0,0 +1,5 @@
+---
+"@medusajs/medusa": patch
+---
+
+chore(oas): explicitly declare type:object on schemas with properties
diff --git a/packages/medusa/src/api/middlewares/await-middleware.ts b/packages/medusa/src/api/middlewares/await-middleware.ts
@@ -20,6 +20,7 @@ export default (fn: handler): RequestHandler => {
  * @schema multiple_errors
  * title: "Multiple Errors"
  * x-resourceId: multiple_errors
+ * type: object
  * properties:
  *  errors:
  *    type: array

diff --git a/packages/medusa/src/api/middlewares/error-handler.ts b/packages/medusa/src/api/middlewares/error-handler.ts
@@ -79,6 +79,7 @@ export default () => {
  * @schema error
  * title: "Response Error"
  * x-resourceId: error
+ * type: object
  * properties:
  *  code:
  *    type: string

diff --git a/packages/medusa/src/api/routes/admin/apps/authorize-app.ts b/packages/medusa/src/api/routes/admin/apps/authorize-app.ts
@@ -13,6 +13,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - application_name
  *           - state
@@ -50,6 +51,7 @@ import { validator } from "../../../../utils/validator"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            apps:
  *              $ref: "#/components/schemas/OAuth"

diff --git a/packages/medusa/src/api/routes/admin/apps/list.ts b/packages/medusa/src/api/routes/admin/apps/list.ts
@@ -23,6 +23,7 @@ import { OauthService } from "../../../../services"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            apps:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/auth/create-session.ts b/packages/medusa/src/api/routes/admin/auth/create-session.ts
@@ -20,6 +20,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - email
  *           - password
@@ -61,6 +62,7 @@ import { validator } from "../../../../utils/validator"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            user:
  *              $ref: "#/components/schemas/user"

diff --git a/packages/medusa/src/api/routes/admin/auth/get-session.ts b/packages/medusa/src/api/routes/admin/auth/get-session.ts
@@ -34,6 +34,7 @@ import _ from "lodash"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            user:
  *              $ref: "#/components/schemas/user"

diff --git a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts
@@ -36,6 +36,7 @@ import { EntityManager } from "typeorm"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            batch_job:
  *              $ref: "#/components/schemas/batch_job"

diff --git a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts
@@ -36,6 +36,7 @@ import { EntityManager } from "typeorm"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            batch_job:
  *              $ref: "#/components/schemas/batch_job"

diff --git a/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts
@@ -15,6 +15,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *    application/json:
  *      schema:
+ *        type: object
  *        required:
  *          - type
  *          - context
@@ -81,6 +82,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *            batch_job:
  *              $ref: "#/components/schemas/batch_job"

diff --git a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts
@@ -33,6 +33,7 @@
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            batch_job:
  *              $ref: "#/components/schemas/batch_job"

diff --git a/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts b/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts
@@ -237,6 +237,7 @@ import { isDefined } from "../../../../utils"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            batch_jobs:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/collections/add-products.ts b/packages/medusa/src/api/routes/admin/collections/add-products.ts
@@ -16,6 +16,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - product_ids
  *         properties:
@@ -48,6 +49,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            collection:
  *              $ref: "#/components/schemas/product_collection"

diff --git a/packages/medusa/src/api/routes/admin/collections/create-collection.ts b/packages/medusa/src/api/routes/admin/collections/create-collection.ts
@@ -13,6 +13,7 @@ import { EntityManager } from "typeorm"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - title
  *         properties:
@@ -58,6 +59,7 @@ import { EntityManager } from "typeorm"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            collection:
  *              $ref: "#/components/schemas/product_collection"

diff --git a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts
@@ -38,6 +38,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            id:
  *              type: string

diff --git a/packages/medusa/src/api/routes/admin/collections/get-collection.ts b/packages/medusa/src/api/routes/admin/collections/get-collection.ts
@@ -37,6 +37,7 @@ import { defaultAdminCollectionsRelations } from "."
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            collection:
  *              $ref: "#/components/schemas/product_collection"

diff --git a/packages/medusa/src/api/routes/admin/collections/list-collections.ts b/packages/medusa/src/api/routes/admin/collections/list-collections.ts
@@ -111,6 +111,7 @@ import { Type } from "class-transformer"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            collections:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/collections/remove-products.ts b/packages/medusa/src/api/routes/admin/collections/remove-products.ts
@@ -16,6 +16,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - product_ids
  *         properties:
@@ -48,6 +49,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            id:
  *              type: string

diff --git a/packages/medusa/src/api/routes/admin/collections/update-collection.ts b/packages/medusa/src/api/routes/admin/collections/update-collection.ts
@@ -15,6 +15,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         properties:
  *           title:
  *             type: string
@@ -58,6 +59,7 @@ import ProductCollectionService from "../../../../services/product-collection"
  *    content:
  *      application/json:
  *        schema:
+ *          type: object
  *          properties:
  *            collection:
  *              $ref: "#/components/schemas/product_collection"

diff --git a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts
@@ -42,6 +42,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             currencies:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts
@@ -17,6 +17,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         properties:
  *           includes_tax:
  *             type: boolean
@@ -51,6 +52,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             currency:
  *                 $ref: "#/components/schemas/currency"

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts
@@ -19,6 +19,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - customer_ids
  *         properties:
@@ -73,6 +74,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_group:
  *               $ref: "#/components/schemas/customer_group"

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts
@@ -47,6 +47,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_group:
  *               $ref: "#/components/schemas/customer_group"

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts
@@ -38,6 +38,7 @@ import { EntityManager } from "typeorm"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             id:
  *               type: string

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts
@@ -19,6 +19,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - customer_ids
  *         properties:
@@ -73,6 +74,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_group:
  *               $ref: "#/components/schemas/customer_group"

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts
@@ -37,6 +37,7 @@ import CustomerController from "../../../../controllers/customers"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customers:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts
@@ -40,6 +40,7 @@ import { FindParams } from "../../../../types/common"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_group:
  *               $ref: "#/components/schemas/customer_group"

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts
@@ -127,6 +127,7 @@ import { Type } from "class-transformer"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_groups:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts
@@ -19,6 +19,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         properties:
  *           name:
  *             description: "Name of the customer group"
@@ -59,6 +60,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer_group:
  *               $ref: "#/components/schemas/customer_group"

diff --git a/packages/medusa/src/api/routes/admin/customers/create-customer.ts b/packages/medusa/src/api/routes/admin/customers/create-customer.ts
@@ -14,6 +14,7 @@ import { EntityManager } from "typeorm"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - email
  *           - first_name
@@ -79,6 +80,7 @@ import { EntityManager } from "typeorm"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer:
  *               $ref: "#/components/schemas/customer"

diff --git a/packages/medusa/src/api/routes/admin/customers/get-customer.ts b/packages/medusa/src/api/routes/admin/customers/get-customer.ts
@@ -40,6 +40,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer:
  *               $ref: "#/components/schemas/customer"

diff --git a/packages/medusa/src/api/routes/admin/customers/list-customers.ts b/packages/medusa/src/api/routes/admin/customers/list-customers.ts
@@ -43,6 +43,7 @@ import customerController from "../../../../controllers/customers"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customers:
  *               type: array

diff --git a/packages/medusa/src/api/routes/admin/customers/update-customer.ts b/packages/medusa/src/api/routes/admin/customers/update-customer.ts
@@ -29,6 +29,7 @@ import { validator } from "../../../../utils/validator"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         properties:
  *           email:
  *             type: string
@@ -93,6 +94,7 @@ import { validator } from "../../../../utils/validator"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             customer:
  *               $ref: "#/components/schemas/customer"

diff --git a/packages/medusa/src/api/routes/admin/discounts/add-region.ts b/packages/medusa/src/api/routes/admin/discounts/add-region.ts
@@ -40,6 +40,7 @@ import { EntityManager } from "typeorm"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             discount:
  *               $ref: "#/components/schemas/discount"

diff --git a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts
@@ -24,6 +24,7 @@ import { FindParams } from "../../../../types/common"
  *   content:
  *     application/json:
  *       schema:
+ *         type: object
  *         required:
  *           - resources
  *         properties:
@@ -70,6 +71,7 @@ import { FindParams } from "../../../../types/common"
  *     content:
  *       application/json:
  *         schema:
+ *           type: object
  *           properties:
  *             discount:
  *               $ref: "#/components/schemas/discount"