feat: Update API for OpenAPI compliance #2866
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
anticorrelator
commented
Apr 11, 2024
•
anticorrelator
commented
- Preserves existing API behavior, but adds an OpenAPI spec which better follows REST conventions
dosubot
bot
added
the
size:XL
anticorrelator
changed the title
mikeldking
reviewed
Apr 12, 2024
|
Put deprecated flags on the get calls |
Flesh out V2 API Lint and clean up type annotations
Remove busywait Swap out v2 routes for v1 routes! Update Client API usage Fill out get_spans body schema Change reading spans from GET to POST Update tests for new `/spans` route method Update more tests for new `/spans` route method
mikeldking
force-pushed
the
dustin/openapi-compliance-with-persistence
branch
from
aa6fe6f to
8567699
Compare
anticorrelator
changed the title
mikeldking
reviewed
Apr 12, 2024
Comment on lines
+66
to
+67
| # read from headers for backwards compatibility | ||
| or request.headers.get("project-name") |
There was a problem hiding this comment.
is it possible to write a small thest for this?
mikeldking
reviewed
Apr 12, 2024
Comment on lines
6
to
10
| Route("/v1/evaluations", evaluations.post_evaluation, methods=["POST"]), | ||
| Route("/v1/evaluations", evaluations.get_evaluations, methods=["GET"]), | ||
| Route("/v1/traces", traces.post_traces, methods=["POST"]), | ||
| Route("/v1/spans", spans.query_spans_handler, methods=["POST"]), | ||
| Route("/v1/spans", spans.get_spans_handler, methods=["GET"]), |
There was a problem hiding this comment.
Is there no nested routing? NBD, just curious.
There was a problem hiding this comment.
I'm not sure everything we can accomplish here, this was the pattern I saw recommended to use Starlette's OpenAPI APISpec mechanism, since we want a separate function for each route
mikeldking
requested changes
Apr 12, 2024
|
|
||
| async def get_evaluations(request: Request) -> Response: | ||
| """ | ||
| summary: Get evaluations from Phoenix |
There was a problem hiding this comment.
Suggested change
| summary: Get evaluations from Phoenix | |
| summary: Get evaluations for a given project |
| @@ -183,13 +183,13 @@ def log_evaluations(self, *evals: Evaluations, project_name: Optional[str] = Non | |||
| table = evaluation.to_pyarrow_table() | |||
| sink = pa.BufferOutputStream() | |||
| headers = {"content-type": "application/x-pandas-arrow"} | |||
| if project_name: | |||
| headers["project-name"] = project_name | |||
| params = {"project-name": project_name} | |||
There was a problem hiding this comment.
Did you test this? because I think it's _ in other places.
There was a problem hiding this comment.
yep, replacing with project-name everywhere
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.