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

Update swagger docs for decision review endpoints #21374

Merged
merged 1 commit into from
Mar 25, 2025
Merged

Update swagger docs for decision review endpoints #21374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions app/swagger/swagger/v1/requests/appeals/appeals.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
class Swagger::V1::Requests::Appeals::Appeals
include Swagger::Blocks

swagger_path '/v1/higher_level_reviews' do
swagger_path '/decision_reviews/v1/higher_level_reviews' do
operation :post do
key :tags, %w[higher_level_reviews]
key :summary, 'Creates a higher level review'
Expand Down Expand Up @@ -34,7 +34,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/higher_level_reviews/{uuid}' do
swagger_path '/decision_reviews/v1/higher_level_reviews/{uuid}' do
operation :get do
key :description, 'This endpoint returns the details of a specific Higher Level Review'
key :operationId, 'showHigherLevelReview'
Expand Down Expand Up @@ -62,7 +62,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/higher_level_reviews/contestable_issues/{benefit_type}' do
swagger_path '/decision_reviews/v1/higher_level_reviews/contestable_issues/{benefit_type}' do
operation :get do
description =
'For the logged-in veteran, returns a list of issues that could be contested in a Higher-Level Review ' \
Expand Down Expand Up @@ -96,7 +96,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/notice_of_disagreements' do
swagger_path '/decision_reviews/v1/notice_of_disagreements' do
operation :post do
key :tags, %w[notice_of_disagreements]
key :summary, 'Creates a notice of disagreement'
Expand Down Expand Up @@ -125,7 +125,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/notice_of_disagreements/{uuid}' do
swagger_path '/decision_reviews/v1/notice_of_disagreements/{uuid}' do
operation :get do
key :description, 'This endpoint returns the details of a specific notice of disagreement'
key :operationId, 'showNoticeOfDisagreement'
Expand Down Expand Up @@ -153,7 +153,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/notice_of_disagreements/contestable_issues' do
swagger_path '/decision_reviews/v1/notice_of_disagreements/contestable_issues' do
operation :get do
description =
'For the logged-in veteran, returns a list of issues that could be contested in a Notice of Disagreement'
Expand All @@ -173,7 +173,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/supplemental_claims' do
swagger_path '/decision_reviews/v1/supplemental_claims' do
operation :post do
key :tags, %w[supplemental_claims]
key :summary, 'Creates a supplemental claim'
Expand Down Expand Up @@ -202,7 +202,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/supplemental_claims/{uuid}' do
swagger_path '/decision_reviews/v1/supplemental_claims/{uuid}' do
operation :get do
key :description, 'Returns all of the data associated with a specific \
Supplemental Claim.'
Expand Down Expand Up @@ -231,7 +231,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/supplemental_claims/contestable_issues/{benefit_type}' do
swagger_path '/decision_reviews/v1/supplemental_claims/contestable_issues/{benefit_type}' do
operation :get do
description =
'For the logged-in veteran, returns a list of issues that could be \
Expand Down Expand Up @@ -260,7 +260,7 @@ class Swagger::V1::Requests::Appeals::Appeals
end
end

swagger_path '/v1/decision_review_evidence' do
swagger_path '/decision_reviews/v1/decision_review_evidence' do
operation :post do
extend Swagger::Responses::BadRequestError

Expand Down
Loading