Skip to content

Instantly share code, notes, and snippets.

@mhoppa
Last active February 20, 2020 15:13
Show Gist options
  • Save mhoppa/bb5341e6a0617aea9282265b840e0735 to your computer and use it in GitHub Desktop.
Save mhoppa/bb5341e6a0617aea9282265b840e0735 to your computer and use it in GitHub Desktop.
ATC TO Rewrite Status

Routes Left to Rewrite

Route Open PR Github Issue Notes
cachegroupparameters/{{cgID}}/{{paramID}} Issue Jeremy to investigate usage of route
cachegroupparameters Issue Jeremy to investigate usage of route
capabilities PR Issue Waiting on deprecation notes being added to POST handler
cdns/routing PR Issue Stuck on Comcast internal Perl Extension. Working with Author to see if we can get that solved
deliveryservices/{{id}}/routing Issue
deliveryservices/{{id}}/safe PR Issue Waiting on Author to respond to comments
isos Issue In progress
regions/name/{{name}} Issue GET already done DELETE needs to be added
servers/checks Issue
to_extensions Issue
user/current/update Issue

Deprecation routes

Approach

  • Deprecated routes do not need to be rewritten from Perl to Go
  • Deprecated routes will still be available in 1.x but will not be available in 2.x
  • Deprecated routes will be marked as such in the documentation and will return a deprecation notice in the response

Deprecation Route Candidates

Route Verbs Open PR Github Issue Deprecation reason
api_capabilities/{{id}} Issue API Capabilities should not be able to be update/deleted/created at runtime as it should be done as db migrations and GET by id should be supported by api_capabilities route via query parameters.
api_capabilities POST Issue API Capabilities should not be able to be update/deleted/created at runtime as it should be done as db migrations
cachegroup/{{paramID}}/parameter Issue Not used in TP or other components and can get data from cachegroupparameters
cachegroup_fallbacks Issue Go cachegroups API routes supersede this
cachegroups/{{paramID}}/parameter/available Issue Not used in TP or other components and can get data from cachegroupparameters
capabilities/{{name}} PR Issue PUT/DELETE should not be allowed on capabilites as it should be done with db migrations. GET will be supported via /capabilites Query Parameters
capabilities POST PR Issue POST should not be allowed on capabilites as it should be done with db migrations. GET will be rewritten
cdns/configs Issue Returns only cdns with partial data on each which can be done from cdn route
cdns/usage/overview Issue Unauthenticated route used by old UI
cdns/{name}/configs/routing PR Issue Perl route is in a broken, partial implementation of trying to break up the CRConfig into multiple files
deliveryservice_user/{{DSID}}/{{userID}} PR Issue Delivery service users have no effect in our current system due to the introduction of tenancy
deliveryservice_user PR Issue Assigning delivery services to a user has no effect in our current system due to the introduction of tenancy
deliveryservices/{{id}}/state Issue Does not appear to have any value and seems to be half implemented (?)
divisions/name/{{name}} Issue Deprecate as GET/DELETE should be done through divisions route with query parameter of name (GET is already supported)
divisions/{{division}}/regions Issue Can be done via regions route with divisionId query parameter
federation_resolvers/{{ID}} DELETE Issue Should be handled through federation_resolvers route with query parameter of id
hwinfo/dtdata Issue Used by old Perl UI
parameters/validate Issue Should just be caught on parameters post as a 400 error
parameters/{{id}}/profiles Issue Can be done via profiles route with paramID query parameter
parameters/{{id}}/unassigned_profiles Issue Can be done via pulling GET /profiles?paramId=x and /profiles and doing diff
regions/{{region}}/phys_locations Issue Can currently be done via POST /phys_locations
riak/stats Issue Just a pass through on Riak API and used for informational/debug purposes when intially integrating Riak. Also want to get rid of Riak.
servercheck/aadata Issue Used by old TO UI
servers/totals Issue
stats_summary/create Issue Deprecate route but carry over logic into a POST on the existing stats_summary route
to_extensions/{{id}}/delete Issue Deprecate route but carry over logic into a DELETE on the existing to_extensions route
traffic_monitor/stats Issue Used by old Perl UI
types/trimmed Issue Can get the same data in types route

If VERBS is left blank that means route will be deprecated in whole

@ocket8888
Copy link

"example"?

@mhoppa
Copy link
Author

mhoppa commented Dec 3, 2019

left for us to easily fill in the rest of the routes we need to discuss

@ocket8888
Copy link

👍

@mitchell852
Copy link

how about an * next to Deprecation routes and then:

  • deprecated routes will not be rewritten from Perl to Go
  • deprecated routes will still be available in 1.x but will not be available in 2.x
  • deprecated routes will be marked as such in the documentation and will return a deprecation notice in the response

@mitchell852
Copy link

cachegroup/{{paramID}}/parameter and cachegroups/{{paramID}}/parameter/available should go in the deprecate list as I found no usage of it.

cachegroupparameters and cachegroupparameters/{{cgID}}/{{paramID}} should stay in the rewrite list as TP uses them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment