2937 rfc mobile endpoint naming convention #41036
Conversation
…2-05-05-mobile-route-naming-conventions.md
| get '/military-service-history', to: 'military_information#get_service_history' | ||
| get '/payment-history', to: 'payment_history#index' | ||
| get '/payment-information/benefits', to: 'payment_information#index' | ||
| put '/payment-information/benefits', to: 'payment_information#update' |
There was a problem hiding this comment.
Maybe make a payment parent product?
There was a problem hiding this comment.
or put the payment information endpoints under benefits
There was a problem hiding this comment.
Payment information isn't a descriptive name to begin with 😄 as it's easily confused with payment history (which I just did before editing this comment 😀). But yes, I think it should go under benefits.
There was a problem hiding this comment.
is payment history exclusively used for benefits as well?
| get '/letters/beneficiary', to: 'letters#beneficiary' | ||
| post '/letters/:type/download', to: 'letters#download' | ||
| get '/messaging/health/messages/signature', to: 'messages#signature' | ||
| get '/military-service-history', to: 'military_information#get_service_history' |
There was a problem hiding this comment.
/user/military-service-history ?
| get '/disability-rating', to: 'disability_rating#index' | ||
| get '/health/immunizations', to: 'immunizations#index' | ||
| get '/health/locations/:id', to: 'locations#show' | ||
| get '/letters', to: 'letters#index' |
There was a problem hiding this comment.
Pretty sure letters are only about benefits.
| get '/push/:endpoint_sid/prefs', to: 'push_notifications#get_prefs' | ||
| put '/push/:endpoint_sid/prefs', to: 'push_notifications#set_pref' | ||
|
|
||
| scope :messaging do |
There was a problem hiding this comment.
Messaging is health; a user has to be registered as a patient at a VA health facility to use it. So I think we can flip the scopes so the path ends up being health/messaging.
| get '/appointments/va/eligibility', to: 'veterans_affairs_eligibility#show' | ||
| get '/appointments/facility/eligibility', to: 'facility_eligibility#index' | ||
| post '/appointment', to: 'appointments#create' | ||
| get '/community-care-providers', to: 'community_care_providers#index' |
There was a problem hiding this comment.
Maybe /appointments/community-care-providers ?
There was a problem hiding this comment.
Andrew and I discussed that when I created the endpoint. Our rationale for not doing it is that there could be some theoretical reason that we might need to use providers for a reason not directly linked to appointments (like showing a map of locations or something). I think that's very unlikely and I'm happy with it either way. It sounds like we're trying to do a better job of organizing our module, which is a good thing.
There was a problem hiding this comment.
yeah, I liked the idea at the time but now for the sake of simplicity it does seem cleaner put appointments in the url. Maybe we just keep it as a separate controller in case of the unlikely event that we need to implement more actions for cc providers? probably should do the same with the facility info endpoint as well then.
| get '/appointments/community-care/:service_type/eligibility', to: 'community_care_eligibility#show' | ||
| get '/appointments/va/eligibility', to: 'veterans_affairs_eligibility#show' | ||
| get '/appointments/facility/eligibility', to: 'facility_eligibility#index' | ||
| post '/appointment', to: 'appointments#create' |
There was a problem hiding this comment.
Could this be plural? Even though it's creating a single appointment, the REST convention is that a post to a plural endpoint means one item should be added to the collection.
| get '/appointments', to: 'appointments#index' | ||
| put '/appointments/:id/cancel', to: 'appointments#cancel' | ||
| get '/appointments/community-care/:service_type/eligibility', to: 'community_care_eligibility#show' | ||
| get '/appointments/va/eligibility', to: 'veterans_affairs_eligibility#show' |
There was a problem hiding this comment.
/appointments/eligibility/va, /appointments/eligibility/facility ?
There was a problem hiding this comment.
There's community care too 😁 and although community-care could be a parent I think it has to do more with 'can' rather than 'where' it could also fall under eligibility /appointments/eligibility/community-care ?
| post '/claim/:id/request-decision', to: 'claims_and_appeals#request_decision' | ||
| end | ||
|
|
||
| get '/maintenance-windows', to: 'maintenance_windows#index' |
There was a problem hiding this comment.
/maintenance-windows applies to all services, could it go to the root?
RFC for versioning endpoint of naming consistency