Automated commit 'Merge pull request #1850 from sailpoint/amalta/PLTC…

…ONFHUB-2592

PLTCONFHUB-2592: Config Objects API Docs' by github action: 11294533108

idn/beta/schemas/SpConfigObject.yaml

@@ -7,42 +7,6 @@ properties:
     description: >-
       The object type this configuration is for.
     example: "TRIGGER_SUBSCRIPTION"
-  resolveByIdUrl:
-    $ref: './SpConfigUrl.yaml'
-    description: >-
-      Url and query parameters to be used to resolve this type of object by Id.
-  resolveByNameUrl:
-    type: array
-    items:
-      $ref: './SpConfigUrl.yaml'
-    description: >-
-      Url and query parameters to be used to resolve this type of object by name.
-  exportUrl:
-    $ref: './SpConfigUrl.yaml'
-  exportRight:
-    type: string
-    description: >-
-      Rights needed by the invoker of sp-config/export in order to export this type of object.
-    example: idn:trigger-service-subscriptions:read
-  exportLimit:
-    type: integer
-    format: int32
-    description: >-
-      Pagination limit imposed by the target service for this object type.
-    example: 10
-  importUrl:
-    $ref: './SpConfigUrl.yaml'
-  importRight:
-    type: string
-    description: >-
-      Rights needed by the invoker of sp-config/import in order to import this type of object.
-    example: idn:trigger-service-subscriptions:create
-  importLimit:
-    type: integer
-    format: int32
-    description: >-
-      Pagination limit imposed by the target service for this object type.
-    example: 10
   referenceExtractors:
     type: array
     nullable: true
@@ -60,8 +24,17 @@ properties:
   legacyObject:
     type: boolean
     default: false
+    description: Whether this is a legacy object
     example: false
   onePerTenant:
     type: boolean
     default: false
-    example: false
+    description: Whether there is only one object of this type
+    example: false
+  exportable:
+    type: boolean
+    default: false
+    description: Whether this object can be exported or it is just a reference object
+    example: true
+  rules:
+    $ref: ./SpConfigRules.yaml

idn/beta/schemas/SpConfigRule.yaml

@@ -0,0 +1,23 @@
+type: object
+title: Config Object Rule
+description: Format of Config Hub Object Rules
+properties:
+  path:
+    type: string
+    description: JSONPath expression denoting the path within the object where a value substitution should be applied
+    example: $.enabled
+  value:
+    type: object
+    description: Value to be assigned at the jsonPath location within the object
+    nullable: true
+    example: null
+  mode:
+    type: array
+    description: Draft modes to which this rule will apply
+    items:
+      type: string
+      enum:
+        - RESTORE
+        - PROMOTE
+        - UPLOAD
+    example: [RESTORE, PROMOTE]

idn/beta/schemas/SpConfigRules.yaml

@@ -0,0 +1,17 @@
+type: object
+title: Config Object Rules
+description: Rules to be applied to the config object during draft process
+properties:
+  takeFromTargetRules:
+    type: array
+    items:
+      $ref: ./SpConfigRule.yaml
+  defaultRules:
+    type: array
+    items:
+      $ref: ./SpConfigRule.yaml
+  editable:
+    type: boolean
+    default: false
+    description: Whether this object can be edited
+    example: true