Dry-Up participant declaration

DFE-Digital · Jul 5, 2024 · 6db80ae · 6db80ae
1 parent f5275af
commit 6db80ae
Showing 1 changed file with 51 additions and 249 deletions.
diff --git a/spec/swagger_schemas/models/participant_declaration.rb b/spec/swagger_schemas/models/participant_declaration.rb
@@ -15,7 +15,7 @@
         example: "participant-declaration",
       },
       attributes: {
-        required: %w[
+        required: %i[
           participant_id
           declaration_type
           declaration_date
@@ -88,254 +88,56 @@
         },
       },
     },
-  },
-  v2: {
-    description: "The data attributes associated with a participant declaration response",
-    required: %i[id type attributes],
-    properties: {
-      id: {
-        "$ref": "#/components/schemas/IDAttribute",
-      },
-      type: {
-        type: :string,
-        enum: %w[
-          participant-declaration
-        ],
-        example: "participant-declaration",
-      },
-      attributes: {
-        required: %w[
-          participant_id
-          declaration_type
-          declaration_date
-          course_identifier
-          state
-          updated_at
-        ],
-        properties: {
-          participant_id: {
-            description: "The unique identifier of this participant declaration record",
-            type: :string,
-            format: :uuid,
-            nullable: false,
-            example: "db3a7848-7308-4879-942a-c4a70ced400a",
-          },
-          declaration_type: {
-            description: "The event declaration type",
-            type: :string,
-            nullable: false,
-            example: "started",
-            enum: %w[
-              started
-              retained-1
-              retained-2
-              retained-3
-              retained-4
-              completed
-              extended-1
-              extended-2
-              extended-3
-            ],
-          },
-          declaration_date: {
-            description: "The event declaration date",
-            type: :string,
-            nullable: false,
-            example: "2022-04-30",
-          },
-          course_identifier: {
-            description: "The NPQ course this NPQ application relates to",
-            type: :string,
-            nullable: false,
-            example: "npq-leading-teaching",
-            enum: %w[
-              npq-leading-teaching
-              npq-leading-behaviour-culture
-              npq-leading-teaching-development
-              npq-leading-literacy
-              npq-senior-leadership
-              npq-headship
-              npq-executive-leadership
-              npq-early-years-leadership
-              npq-additional-support-offer
-              npq-early-headship-coaching-offer
-              npq-leading-primary-mathematics
-              npq-senco
-            ],
-          },
-          state: {
-            description: "Indicates the state of this payment declaration",
-            type: :string,
-            nullable: false,
-            example: "submitted",
-            enum: %w[
-              submitted
-              eligible
-              payable
-              paid
-              voided
-              ineligible
-              awaiting-clawback
-              clawed-back
-            ],
-          },
-          updated_at: {
-            description: "The date the application was last updated",
-            type: :string,
-            nullable: false,
-            format: :"date-time",
-            example: "2021-05-31T02:22:32.000Z",
-          },
-          has_passed: {
-            description: "The date the declaration was last updated",
-            type: :string,
-            nullable: true,
-            example: true,
-          },
-        },
-      },
-    },
-  },
-  v3: {
-    description: "The data attributes associated with a participant declaration response",
-    type: :object,
-    required: %i[id type attributes],
-    properties: {
-      id: {
-        "$ref": "#/components/schemas/IDAttribute",
-      },
-      type: {
-        type: :string,
-        enum: %w[
-          participant-declaration
-        ],
-        example: "participant-declaration",
-      },
-      attributes: {
-        required: %w[
-          participant_id
-          declaration_type
-          declaration_date
-          course_identifier
-          state
-          updated_at
-          lead_provider_name
-        ],
-        properties: {
-          participant_id: {
-            description: "The unique id of the participant",
-            type: "string",
-            format: "uuid",
-            example: "db3a7848-7308-4879-942a-c4a70ced400a",
-          },
-          declaration_type: {
-            description: "The event declaration type",
-            type: "string",
-            enum: %w[
-              started
-              retained-1
-              retained-2
-              retained-3
-              retained-4
-              completed
-              extended-1
-              extended-2
-              extended-3
-            ],
-            example: "started",
-          },
-          declaration_date: {
-            description: "The event declaration date",
-            type: "string",
-            format: "date-time",
-            example: "2021-05-31T02:21:32.000Z",
-          },
-          course_identifier: {
-            description: "The type of course the participant is enrolled in",
-            type: "string",
-            enum: %w[
-              npq-leading-teaching
-              npq-leading-behaviour-culture
-              npq-leading-teaching-development
-              npq-leading-literacy
-              npq-senior-leadership
-              npq-headship
-              npq-executive-leadership
-              npq-early-years-leadership
-              npq-additional-support-offer
-              npq-early-headship-coaching-offer
-              npq-leading-primary-mathematics
-            ],
-            example: "npq-leading-teaching",
-          },
-          state: {
-            description: "Indicates the state of this payment declaration",
-            type: "string",
-            enum: %w[
-              submitted
-              eligible
-              payable
-              paid
-              voided
-              ineligible
-              awaiting-clawback
-              clawed-back
-            ],
-            example: "submitted",
-          },
-          updated_at: {
-            description: "The date the declaration was last updated",
-            type: "string",
-            format: "date-time",
-            example: "2021-05-31T02:22:32.000Z",
-          },
-          created_at: {
-            description: "The date the declaration was created",
-            type: "string",
-            format: "date-time",
-            example: "2021-05-31T02:22:32.000Z",
-          },
-          statement_id: {
-            description: "Unique ID of the statement the declaration will be paid as part of",
-            type: "string",
-            format: "uuid",
-            example: "cd3a12347-7308-4879-942a-c4a70ced400a",
-            nullable: true,
-          },
-          clawback_statement_id: {
-            description: "Unique id of the statement to which the declaration will be clawed back on, if any",
-            type: "string",
-            format: "uuid",
-            example: "cd3a12347-7308-4879-942a-c4a70ced400a",
-            nullable: true,
-          },
-          ineligible_for_funding_reason: {
-            description: "If the declaration is ineligible, the reason why",
-            type: "string",
-            enum: %w[
+  }
+}.tap { |h|
+  h[:v2] = h[:v1].deep_dup
+  h[:v2][:properties][:attributes][:required] = h[:v1][:properties][:attributes][:required].excluding(:voided, :eligible_for_payment)
+  h[:v2][:properties][:attributes][:properties] = h[:v1][:properties][:attributes][:properties].excluding(:voided, :eligible_for_payment)
+  h[:v3] = h[:v2].deep_dup
+  h[:v3][:properties][:attributes][:properties][:statement_id] = {
+    description: "Unique ID of the statement the declaration will be paid as part of",
+    type: "string",
+    format: "uuid",
+    example: "cd3a12347-7308-4879-942a-c4a70ced400a",
+    nullable: true,
+  }
+  h[:v3][:properties][:attributes][:properties][:clawback_statement_id] = {
+    description: "Unique id of the statement to which the declaration will be clawed back on, if any",
+    type: "string",
+    format: "uuid",
+    example: "cd3a12347-7308-4879-942a-c4a70ced400a",
+    nullable: true,
+  }
+  h[:v3][:properties][:attributes][:properties][:ineligible_for_funding_reason] = {
+    description: "If the declaration is ineligible, the reason why",
+    type: "string",
+    enum: %w[
               duplicate_declaration
             ],
-            nullable: true,
-            example: "duplicate_declaration",
-          },
-          uplift_paid: {
-            description: "If participant is eligible for uplift, whether it has been paid as part of this declaration",
-            type: "boolean",
-            example: true,
-          },
-          has_passed: {
-            description: "Whether the participant has failed or passed",
-            type: "string", # Need update when completed
-            example: true,
-            nullable: true,
-          },
-          lead_provider_name: {
-            description: "The name of the provider that submitted the declaration",
-            type: "string",
-            nullable: false,
-          },
-        },
-      },
-    },
-  },
+    nullable: true,
+    example: "duplicate_declaration",
+  }
+  h[:v3][:properties][:attributes][:properties][:uplift_paid] = {
+    description: "If participant is eligible for uplift, whether it has been paid as part of this declaration",
+    type: "boolean",
+    example: true,
+  }
+  h[:v3][:properties][:attributes][:properties][:has_passed] = {
+    description: "Whether the participant has failed or passed",
+    type: "string", # Need update when completed
+    example: true,
+    nullable: true,
+  }
+  h[:v3][:properties][:attributes][:properties][:lead_provider_name] = {
+    description: "The name of the provider that submitted the declaration",
+    type: "string",
+    nullable: false,
+  }
+  h[:v3][:properties][:attributes][:properties][:created_at] = {
+      description: "The date the application was created",
+      type: :string,
+      nullable: false,
+      format: :"date-time",
+      example: "2021-05-31T02:22:32.000Z",
+  }
 }.freeze