index int64 0 0 | repo_id stringclasses 829
values | file_path stringlengths 34 254 | content stringlengths 6 5.38M |
|---|---|---|---|
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/contacts.rb | # frozen_string_literal: true
require 'va_profile/models/associated_person'
module Swagger::Schemas
class Contacts
include Swagger::Blocks
swagger_schema :Contacts do
key :required, [:data]
property :data, type: :array do
items do
property :id, type: :string
property... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/permission.rb | # frozen_string_literal: true
module Swagger
module Schemas
class Permission
include Swagger::Blocks
swagger_schema :Permission do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :attributes, type: :object do
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/address.rb | # frozen_string_literal: true
module Swagger
module Schemas
class Address
include Swagger::Blocks
swagger_schema :Address do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :attributes, type: :object do
pr... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/intent_to_file.rb | # frozen_string_literal: true
require 'disability_compensation/responses/intent_to_files_response'
module Swagger
module Schemas
class IntentToFile
include Swagger::Blocks
swagger_schema :IntentToFileBase do
key :required, %i[
id
creation_date
expiration_date
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/letters.rb | # frozen_string_literal: true
module Swagger
module Schemas
class Letters
include Swagger::Blocks
swagger_schema :Letters do
key :required, [:data]
property :data, type: :object do
property :attributes, type: :object do
key :required, %i[letters full_name]
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/upload_supporting_evidence.rb | # frozen_string_literal: true
module Swagger
module Schemas
class UploadSupportingEvidence
include Swagger::Blocks
swagger_schema :UploadSupportingEvidence do
property :data, type: :object do
property :attributes, type: :object do
key :required, %i[guid]
pro... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/countries.rb | # frozen_string_literal: true
module Swagger
module Schemas
class Countries
include Swagger::Blocks
swagger_schema :Countries do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :attributes, type: :object do
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/schemas/evss_auth_error.rb | # frozen_string_literal: true
module Swagger
module Schemas
class EVSSAuthError
include Swagger::Blocks
swagger_schema :EVSSAuthError do
key :required, [:errors]
property :errors do
key :type, :array
items do
key :required, %i[title detail code status... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/gibct/meta.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Gibct
class Meta
include Swagger::Blocks
STATES = %i[
AK AL AR AS AZ CA CO CT DC DE FL FM GA GU HI IA
ID IL IN KS KY LA MA MD ME MH MI MN MO MP MS MT
NC ND NE BH NJ NM NV NY OH OK OR PA PR PW R... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/gibct/institutions.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Gibct
class Institutions
include Swagger::Blocks
swagger_schema :GibctInstitutionsAutocomplete do
key :required, %i[data meta links]
property :data, type: :array, minItems: 0, uniqueItems: true do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/gibct/calculator_constants.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Gibct
class CalculatorConstants
include Swagger::Blocks
swagger_schema :GibctCalculatorConstants do
key :required, %i[data meta links]
property :data, type: :array, minItems: 0, uniqueItems: true do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/gibct/institution_programs.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Gibct
class InstitutionPrograms
include Swagger::Blocks
swagger_schema :GibctInstitutionProgramsAutocomplete do
key :required, %i[data meta links]
property :data, type: :array, minItems: 0, uniqueItems:... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/gibct/yellow_ribbon_programs.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Gibct
class YellowRibbonPrograms
include Swagger::Blocks
swagger_schema :GibctYellowRibbonPrograms do
key :required, %i[data meta links]
property :data, type: :array, maxItems: 30, uniqueItems: true do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/contact_us/successful_inquiry_creation.rb | # frozen_string_literal: true
module Swagger
module Schemas
module ContactUs
class SuccessfulInquiryCreation
include Swagger::Blocks
swagger_schema :SuccessfulInquiryCreation do
key :required, %i[confirmationNumber dateSubmitted]
property :confirmationNumber,
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/contact_us/inquiries_list.rb | # frozen_string_literal: true
module Swagger
module Schemas
module ContactUs
class InquiriesList
include Swagger::Blocks
swagger_schema :InquiriesList do
property :inquiries, type: :array do
items do
key :$ref, :InquirySummary
end
e... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/meta.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Meta
include Swagger::Blocks
swagger_schema :MetaPagination do
key :type, :object
key :required, [:pagination]
property :pagination, '$ref': :Pagination
end
swagg... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/triage_teams.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class TriageTeams
include Swagger::Blocks
swagger_schema :TriageTeams do
key :required, %i[data meta]
property :data, type: :array, minItems: 1, uniqueItems: true do
items do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/folders.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Folders
include Swagger::Blocks
swagger_schema :Folders do
key :required, %i[data meta]
property :data, type: :array, minItems: 1, uniqueItems: true do
items do
ke... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/messages.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Messages
include Swagger::Blocks
swagger_schema :Messages do
key :required, %i[data meta]
property :data, type: :array, minItems: 1, uniqueItems: true do
items do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/links.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Links
include Swagger::Blocks
swagger_schema :LinksAll do
key :type, :object
key :required, %i[self first prev next last]
property :self, type: :string
property :first, ... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/prescriptions.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Prescriptions
include Swagger::Blocks
swagger_schema :Prescriptions do
key :required, %i[data meta]
property :data, type: :array, minItems: 1, uniqueItems: true do
items do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/health/trackings.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Health
class Trackings
include Swagger::Blocks
swagger_schema :Trackings do
key :required, %i[data meta links]
property :data, type: :array, minItems: 1, uniqueItems: true do
items do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/async_transaction/vet360.rb | # frozen_string_literal: true
module Swagger
module Schemas
module AsyncTransaction
class Vet360
include Swagger::Blocks
swagger_schema :AsyncTransactionVet360 do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/gender_identity.rb | # frozen_string_literal: true
require 'va_profile/models/gender_identity'
module Swagger
module Schemas
module Vet360
class GenderIdentity
include Swagger::Blocks
swagger_schema :PutGenderIdentity do
key :required, %i[code]
property :code,
type: :str... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/states.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Vet360
class States
include Swagger::Blocks
swagger_schema :Vet360States do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :attribu... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/email.rb | # frozen_string_literal: true
require 'va_profile/models/email'
module Swagger
module Schemas
module Vet360
class Email
include Swagger::Blocks
swagger_schema :PostVet360Email do
key :required, %i[email_address]
property :email_address,
type: :string... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/preferred_name.rb | # frozen_string_literal: true
require 'va_profile/models/preferred_name'
module Swagger
module Schemas
module Vet360
class PreferredName
include Swagger::Blocks
swagger_schema :PutPreferredName do
key :required, %i[text]
property :text,
type: :string... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/zipcodes.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Vet360
class Zipcodes
include Swagger::Blocks
swagger_schema :Vet360Zipcodes do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :att... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/communication_permission.rb | # frozen_string_literal: true
# rubocop:disable Metrics/MethodLength
module Swagger
module Schemas
module Vet360
module CommunicationPermission
def self.extended(base)
base.parameter do
key :name, :permission_data
key :in, :body
key :description, 'Commu... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/telephone.rb | # frozen_string_literal: true
require 'va_profile/models/telephone'
module Swagger
module Schemas
module Vet360
class Telephone
include Swagger::Blocks
swagger_schema :PostVet360Telephone do
key :required, %i[phone_number area_code phone_type is_international country_code]
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/permission.rb | # frozen_string_literal: true
require 'va_profile/models/permission'
module Swagger
module Schemas
module Vet360
class Permission
include Swagger::Blocks
swagger_schema :PostVet360Permission do
key :required, %i[permission_type permission_value]
property :permission_ty... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/address.rb | # frozen_string_literal: true
require 'va_profile/models/address'
require 'va_profile/models/base_address'
module Swagger
module Schemas
module Vet360
class Address
include Swagger::Blocks
ADDRESS_FIELD_LIMIT = ::VAProfile::Models::BaseAddress::ADDRESS_FIELD_LIMIT
swagger_schema :... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/contact_information.rb | # frozen_string_literal: true
require 'va_profile/contact_information/v2/person_response'
require 'va_profile/contact_information/v2/service'
require 'va_profile/models/address'
require 'va_profile/models/telephone'
require 'common/models/redis_store'
require 'common/models/concerns/cache_aside'
module Swagger
modu... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/vet360/countries.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Vet360
class Countries
include Swagger::Blocks
swagger_schema :Vet360Countries do
key :required, [:data]
property :data, type: :object do
key :required, [:attributes]
property :a... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/form526_submit_v2.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Form526SubmitV2
include Swagger::Blocks
DATE_PATTERN = /^(\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$/
ADDRESS_PATTERN = /^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$/
swagge... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/form8940.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Form8940
include Swagger::Blocks
swagger_schema :Form8940 do
property :unemployability, type: :object do
property :mostIncome, type: :number
property :yearEarned, type: :strin... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/separation_locations.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class SeparationLocations
include Swagger::Blocks
swagger_schema :SeparationLocations do
key :required, [:separation_locations]
property :separation_locations, type: :array do
items d... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/date_range.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class DateRange
include Swagger::Blocks
swagger_schema :DateRange do
property :from,
type: :string,
pattern: Swagger::Schemas::Form526::Form526SubmitV2::DATE_PATTERN,
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/disability.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Disability
include Swagger::Blocks
swagger_schema :NewDisability do
key :required, %i[condition cause]
property :condition, type: :string
property :cause, type: :string, enum:
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/submit_disability_form.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class SubmitDisabilityForm
include Swagger::Blocks
swagger_schema :SubmitDisabilityForm do
key :required, [:data]
property :data, type: :object do
property :attributes, type: :object... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/rating_info.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class RatingInfo
include Swagger::Blocks
swagger_schema :RatingInfo do
property :disability_decision_type_name, type: :string, example: 'Service Connected'
property :service_connected_combined_de... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/form4142.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Form4142
include Swagger::Blocks
swagger_schema :Form4142 do
property :limitedConsent, type: :string
property :providerFacility, type: :array, minItems: 1, maxItems: 100 do
item... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/rated_disabilities.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class RatedDisabilities
include Swagger::Blocks
swagger_schema :RatedDisabilities do
key :required, [:data]
property :data, type: :object do
property :attributes, type: :object do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/suggested_conditions.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class SuggestedConditions
include Swagger::Blocks
swagger_schema :SuggestedConditions do
key :required, [:data]
property :data do
key :type, :array
items do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/job_status.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class JobStatus
include Swagger::Blocks
swagger_schema :JobStatus do
key :required, [:data]
property :data, type: :object do
property :attributes, type: :object do
prop... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/address.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Address
include Swagger::Blocks
swagger_schema :AddressRequiredFields do
key :required, %i[country city addressLine1]
# See link for country enum
# https://github.com/department-... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/form526/form0781.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Form526
class Form0781
include Swagger::Blocks
swagger_schema :Form0781 do
property :remarks, type: :string
property :additionalIncidentText, type: :string
property :additionalSecondaryIncident... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/appeals/requests.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Appeals
class Requests
include Swagger::Blocks
swagger_schema :Appeals do
key :type, :object
key :required, %i[data]
property :data, type: :array do
items type: :object do
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/appeals/notice_of_disagreement.rb | # frozen_string_literal: true
require 'decision_review/schemas'
module Swagger
module Schemas
module Appeals
class NoticeOfDisagreement
include Swagger::Blocks
swagger_schema(
'nodContestableIssues',
DecisionReview::Schemas::NOD_CONTESTABLE_ISSUES_RESPONSE_200.merge(
... |
0 | code_files/vets-api-private/app/swagger/swagger/schemas | code_files/vets-api-private/app/swagger/swagger/schemas/appeals/higher_level_review.rb | # frozen_string_literal: true
module Swagger
module Schemas
module Appeals
class HigherLevelReview
include Swagger::Blocks
VetsJsonSchema::SCHEMAS.fetch('HLR-CREATE-REQUEST-BODY')['definitions'].each do |k, v|
v.delete('$comment')
if k == 'hlrCreateDataAttributes'
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/claim_letters.rb | # frozen_string_literal: true
# app/controllers/v0/claim_letters_controller.rb
module Swagger
module Requests
class ClaimLetters < ApplicationController
include Swagger::Blocks
swagger_path '/v0/claim_letters' do
operation :get do
extend Swagger::Responses::AuthenticationError
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/preneeds_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class PreneedsClaims
include Swagger::Blocks
swagger_schema :PreneedAddress do
property :street, type: :string, example: '140 Rock Creek Church Rd NW'
property :street2, type: :string, example: ''
property :city, ty... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/claim_documents.rb | # frozen_string_literal: true
module Swagger
module Requests
class ClaimDocuments
include Swagger::Blocks
swagger_path '/v0/claim_attachments' do
operation :post do
extend Swagger::Responses::UnprocessableEntityError
extend Swagger::Responses::SavedForm
key :de... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/financial_status_reports.rb | # frozen_string_literal: true
module Swagger
module Requests
class FinancialStatusReports
include Swagger::Blocks
swagger_path '/debts_api/v0/financial_status_reports' do
operation :post do
key :summary, 'Submits Form VA-5655 data to the Debt Management Center'
key :descr... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/onsite_notifications.rb | # frozen_string_literal: true
module Swagger
module Requests
class OnsiteNotifications
include Swagger::Blocks
swagger_path '/v0/onsite_notifications/{id}' do
operation :patch do
extend Swagger::Responses::AuthenticationError
extend Swagger::Responses::ValidationError
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/digital_disputes.rb | # frozen_string_literal: true
module Swagger
module Requests
class DigitalDisputes
include Swagger::Blocks
swagger_path '/debts_api/v0/digital_disputes' do
operation :post do
key :summary, 'Submits digital dispute documents to the Debt Management Center and VBS'
key :desc... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/form1010_ezr_attachments.rb | # frozen_string_literal: true
module Swagger
module Requests
class Form1010EzrAttachments
include Swagger::Blocks
swagger_path '/v0/form1010_ezr_attachments' do
operation :post do
extend Swagger::Responses::BadRequestError
extend Swagger::Responses::UnprocessableEntityErr... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/education_benefits_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class EducationBenefitsClaims
include Swagger::Blocks
swagger_path '/v0/education_benefits_claims/{form_type}' do
operation :post do
extend Swagger::Responses::ValidationError
key :description, 'Submit an educa... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/search_typeahead.rb | # frozen_string_literal: true
module Swagger
module Requests
class SearchTypeahead
include Swagger::Blocks
swagger_path '/v0/search_typeahead' do
operation :get do
key :description, 'Returns a list of search query suggestions, from Search.gov, for the passed search query'
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/health_care_applications.rb | # frozen_string_literal: true
require 'hca/enrollment_eligibility/status_matcher'
module Swagger
module Requests
class HealthCareApplications
include Swagger::Blocks
swagger_path '/v0/health_care_applications/rating_info' do
operation :get do
key :description, 'Get the user\'s ser... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/maintenance_windows.rb | # frozen_string_literal: true
module Swagger
module Requests
class MaintenanceWindows
include Swagger::Blocks
swagger_path '/v0/maintenance_windows' do
operation :get do
key :description, 'Get a list of scheduled maintenance windows by service'
key :operationId, 'getMaint... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/mvi_users.rb | # frozen_string_literal: true
module Swagger
module Requests
class MviUsers
include Swagger::Blocks
swagger_path '/v0/mvi_users/{id}' do
operation :post do
extend Swagger::Responses::AuthenticationError
extend Swagger::Responses::ForbiddenError
extend Swagger::R... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/dependents_verifications.rb | # frozen_string_literal: true
module Swagger
module Requests
class DependentsVerifications
include Swagger::Blocks
swagger_path '/v0/dependents_verifications' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, "Get the veteran's depende... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/travel_pay.rb | # frozen_string_literal: true
module Swagger
module Requests
class TravelPay
include Swagger::Blocks
swagger_path '/travel_pay/v0/claims' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, 'Get a list of travel reimbursment claim summar... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/datadog_action.rb | # frozen_string_literal: true
module Swagger
module Requests
class DatadogAction
include Swagger::Blocks
swagger_path '/v0/datadog_action' do
operation :post do
key :summary, 'Record a front-end action in Datadog'
key :operationId, 'recordDatadogAction'
key :tag... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/search.rb | # frozen_string_literal: true
# rubocop:disable Layout/LineLength
module Swagger
module Requests
class Search
include Swagger::Blocks
swagger_path '/v0/search' do
operation :get do
key :description, 'Returns a list of search results, from Search.gov, for the passed search query'
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/caregivers_assistance_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class CaregiversAssistanceClaims
include Swagger::Blocks
swagger_path '/v0/caregivers_assistance_claims' do
operation :post do
extend Swagger::Responses::ValidationError
key :description,
'Submit ... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/form1010_ezrs.rb | # frozen_string_literal: true
module Swagger
module Requests
class Form1010Ezrs
include Swagger::Blocks
swagger_path '/v0/form1010_ezrs' do
operation :post do
extend Swagger::Responses::AuthenticationError
extend Swagger::Responses::ValidationError
extend Swagge... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/forms.rb | # frozen_string_literal: true
module Swagger
module Requests
class Forms
include Swagger::Blocks
swagger_path '/v0/forms' do
operation :get do
key :description, 'Returns a list of forms from the VA Lighthouse API, filtered using an optional search term'
key :operationId, ... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/in_progress_forms.rb | # frozen_string_literal: true
module Swagger
module Requests
class InProgressForms
include Swagger::Blocks
tags = { tags: ['in_progress_forms'] }
swagger_path '/v0/in_progress_forms' do
operation :get, **tags do
extend Swagger::Responses::AuthenticationError
key :... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/event_bus_gateway.rb | # frozen_string_literal: true
module Swagger
module Requests
class EventBusGateway
include Swagger::Blocks
swagger_path '/v0/event_bus_gateway/send_email' do
operation :post do
extend Swagger::Responses::AuthenticationError
key :description, 'Sends an email to a veteran a... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/claim_status.rb | # frozen_string_literal: true
module Swagger
module Requests
class ClaimStatus
include Swagger::Blocks
swagger_path '/v0/evss_claims/{evss_claim_id}/documents' do
operation :post do
extend Swagger::Responses::UnprocessableEntityError
key :description, 'upload a document a... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/sign_in.rb | # frozen_string_literal: true
# rubocop:disable Layout/LineLength
module Swagger
module Requests
class SignIn
include Swagger::Blocks
swagger_path '/v0/sign_in/authorize' do
operation :get do
key :description, 'Initializes Sign in Service authorization & authentication.'
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/banners.rb | # frozen_string_literal: true
module Swagger
module Requests
class Banners
include Swagger::Blocks
swagger_path '/v0/banners' do
operation :get do
key :description, 'Returns banners that match the specified path and banner type'
key :operationId, 'getBannersByPath'
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/form210779.rb | # frozen_string_literal: true
module Swagger
module Requests
class Form210779
include Swagger::Blocks
FORM_ID = '21-0779'
swagger_path '/v0/form210779' do
operation :post do
extend Swagger::Responses::BadRequestError
extend Swagger::Responses::RecordNotFoundError
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/veteran_readiness_employment_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class VeteranReadinessEmploymentClaims
include Swagger::Blocks
swagger_path '/v0/veteran_readiness_employment_claims' do
operation :post do
extend Swagger::Responses::ValidationError
extend Swagger::Responses::S... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/form1095_bs.rb | # frozen_string_literal: true
module Swagger
module Requests
class Form1095Bs
include Swagger::Blocks
swagger_path '/v0/form1095_bs/available_forms' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, 'List of available 1095-B forms for ... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/benefits_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class BenefitsClaims
include Swagger::Blocks
swagger_path '/v0/benefits_claims/failed_upload_evidence_submissions' do
operation :get do
extend Swagger::Responses::AuthenticationError
extend Swagger::Responses::F... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/dependents_applications.rb | # frozen_string_literal: true
module Swagger
module Requests
class DependentsApplications
include Swagger::Blocks
swagger_path '/v0/dependents_applications/show' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, 'Get the dependents for... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/feature_toggles.rb | # frozen_string_literal: true
require 'backend_services'
module Swagger
module Requests
class FeatureToggles
include Swagger::Blocks
swagger_path '/v0/feature_toggles' do
operation :get do
key :description, 'Gets the current status of feature toggles'
key :operationId, '... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/profile.rb | # frozen_string_literal: true
# rubocop:disable Metrics/ClassLength
# rubocop:disable Layout/LineLength
module Swagger
module Requests
class Profile
include Swagger::Blocks
swagger_path '/v0/profile/direct_deposits' do
operation :get do
key :produces, ['application/json']
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/debts.rb | # frozen_string_literal: true
module Swagger
module Requests
class Debts
include Swagger::Blocks
swagger_path '/v0/debts' do
operation :get do
key :description, 'Provides an array of debt details provided by the Debt Management Center for the veteran.'
key :operationId, '... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/debt_letters.rb | # frozen_string_literal: true
module Swagger
module Requests
class DebtLetters
include Swagger::Blocks
swagger_path '/v0/debt_letters/{id}' do
operation :get do
key :description, 'Download a debt letter PDF'
key :operationId, 'getDebtLetter'
key :tags, %w[debts]... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/search_click_tracking.rb | # frozen_string_literal: true
# rubocop:disable Layout/LineLength
module Swagger
module Requests
class SearchClickTracking
include Swagger::Blocks
swagger_path '/v0/search_click_tracking/?position={position}&query={query}&url={url}&module_code={module_code}&user_agent={user_agent}' do
operat... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/terms_of_use_agreements.rb | # frozen_string_literal: true
module Swagger
module Requests
class TermsOfUseAgreements
include Swagger::Blocks
swagger_path '/v0/terms_of_use_agreements/{version}/accept' do
operation :post do
key :description, 'Accepts the terms of use agreement'
key :operationId, 'acce... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/coe.rb | # frozen_string_literal: true
module Swagger
module Requests
class Coe
include Swagger::Blocks
swagger_path '/v0/coe/status' do
operation :get do
key :description, 'Returns the status of a vet\'s Certificate of Eligibility application.'
key :operationId, 'coeGetCoeStatus'... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/intent_to_file.rb | # frozen_string_literal: true
module Swagger
module Requests
class IntentToFile
include Swagger::Blocks
swagger_path '/v0/intent_to_file' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, 'Get a list of all Intent To File requests made... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/benefits_reference_data.rb | # frozen_string_literal: true
module Swagger
module Requests
class BenefitsReferenceData
include Swagger::Blocks
swagger_path '/v0/benefits_reference_data/{path}' do
operation :get do
key :description,
'Get data from the Lighthouse Benefits Reference Data (BRD) End-po... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/upload_supporting_evidence.rb | # frozen_string_literal: true
module Swagger
module Requests
class UploadSupportingEvidence
include Swagger::Blocks
swagger_path '/v0/upload_supporting_evidence' do
operation :post do
extend Swagger::Responses::BadRequestError
extend Swagger::Responses::UnprocessableEntit... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/education_career_counseling_claims.rb | # frozen_string_literal: true
module Swagger
module Requests
class EducationCareerCounselingClaims
include Swagger::Blocks
swagger_path '/v0/education_career_counseling_claims' do
operation :post do
extend Swagger::Responses::ValidationError
extend Swagger::Responses::Sav... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/backend_statuses.rb | # frozen_string_literal: true
require 'backend_services'
require 'pagerduty/models/service'
module Swagger
module Requests
class BackendStatuses
include Swagger::Blocks
swagger_path '/v0/backend_statuses' do
operation :get do
key :description, 'Gets the current status of all exter... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/form212680.rb | # frozen_string_literal: true
module Swagger
module Requests
class Form212680
include Swagger::Blocks
FORM_ID = '21-2680'
swagger_path '/v0/form212680' do
operation :post do
extend Swagger::Responses::BadRequestError
extend Swagger::Responses::RecordNotFoundError
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/medical_copays.rb | # frozen_string_literal: true
module Swagger
module Requests
class MedicalCopays
include Swagger::Blocks
swagger_path '/v0/medical_copays' do
operation :get do
key :description, 'List of user copays for VA facilities'
key :operationId, 'getMedicalCopays'
key :ta... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/user.rb | # frozen_string_literal: true
module Swagger
module Requests
class User
include Swagger::Blocks
swagger_path '/v0/user' do
operation :get do
extend Swagger::Responses::AuthenticationError
key :description, 'Get user data'
key :operationId, 'getUser'
k... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/disability_compensation_form.rb | # frozen_string_literal: true
module Swagger
module Requests
class DisabilityCompensationForm
include Swagger::Blocks
swagger_path '/v0/disability_compensation_form/rated_disabilities' do
operation :get do
extend Swagger::Responses::AuthenticationError
extend Swagger::Res... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/disability_compensation_in_progress_forms.rb | # frozen_string_literal: true
module Swagger
module Requests
class DisabilityCompensationInProgressForms
include Swagger::Blocks
tags = { tags: %w[in_progress_forms form_526] }
swagger_path '/v0/disability_compensation_in_progress_forms/{id}' do
operation :delete, **tags do
... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/efolder.rb | # frozen_string_literal: true
module Swagger
module Requests
class Efolder
include Swagger::Blocks
swagger_path '/v0/efolder' do
operation :get do
key :summary, 'Provides a list of document ids and descriptions from eFolder'
key :description,
'Provides a lis... |
0 | code_files/vets-api-private/app/swagger/swagger | code_files/vets-api-private/app/swagger/swagger/requests/hca_attachments.rb | # frozen_string_literal: true
module Swagger
module Requests
class HCAAttachments
include Swagger::Blocks
swagger_path '/v0/hca_attachments' do
operation :post do
extend Swagger::Responses::BadRequestError
extend Swagger::Responses::UnprocessableEntityError
key... |
0 | code_files/vets-api-private/app/swagger/swagger/requests | code_files/vets-api-private/app/swagger/swagger/requests/gibct/institutions.rb | # frozen_string_literal: true
module Swagger
module Requests
module Gibct
class Institutions
include Swagger::Blocks
swagger_path '/v0/gi/institutions/autocomplete' do
operation :get do
key :description, 'Retrieves institution names begining with a set of letters'
... |
0 | code_files/vets-api-private/app/swagger/swagger/requests | code_files/vets-api-private/app/swagger/swagger/requests/gibct/calculator_constants.rb | # frozen_string_literal: true
module Swagger
module Requests
module Gibct
class CalculatorConstants
include Swagger::Blocks
swagger_path '/v0/gi/calculator_constants' do
operation :get do
key :description, 'Gets all calculator constants'
key :operationId, ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.