Fix SDK documentation problems #5903
Merged
+165
−31
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
SpecLad
reviewed
Mar 22, 2023
cvat-sdk/gen/templates/openapi-generator/api_doc_example.mustache
Outdated
Show resolved
Hide resolved
zhiltsov-max
changed the title
zhiltsov-max
changed the title
SpecLad
approved these changes
Mar 23, 2023
|
I've extended the return type info and info about extra parameters. |
SpecLad
requested changes
Mar 23, 2023
Co-authored-by: Roman Donchenko <roman@cvat.ai>
SpecLad
approved these changes
Mar 23, 2023
2 tasks
mikhail-treskin
pushed a commit
to retailnext/cvat
that referenced
this pull request
Jul 1, 2023
Resolves cvat-ai#5871 Related: cvat-ai#5847, cvat-ai#5814 This PR makes SDK examples valid Python code and adds some missing info. - Fixed incorrect method names in examples - Added missing `api_client.` use in method examples - Fixed invalid return types in examples - Fixed imports in examples - Added notes about binary files in low-level API, extra method args and returned values - Removed html escapes from method and field descriptions - Changed function signatures to be closer to the most popular variants
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.
Motivation and context
Resolves #5871
Related: #5847, #5814
This PR makes SDK examples valid Python code and adds some missing info.
api_client.use in method examplesHow has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.