Add and document env vars for API root paths

[alyssadai]

• NB_NAPI_ROOT_PATH
• NB_FAPI_ROOT_PATH
• Specify that paths should not have a trailing slash

Related to:

• Support subdirectory root paths when API is behind a proxy api#392
• Support subdirectory root paths when API is behind a proxy federation-api#152

[alyssadai]

@neurobagel/dev I realized we have a slight name discrepancy between the root/base path in the query tool (NB_QUERY_APP_BASE_PATH), and the ones in the APIs. What are your preferences in terms of whether we should name these *_ROOT_PATH or *_BASE_PATH?

[surchs]

I think _BASE_PATH is the more usual name here (e.g. https://swagger.io/docs/specification/v3_0/api-host-and-base-path/). So I'd prefer _BASE_PATH

[rmanaem]

I've seen *BASE* used more often in documentations. We could differentiate between the env var in API and query tool using *_BASE_PATH and *_BASE_URL.

[alyssadai]

Okay, _BASE_PATH sounds good!

I'd prefer to keep the same name across tools, since for both the query tool and the API only the path prefix needs to be specified, not the full url - so *_BASE_URL may be confusing.

Moving this into tracked until the variable name change is implemented in the APIs (will fix as part of PRs to standardize trailing slashes).

[neurobagel-bot]

🚀 Issue was released in v0.5.0 🚀