updates production swagger for sandbox docs (#12803)

department-of-veterans-affairs · May 30, 2023 · 1b9cf59 · 1b9cf59
1 parent 46417b1
commit 1b9cf59
Showing 1 changed file with 78 additions and 32 deletions.
diff --git a/modules/claims_api/app/swagger/claims_api/v2/production/swagger.json b/modules/claims_api/app/swagger/claims_api/v2/production/swagger.json
@@ -2191,27 +2191,50 @@
               "schema": {
                 "type": "object",
                 "required": [
-                  "type"
+                  "data"
                 ],
                 "properties": {
-                  "type": {
-                    "type": "string",
-                    "example": "compensation",
-                    "description": "Type of Intent To File being submitted. For type \"survivor\", the request must include claimantSsn and be made by a valid Veteran Representative. If the Representative is not a Veteran or a VA employee, this method is currently not available to them, and they should use the Benefits Intake API as an alternative.",
-                    "enum": [
-                      "compensation",
-                      "pension",
-                      "survivor"
-                    ]
-                  },
-                  "claimantSsn": {
-                    "type": "string",
-                    "example": "001122334",
-                    "description": "SSN of the Claimant."
+                  "data": {
+                    "type": "object",
+                    "required": [
+                      "attributes"
+                    ],
+                    "properties": {
+                      "attributes": {
+                        "required": [
+                          "type"
+                        ],
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "example": "compensation",
+                            "description": "Type of Intent To File being submitted. For type \"survivor\", the request must include claimantSsn and be made by a valid Veteran Representative. If the Representative is not a Veteran or a VA employee, this method is currently not available to them, and they should use the Benefits Intake API as an alternative.",
+                            "enum": [
+                              "compensation",
+                              "pension",
+                              "survivor"
+                            ]
+                          },
+                          "claimantSsn": {
+                            "type": "string",
+                            "example": "001122334",
+                            "description": "SSN of the Claimant."
+                          }
+                        },
+                        "example": {
+                          "type": "compensation"
+                        }
+                      }
+                    }
                   }
                 },
                 "example": {
-                  "type": "compensation"
+                  "data": {
+                    "type": "intent_to_file",
+                    "attributes": {
+                      "type": "compensation"
+                    }
+                  }
                 }
               }
             }
@@ -2477,27 +2500,50 @@
               "schema": {
                 "type": "object",
                 "required": [
-                  "type"
+                  "data"
                 ],
                 "properties": {
-                  "type": {
-                    "type": "string",
-                    "example": "compensation",
-                    "description": "Type of Intent To File being submitted. For type \"survivor\", the request must include claimantSsn and be made by a valid Veteran Representative. If the Representative is not a Veteran or a VA employee, this method is currently not available to them, and they should use the Benefits Intake API as an alternative.",
-                    "enum": [
-                      "compensation",
-                      "pension",
-                      "survivor"
-                    ]
-                  },
-                  "claimantSsn": {
-                    "type": "string",
-                    "example": "001122334",
-                    "description": "SSN of the Claimant."
+                  "data": {
+                    "type": "object",
+                    "required": [
+                      "attributes"
+                    ],
+                    "properties": {
+                      "attributes": {
+                        "required": [
+                          "type"
+                        ],
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "example": "compensation",
+                            "description": "Type of Intent To File being submitted. For type \"survivor\", the request must include claimantSsn and be made by a valid Veteran Representative. If the Representative is not a Veteran or a VA employee, this method is currently not available to them, and they should use the Benefits Intake API as an alternative.",
+                            "enum": [
+                              "compensation",
+                              "pension",
+                              "survivor"
+                            ]
+                          },
+                          "claimantSsn": {
+                            "type": "string",
+                            "example": "001122334",
+                            "description": "SSN of the Claimant."
+                          }
+                        },
+                        "example": {
+                          "type": "compensation"
+                        }
+                      }
+                    }
                   }
                 },
                 "example": {
-                  "type": "compensation"
+                  "data": {
+                    "type": "intent_to_file",
+                    "attributes": {
+                      "type": "compensation"
+                    }
+                  }
                 }
               }
             }