TRAPI 1.4 Implementation and Migration guide

[uhbrar]

This is the migration guide to implement the breaking changes of TRAPI 1.4. This focuses solely on the changes invoked by #389. I also have a version of this drafted that includes the changes from #393, however I have elected to leave those out to keep this guide more focused. If there is desire for those changes to be included into this guide as well, I can update the guide to include it.

I'm not sure if we want to actually merge this guide in, or just leave it here so people may look at it.

Please review this guide and let me know if there is anything that needs to be further clarified.

Edit: Adding the link from Eric to easily read the guide:

https://github.com/uhbrar/ReasonerAPI/blob/1.4_migration_guide/MigrationAndImplementationGuide1-4.md

[edeutsch]

This looks great, thanks! Is the auxiliary_graphs section perhaps missing from the final TRAPI 1.4 message at the bottom?

[uhbrar]

Good catch, thanks for pointing that out. I've fixed it!

[edeutsch]

One can directly read the guide here: https://github.com/uhbrar/ReasonerAPI/blob/1.4_migration_guide/MigrationAndImplementationGuide1-4.md

[edgargaticaCU]

There's a few minor typos in the text parts. Line 165: estra -> extra Line 169: creats -> create Line 219: edge -> edges

[CaseyTa]

Thanks @uhbrar, this is helpful! I think the final example just needs to remove a2 from the list of support_graphs in the analyses since in this example, you used the combined auxiliary graph for extra_edge0 and extra_edge1 (or you can use the version of the auxiliary graphs where you split those two extra edges into two aux graphs)