[Internal] Modular API's (in components)

[AbhiramTadepalli]

Overview of Proposed Changes

What: Ensure all API calls are occurring in their respective components
Why: Modularity, cleaner code

Details

• Write/update documentation about how/which APIs are called in Trends
• Identify API calls outside of components
• Move outstanding stray API calls to inside components
• Write documentation on how and where Trends is using the APIs

[Matrixk1ng]

what do you mean by outstanding APIs. A little confused. I am going to use this to understand the code base

[Matrixk1ng]

also when you say "respective components" do you mean, like the components folder? and not the API folder? or both?
And where do I write the Documentation

[AbhiramTadepalli]

what do you mean by outstanding APIs.

API calls that are not inside a component/module (basically if index.tsx is just calling an API that would be better placed inside of a component)

I am going to use this to understand the code base

Sounds great! do you want me to assign you to it?

when you say "respective components" do you mean, like the components folder? and not the API folder? or both?

API's are called in the component files. We have the actual API functions in the /api folder, but they are called all throughout the code. (@TyHil if you want to add context?)

[TyHil]

That's pretty much it. Just to say it another way: There's a professor API (which really just forwards an API call to the Nebula API with the right API key) that's called from the professorOverview component. If instead that API were called from the the dashboard/index.tsx file and the data was passed down to the professorOverview component that would be unnecessary.

I suppose it's important to note this PR could find that all the API calls are in the right places, as far down as they can be moved. Or not. Just good to check.

[Matrixk1ng]

Also where to write the documentation? as small comments or confluence?

[AbhiramTadepalli]

Confluence. Under Engineering. IMO should outline how and where we interact with APIs and how we use that data.