Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dash/oren/api 34439 poa requests index response spec #16273

Closed
wants to merge 13 commits into from
Closed

Dash/oren/api 34439 poa requests index response spec #16273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
30c48a9
claims-api bgs cassette cleanup: helper nests under dash cassette dir
nihil2501 Apr 6, 2024
0890946
only use claims_api cassette dir for claims_api specs
nihil2501 Apr 8, 2024
733ed1a
remove erroneous Authorization constant reassignment in test suite
nihil2501 Apr 8, 2024
7433e13
template in bgs url to claims_api cassettes
nihil2501 Apr 8, 2024
25216d7
update testing section of claims_api README
nihil2501 Apr 8, 2024
b0d6dba
reformat claims_api cassette invocation for discoverability
nihil2501 Apr 8, 2024
56f97f6
API-34439 remove obsolete rswag generator and output
nihil2501 Apr 8, 2024
dee6f89
API-34439 begin spec + impl of v2/power-of-attorney-requests
nihil2501 Apr 8, 2024
67c8d1f
API-34439 specify v2/power-of-attorney-requests response schema
nihil2501 Apr 10, 2024
935281b
API-34439 specify v2/power-of-attorney-requests response example
nihil2501 Apr 10, 2024
04a62ba
API-34439 appease linter for temporary hardcoded poa requests index r…
nihil2501 Apr 10, 2024
435d835
Merge branch 'master' into dash/oren/API-34439-poa-requests-index-end…
nihil2501 Apr 12, 2024
20d5bff
API-34439 poa request index response schema satisfies VA API naming &…
nihil2501 Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions modules/claims_api/app/controllers/claims_api/v2/power_of_attorney_requests_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# frozen_string_literal: true

module ClaimsApi
module V2
class PowerOfAttorneyRequestsController < ClaimsApi::V2::ApplicationController
# rubocop:disable Metrics/MethodLength
def index
render json: {
data: [
{
type: 'powerOfAttorneyRequest',
id: 12_345,
attributes: {
status: 'DECLINED',
submittedAt: Time.zone.at(1_712_724_672).iso8601,
acceptedOrDeclinedAt: Time.zone.at(1_712_724_672).iso8601,
declinedReason: 'Because I felt like it',
isAddressChangingAuthorized: true,
isTreatmentDisclosureAuthorized: false,
powerOfAttorneyCode: '012',
veteran: {
firstName: 'Firstus',
middleName: nil,
lastName: 'Lastus'
},
claimant: {
participantId: 23_456,
mailingAddress: {
city: 'Baltimore',
state: 'MD',
zip: '21218',
country: 'US',
militaryPostOffice: nil,
militaryPostalCode: nil
},
nonVeteranIndividual: {
firstName: 'Alpha',
middleName: nil,
lastName: 'Omega',
relationshipToVeteran: 'Cousin'
}
},
representative: {
firstName: 'Primero',
lastName: 'Ultimo',
email: '[email protected]'
}
}
}
]
}
end
# rubocop:enable Metrics/MethodLength
end
end
end
293 changes: 293 additions & 0 deletions modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,299 @@
}
},
"paths": {
"/power-of-attorney-requests": {
"get": {
"summary": "Search for Power of Attorney requests.",
"tags": [
"Power of Attorney"
],
"operationId": "searchPowerOfAttorneyRequests",
"security": [
{
"productionOauth": [
"system/claim.read",
"system/system/claim.write"
]
},
{
"sandboxOauth": [
"system/claim.read",
"system/system/claim.write"
]
},
{
"bearer_token": [

]
}
],
"description": "Faceted, paginated, and sorted search of Power of Attorney requests",
"responses": {
"200": {
"description": "Search results",
"content": {
"application/json": {
"example": {
"data": [
{
"type": "powerOfAttorneyRequest",
"id": 12345,
"attributes": {
"status": "DECLINED",
"submittedAt": "2024-04-10T04:51:12+00:00",
"acceptedOrDeclinedAt": "2024-04-10T04:51:12+00:00",
"declinedReason": "Because I felt like it",
"isAddressChangingAuthorized": true,
"isTreatmentDisclosureAuthorized": false,
"powerOfAttorneyCode": "012",
"veteran": {
"firstName": "Firstus",
"middleName": null,
"lastName": "Lastus"
},
"claimant": {
"participantId": 23456,
"mailingAddress": {
"city": "Baltimore",
"state": "MD",
"zip": "21218",
"country": "US",
"militaryPostOffice": null,
"militaryPostalCode": null
},
"nonVeteranIndividual": {
"firstName": "Alpha",
"middleName": null,
"lastName": "Omega",
"relationshipToVeteran": "Cousin"
}
},
"representative": {
"firstName": "Primero",
"lastName": "Ultimo",
"email": "[email protected]"
}
}
}
]
},
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"description": "List of Power of Attorney requests satisfying the given search",
"items": {
"additionalProperties": false,
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"powerOfAttorneyRequest"
]
},
"id": {
"type": "integer",
"description": "The ID of the form application process that uniquely identifies this Power of Attorney request",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"required": [
"status",
"submittedAt",
"acceptedOrDeclinedAt",
"declinedReason",
"isAddressChangingAuthorized",
"isTreatmentDisclosureAuthorized",
"powerOfAttorneyCode",
"veteran",
"claimant",
"representative"
],
"properties": {
"status": {
"type": "string",
"description": "The Power of Attorney request's current status",
"enum": [
"NEW",
"PENDING",
"ACCEPTED",
"DECLINED"
]
},
"submittedAt": {
"type": "string",
"description": "UTC datetime at which the Power of Attorney request was submitted",
"format": "date-time"
},
"acceptedOrDeclinedAt": {
"type": "string",
"description": "UTC datetime at which the Power of Attorney request was accepted or declined",
"nullable": true,
"format": "date-time"
},
"declinedReason": {
"type": "string",
"description": "The reason given by the representative for declining the Power of Attorney request",
"nullable": true
},
"isAddressChangingAuthorized": {
"type": "boolean",
"description": "Whether the representative is authorized to change the claimant's address"
},
"isTreatmentDisclosureAuthorized": {
"type": "boolean",
"description": "Whether the representative is authorized to receive disclosures of the Veteran's treatment records"
},
"powerOfAttorneyCode": {
"type": "string",
"description": "The code that indicates an individual or organization's ability to be granted Power of Attorney for a Veteran"
},
"veteran": {
"type": "object",
"description": "The Veteran for whom Power of Attorney is being requested",
"additionalProperties": false,
"required": [
"firstName",
"middleName",
"lastName"
],
"properties": {
"firstName": {
"type": "string"
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string"
}
}
},
"claimant": {
"type": "object",
"description": "The individual, often but not always the Veteran, that executed this form application process",
"additionalProperties": false,
"required": [
"participantId",
"mailingAddress",
"nonVeteranIndividual"
],
"properties": {
"participantId": {
"type": "integer",
"description": "The identifier of the individual that executed this form application process",
"format": "int64"
},
"mailingAddress": {
"type": "object",
"description": "The mailing address of the individual that executed this form application process",
"additionalProperties": false,
"required": [
"city",
"state",
"zip",
"country",
"militaryPostOffice",
"militaryPostalCode"
],
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"type": "string"
},
"militaryPostOffice": {
"type": "string",
"nullable": true
},
"militaryPostalCode": {
"type": "string",
"nullable": true
}
}
},
"nonVeteranIndividual": {
"type": "object",
"description": "When present, the non-Veteran individual that executed this form application process for the Veteran",
"nullable": true,
"additionalProperties": false,
"required": [
"firstName",
"middleName",
"lastName",
"relationshipToVeteran"
],
"properties": {
"firstName": {
"type": "string"
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string"
},
"relationshipToVeteran": {
"type": "string"
}
}
}
}
},
"representative": {
"type": "object",
"description": "The representative to whom this Power of Attorney request is being submitted",
"additionalProperties": false,
"required": [
"firstName",
"lastName",
"email"
],
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/veteran-id:find": {
"post": {
"summary": "Retrieve Veteran ID.",
Expand Down
Loading
Loading