Serve resources from API routes ending in /

[beggers]

Description of changes

#895

Serve registered API routes regardless of whether they end in "/".

In the linked bug @HammadB and I discussed looping over all the routes at the end of __init__, but the typechecker complains: the only thing we know about self._app.routes is that they're instances of BaseRoute, which may not have the fields we need. Rather than do type coercion I subclassed fastapi.APIRouter.

The logic to set kwargs["include_in_schema"] is maybe too clever, should we just do an if-else instead?

Test plan

0 ~ beggers % curl http://localhost:8000/api/v1/collections/ -v
*   Trying 127.0.0.1:8000...
* Connected to localhost (127.0.0.1) port 8000 (#0)
> GET /api/v1/collections/ HTTP/1.1
> Host: localhost:8000
> User-Agent: curl/8.1.2
> Accept: */*
> 
< HTTP/1.1 200 OK
< date: Thu, 03 Aug 2023 19:14:01 GMT
< server: uvicorn
< content-length: 2
< content-type: application/json
< 
* Connection #0 to host localhost left intact
[]%                                                                                   
0 ~ beggers % curl http://localhost:8000/api/v1/collections -v 
*   Trying 127.0.0.1:8000...
* Connected to localhost (127.0.0.1) port 8000 (#0)
> GET /api/v1/collections HTTP/1.1
> Host: localhost:8000
> User-Agent: curl/8.1.2
> Accept: */*
> 
< HTTP/1.1 200 OK
< date: Thu, 03 Aug 2023 19:14:02 GMT
< server: uvicorn
< content-length: 2
< content-type: application/json
< 
* Connection #0 to host localhost left intact
[]%

Also, pytest locally and CI. I'd like to confirm this doesn't break JS client generation and doc generation -- how can I do that?

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

No documentation changes needed for this.

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readbility, Modularity, Intuitiveness)

[HammadB]

Thanks!

Docs generation readme is here - https://github.com/chroma-core/docs#generating-python-docs (and right below for js)
Client generation readme is here - https://github.com/chroma-core/chroma/blob/main/clients/js/DEVELOP.md

I'd expect there to be no diff in either when we rerun them, thanks for checking

[HammadB]

Nit - let's not stomp the fastapi name for the class

[HammadB]

extreme nit - duplicated logic (feel free to ignore this, just calling it out)

[HammadB]

Approved pending nits, the testing we discussed and CI! Thank you!

[beggers]

• Python doc generation seems broken; fix python docs docs#105 should fix it? When I run yarn gen-python it does make some changes before it breaks, but those changes all appear to be in Jeff's PR.
• Regenerating JS docs picks up some formatting strays, but nothing related to this change.
• No diff in the JS client when I run yarn build (the docs say yarn dev but that isn't in package.json).

I'm fairly confident I checked all of those correctly but not 100%. So if this causes trouble down the line feel free to revert and @ me.

Also addressed your other comments :^)

[jeffchuber]

@beggers yep that PR cleans it up :)

[HammadB]

@beggers looks great! I'll merge after CI passes shortly.