feat: adds reusable actions

schemas/v1.2-dev/schema.yaml

@@ -16,14 +16,72 @@ properties:
     minItems: 1
     uniqueItems: true
     items:
-      $ref: "#/$defs/action-object"
+      oneOf:
+        - $ref: "#/$defs/reusable-action-reference-object"
+        - $ref: "#/$defs/action-object"
+  components:
+    $ref: "#/$defs/components-object"
 required:
   - overlay
   - info
   - actions
 $ref: "#/$defs/specification-extensions"
 unevaluatedProperties: false
 $defs:
+  reusable-action-reference-object:
+    type: object
+    allOf:
+      - $ref: "#/$defs/specification-extensions"
+      - $ref: "#/$defs/action-object-base"
+    properties:
+      $ref:
+        type: string
+        pattern: ^#\/components\/actions\/(?:[^~/]|~0|~1)+$
+      parameterValues:
+        type: object
+        additionalProperties:
+          type: string
+    required:
+      - $ref
+    $ref: "#/$defs/specification-extensions"
+    unevaluatedProperties: false
+  reusable-action-object-parameter:
+    type: object
+    properties:
+      name:
+        type: string
+        pattern: ^[A-Za-z_][A-Za-z_0-9]*$
+      default:
+        type: string
+    required:
+      - name
+    description: A parameter to be used in a reusable action object
+    $ref: "#/$defs/specification-extensions"
+    unevaluatedProperties: false
+  reusable-action-object:
+    type: object
+    allOf:
+      - $ref: "#/$defs/specification-extensions"
+      - $ref: "#/$defs/action-object-base"
+    properties:
+      parameters:
+        type: array
+        items:
+          $ref: "#/$defs/reusable-action-object-parameter"
+      environmentVariables:
+        type: array
+        items:
+          $ref: "#/$defs/reusable-action-object-parameter"
+    unevaluatedProperties: false
+  components-object:
+    type: object
+    properties:
+      actions:
+        type: object
+        additionalProperties:
+          $ref: "#/$defs/reusable-action-object"
+    $ref: "#/$defs/specification-extensions"
+    unevaluatedProperties: false
   info-object:
     type: object
     properties:
@@ -38,7 +96,7 @@ $defs:
       - version
     $ref: "#/$defs/specification-extensions"
     unevaluatedProperties: false
-  action-object:
+  action-object-base:
     type: object
     properties:
       target:
@@ -59,9 +117,13 @@ $defs:
       remove:
         type: boolean
         default: false
+  action-object:
+    type: object
+    allOf:
+      - $ref: "#/$defs/action-object-base"
+      - $ref: "#/$defs/specification-extensions"
     required:
       - target
-    $ref: "#/$defs/specification-extensions"
     unevaluatedProperties: false
   specification-extensions:
     patternProperties:

tests/v1.2-dev/fail/action-parameter-value-invalid-type.yaml

@@ -0,0 +1,20 @@
+overlay: 1.2.0
+info:
+  title: Reusable action reference parameter values must be strings
+  version: 1.0.0
+components:
+  actions:
+    errorResponse:
+      target: "$.paths['%param.pathItem%'].%param.operation%.responses"
+      update:
+        '404':
+          description: Not Found
+      parameters:
+        - name: pathItem
+        - name: operation
+          default: get
+actions:
+  - $ref: '#/components/actions/errorResponse'
+    parameterValues:
+      pathItem: /items
+      operation: 100

tests/v1.2-dev/fail/action-with-environment-variables-invalid.yaml

@@ -0,0 +1,10 @@
+overlay: 1.2.0
+info:
+  title: Non-reusable action objects cannot have environment variables
+  version: 1.0.0
+actions:
+  - target: '$.info'
+    environmentVariables:
+      - name: stageName
+    update:
+      description: Example

tests/v1.2-dev/fail/action-with-parameter-invalid.yaml

@@ -0,0 +1,10 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter missing name
+  version: 1.0.0
+actions:
+  - target: '$.info'
+    parameters:
+      - default: fallback
+    update:
+      description: Updated

tests/v1.2-dev/fail/components-actions-invalid-type.yaml

@@ -0,0 +1,8 @@
+overlay: 1.2.0
+info:
+  title: Components actions must be an object
+  version: 1.0.0
+components:
+  actions: []
+actions:
+  - target: '$'

tests/v1.2-dev/fail/components-invalid-property.yaml

@@ -0,0 +1,13 @@
+overlay: 1.2.0
+info:
+  title: Components invalid property
+  version: 1.0.0
+components:
+  invalidProperty: true
+  actions:
+    setDescription:
+      target: '$.info'
+      update:
+        description: Updated
+actions:
+  - target: '$.info'

tests/v1.2-dev/fail/components-invalid-type.yaml

@@ -0,0 +1,7 @@
+overlay: 1.2.0
+info:
+  title: Components must be an object
+  version: 1.0.0
+components: []
+actions:
+  - target: '$'

tests/v1.2-dev/fail/components-reusable-action-invalid-type.yaml

@@ -0,0 +1,9 @@
+overlay: 1.2.0
+info:
+  title: Components action must be an object
+  version: 1.0.0
+components:
+  actions:
+    brokenAction: not-an-object
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-environment-variable-default-invalid-type-components.yaml

@@ -0,0 +1,15 @@
+overlay: 1.2.0
+info:
+  title: Reusable action environment variable default values must be strings in components
+  version: 1.0.0
+components:
+  actions:
+    setDescription:
+      target: '$.info'
+      environmentVariables:
+        - name: STAGE_NAME
+          default: false
+      update:
+        description: Updated
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-environment-variable-invalid-name-pattern.yaml

@@ -0,0 +1,17 @@
+overlay: 1.2.0
+info:
+  title: Reusable action environment variable name must start with a letter and be alphanumeric
+  version: 1.0.0
+components:
+  actions:
+    setDescription:
+      target: '$.info'
+      environmentVariables:
+        - name: stage-name
+          default: dev
+      update:
+        description: Updated
+actions:
+  - target: '$.info'
+    update:
+      description: Invalid reusable action environment variable name

tests/v1.2-dev/fail/reusable-action-environment-variable-invalid-name.yaml

@@ -0,0 +1,11 @@
+overlay: 1.2.0
+info:
+  title: Reusable action environment variable invalid name type
+  version: 1.0.0
+actions:
+  - target: '$.info'
+    environmentVariables:
+      - name: 123
+        default: dev
+    update:
+      description: Updated

tests/v1.2-dev/fail/reusable-action-environment-variables-invalid-type-components.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Reusable action environment variables must be an array in components
+  version: 1.0.0
+components:
+  actions:
+    setDescription:
+      target: '$.info'
+      environmentVariables:
+        name: stageName
+      update:
+        description: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-invalid-property.yaml

@@ -0,0 +1,13 @@
+overlay: 1.2.0
+info:
+  title: Reusable action invalid property
+  version: 1.0.0
+components:
+  actions:
+    setDescription:
+      target: '$.info'
+      invalidProperty: true
+      update:
+        description: Updated
+actions:
+  - target: '$.info'

tests/v1.2-dev/fail/reusable-action-parameter-default-invalid-type-components.yaml

@@ -0,0 +1,15 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter default values must be strings in components
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - name: titleValue
+          default: 100
+      update:
+        title: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-parameter-invalid-name-pattern.yaml

@@ -0,0 +1,16 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter name must start with a letter and be alphanumeric
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - name: 1titleValue
+      update:
+        title: Example
+actions:
+  - target: '$.info'
+    update:
+      description: Invalid reusable action parameter name

tests/v1.2-dev/fail/reusable-action-parameter-invalid-property.yaml

@@ -0,0 +1,15 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter invalid property
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - name: titleValue
+          invalidProperty: true
+      update:
+        title: Example
+actions:
+  - target: '$.info'

tests/v1.2-dev/fail/reusable-action-parameter-item-invalid-type.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter items must be objects
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - invalid
+      update:
+        title: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-parameter-missing-name-components.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter items must include name in components
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - default: fallback
+      update:
+        title: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-parameter-name-invalid-type-components.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameter names must be strings in components
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        - name: 100
+      update:
+        title: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-parameter-values-not-allowed.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Parameter values are not allowed on reusable actions
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameterValues:
+        titleValue: Example
+      update:
+        title: '%param.titleValue%'
+actions:
+  - $ref: '#/components/actions/setTitle'

tests/v1.2-dev/fail/reusable-action-parameters-invalid-type-components.yaml

@@ -0,0 +1,14 @@
+overlay: 1.2.0
+info:
+  title: Reusable action parameters must be an array in components
+  version: 1.0.0
+components:
+  actions:
+    setTitle:
+      target: '$.info'
+      parameters:
+        name: titleValue
+      update:
+        title: Example
+actions:
+  - target: '$'

tests/v1.2-dev/fail/reusable-action-reference-environment-variables-not-allowed.yaml

@@ -0,0 +1,8 @@
+overlay: 1.2.0
+info:
+  title: Environment variables are not allowed on reusable action references
+  version: 1.0.0
+actions:
+  - $ref: '#/components/actions/errorResponse'
+    environmentVariables:
+      - name: stageName