(docs): Add docs for reconstruction filters.

ThreeDify · Nov 22, 2020 · a4ec73a · a4ec73a
1 parent 13151a7
commit a4ec73a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/src/models/Reconstruction.ts b/src/models/Reconstruction.ts
@@ -37,6 +37,21 @@ const TABLE_NAME: string = 'reconstructions';
  *        updatedAt:
  *          type: string
  *          format: date-time
+ *  parameters:
+ *    reconstruction_filters:
+ *      in: query
+ *      name: filters
+ *      description: Filters to apply to generate pages. For multiple filters, use comma(,) separated value.<br>
+ *                   Use filters to select only some data. For example, `inQueue` filters reconstruction that are in queue.<br>
+ *                   This can also be used to order data. For example, `orderByCreatedAt` sorts data by createdAt field.
+ *      required: false
+ *      schema:
+ *        type: string
+ *        enum:
+ *          - orderByCreatedAt
+ *          - inQueue
+ *          - inProgress
+ *          - completed
  *  responses:
  *    Reconstruction:
  *      description: Reconstruction data in JSON response.

diff --git a/src/routers/reconstructions.ts b/src/routers/reconstructions.ts
@@ -18,7 +18,7 @@ const imageUploadMiddlewares = uploadImages('images');
  *    parameters:
  *      - $ref: '#/components/parameters/page'
  *      - $ref: '#/components/parameters/size'
- *      - $ref: '#/components/parameters/filters'
+ *      - $ref: '#/components/parameters/reconstruction_filters'
  *      - $ref: '#/components/parameters/order'
  *    responses:
  *      200:

diff --git a/src/routers/users.ts b/src/routers/users.ts
@@ -87,7 +87,7 @@ router.get('/:userId(\\d+)', authenticate, UserController.user);
  *        description: Id of user to fetch reconstructions.
  *      - $ref: '#/components/parameters/page'
  *      - $ref: '#/components/parameters/size'
- *      - $ref: '#/components/parameters/filters'
+ *      - $ref: '#/components/parameters/reconstruction_filters'
  *      - $ref: '#/components/parameters/order'
  *    responses:
  *      200: