MODSER-24: Add new rulesets endpoints to documentation (#83)

* Add new rulesets endpoints to documentation * Updated ruleset paths in line with implementation * Update api documentation with putPredictedPieceSet --------- Co-authored-by: Jack-Golding <[email protected]>
folio-org · Mar 11, 2024 · 58a06dd · 58a06dd
1 parent 0b2c75a
commit 58a06dd
Showing 1 changed file with 123 additions and 3 deletions.
diff --git a/openapi/serials-management.yaml b/openapi/serials-management.yaml
@@ -105,7 +105,6 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/RefDataCategory'
-        description: requestBody description
         required: true
       responses:
         '200':
@@ -282,7 +281,6 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/Serial'
-        description: requestBody description
         required: true
       responses:
         '200':
@@ -434,6 +432,96 @@ paths:
                 $ref: '#/components/schemas/HttpError'
         '500':
           description: Internal server error
+  /serials-management/rulesets/{uuid}/active:
+    post:
+      summary: Activate a ruleset
+      operationId: activateRuleset
+      parameters:
+        - name: uuid
+          in: path
+          description: The uuid of the ruleset to be activated
+          required: true
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/serialRuleset'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/serialRuleset'
+        '400':
+          description: Bad request error
+        '403':
+          description: Forbidden
+        '500':
+          description: Internal server error
+  /serials-management/rulesets/{uuid}/deprecated:
+    post:
+      summary: Deprecate a ruleset
+      operationId: depricateRuleset
+      parameters:
+        - name: uuid
+          in: path
+          description: The uuid of the ruleset to be deprecated
+          required: true
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/serialRuleset'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/serialRuleset'
+        '400':
+          description: Bad request error
+        '403':
+          description: Forbidden
+        '500':
+          description: Internal server error
+  /serials-management/rulesets/{uuid}/draft:
+    post:
+      summary: Make a ruleset a draft
+      operationId: draftRuleset
+      parameters:
+        - name: uuid
+          in: path
+          description: The uuid of the ruleset to be made a draft
+          required: true
+          schema:
+            type: string
+            format: uuid
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/serialRuleset'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/serialRuleset'
+        '400':
+          description: Bad request error
+        '403':
+          description: Forbidden
+        '500':
+          description: Internal server error
   /serials-management/predictedPieces:
     get:
       summary: Get a set of predicted piece sets
@@ -492,6 +580,39 @@ paths:
                 $ref: '#/components/schemas/HttpError'
         '500':
           description: Internal server error
+    put:
+      summary: Update predicted piece set
+      operationId: putPredictedPieceSet
+      parameters:
+        - name: uuid
+          in: path
+          description: The uuid of the predicted piece set to be put
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PredictedPieceSet'
+        required: true
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PredictedPieceSet'
+        '400':
+          description: Bad request error
+        '404':
+          description: Not found error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HttpError'
+        '500':
+          description: Internal server error
   /serials-management/predictedPieces/generate:
     post:
       summary: Preview predicted pieces
@@ -1173,4 +1294,3 @@ components:
           type: integer
         totalRecords:
           type: integer
-