Add new rulesets endpoints to documentation

folio-org · Mar 8, 2024 · 5dc6686 · 5dc6686
1 parent b95626b
commit 5dc6686
Showing 1 changed file with 90 additions and 1 deletion.
diff --git a/openapi/serials-management.yaml b/openapi/serials-management.yaml
@@ -434,6 +434,96 @@ paths:
                 $ref: '#/components/schemas/HttpError'
         '500':
           description: Internal server error
+  /serials-management/rulesets/{uuid}/activate:
+    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}/deprecate:
+    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
@@ -1173,4 +1263,3 @@ components:
           type: integer
         totalRecords:
           type: integer
-