-
-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Various API model fixes #403
Merged
Merged
+28
−17
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
Previously, probably due to copy and pasting, the `/v2/stats/text/totals` endpoint published in the swagger doc that returned elements were of type `SinglePeriodImgStat`, which could be a source of confusion when consuming the swagger doc.
This accurately reflects that it is a required field for creating a `ExtraSourceImage`
SinglePeriodTxtStat
for text totals stat endpointSinglePeriodTxtStat
for text totals stat endpoint; fix: min_length
for ExtraSourceImage
SinglePeriodTxtStat
for text totals stat endpoint; fix: min_length
for ExtraSourceImage
LGTM until now |
While this endpoint *should* return a single value, in reality it does (and probably always has) actually return a list of a single element instead. Because changing the actual return value constitutes a breaking change, I recommend simply fixing the API doc for now and changing it to the (presumably) intended type when we go to `/v3/`.
This missing dependency prevents a good portion of the network-based and API-call-based SDK tests from running.
@db0 Please review these changes at your convenience. Nothing should be a breaking change but you if you have any concerns please feel free to raise them. Otherwise, please merge and deploy when you are willing. A pending SDK change would benefit in testing against production with the changes in this PR. |
Merged
7 tasks
tazlin
added a commit
to Haidra-Org/horde-sdk
that referenced
this pull request
May 9, 2024
See Haidra-Org/AI-Horde#403 for more information.
tazlin
added a commit
to Haidra-Org/horde-sdk
that referenced
this pull request
May 22, 2024
See Haidra-Org/AI-Horde#403 for more information.
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.
In the course of expanding the SDK, certain inconsistencies were made apparent. This PR serves to correct the issues.
/v2/stats/text/totals
endpoint published in the swagger doc that returned elements were of typeSinglePeriodImgStat
, which could be a source of confusion when consuming the swagger doc./v2/stats/img/totals
returns elements with different attributes, so this PR hopefully will clarify that the two endpoints return two different types of objects.ExtraSourceImage
PUT
action of/v2/status/modes
. For clarity (and ease of object/model reuse client-side) I am changing the payload argument names to match. This is a breaking change, but as only admins (i.e., you) can use it, I think it is safe to do so./v3/
.pytest-asyncio
as a reqs.dev.txt dependency.