🧑💻 Iterate over detectors API to include multiple endpoints #40
Conversation
This file contains hidden or 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
Signed-off-by: gkumbhat <[email protected]>
evaline-ju
reviewed
May 22, 2024
docs/api/openapi_detector_api.yaml
Outdated
| - type | ||
| - loc | ||
| - msg | ||
| - type |
There was a problem hiding this comment.
If we're expecting detectors to give these validation errors I think we should revisit this, since this "loc", "type" concept is based on FastAPI and may not make sense generally for most detector servers
docs/api/openapi_detector_api.yaml
Outdated
| role: | ||
| allOf: | ||
| - $ref: '#/components/schemas/RoleEnum' | ||
| description: 'Who wrote the message: [<enum ''RoleEnum''>]' |
There was a problem hiding this comment.
Based on this description I would think something like author may be more appropriate? "Role" of a message seems a bit open-ended, like "what is the role of this message?" e.g. persuasion. Or perhaps the description may need to be more specific?
Signed-off-by: gkumbhat <[email protected]>
evaline-ju
reviewed
May 22, 2024
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Error' | ||
| /api/v1/text/context/doc: |
There was a problem hiding this comment.
Could we potentially add in the summary and/or description how doc plays into this endpoint?
…tion example Signed-off-by: gkumbhat <[email protected]>
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.
Changes
Note: API is still in iteration and we will update the orchestrator client once its finalized / stable in story #37