[ENH] Added root endpoint with welcome message and API docs link

[samadpls]

• Closes Change root path for API to display an informative landing message/page #199

Changes proposed in this pull request:

• Created root endpoint with welcome message and API docs link

Checklist

• PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see https://neurobagel.org/contributing/pull_requests for more info)
• PR has a label for the release changelog or skip-release (to be applied by maintainers only)
• PR links to GitHub issue with mention Closes #XXXX
• Tests pass
• Checks pass

For new features:

• Tests have been added

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

[coveralls]

Pull Request Test Coverage Report for Build 8371746917

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 10 of 10 (100.0%) changed or added relevant lines in 2 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.003%) to 99.788%

---

Totals
Change from base Build 8193778627:	0.003%
Covered Lines:	940
Relevant Lines:	942

---

💛 - Coveralls

[samadpls]

output:

[surchs]

Thanks @samadpls for taking this on, this looks good to me. I'd wait for @alyssadai to take a look at my question, but after that I think we'd be good to merge 🧑‍🍳

[alyssadai]

Hey @samadpls, thanks again for addressing this! The welcome message looks great and the link seems to work as expected.

Do you want to take a stab at adding a basic test for the new root endpoint response so that our code coverage check passes? https://github.com/neurobagel/api/blob/main/tests/test_app_events.py might be a good place for it for now, and you can use something like

api/tests/test_attributes.py

Lines 32 to 42 in 87a0373

	@pytest.mark.parametrize(
	"invalid_data_element_URI",
	["apple", "some_thing:cool"],
	)
	def test_get_terms_invalid_data_element_URI(
	test_app, invalid_data_element_URI
	):
	"""Given an invalid data element URI, returns a 422 status code as the validation of the data element URI fails."""
	response = test_app.get(f"/attributes/{invalid_data_element_URI}")
	assert response.status_code == 422

as a reference (although note that the above is a test for invalid parameters, whereas in this case you just need to check that the response from / contains some part of the welcome message you would expect, and maybe a successful status code).

Let me know if you have any questions!

[alyssadai]

Thanks @samadpls for the test!

The tests are currently failing on the PR (see https://github.com/neurobagel/api/actions/runs/8363565151/job/22896810427?pr=286#step:6:107), I've suggested an addition below that should fix the problem.

Once the fix is applied, this should be good to merge.

[alyssadai]

Looks good to me!

[surchs]

🚀 PR was released in v0.2.0 🚀