Skip to content
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

Remove the tus chunk endpoints from the schema #5961

Merged
merged 4 commits into from
Apr 6, 2023

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Mar 31, 2023

Motivation and context

As explained in the comment in _tus_chunk_action, I don't think we need explicit documentation for these endpoints. Hiding them makes the documentation a bit cleaner, especially because these endpoints were indistinguishable from one another.

It also removes the corresponding SDK code, which is good, since clients should follow the URL returned by the creation endpoint, not invoke the chunk endpoints directly.

How has this been tested?

CI.

Checklist

  • I submit my changes into the develop branch
  • I have added a description of my changes into the CHANGELOG file
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@SpecLad
Copy link
Contributor Author

SpecLad commented Mar 31, 2023

/check

@github-actions
Copy link
Contributor

github-actions bot commented Mar 31, 2023

❌ Some checks failed
📄 See logs here

@SpecLad
Copy link
Contributor Author

SpecLad commented Mar 31, 2023

/check

@github-actions
Copy link
Contributor

github-actions bot commented Mar 31, 2023

✔️ All checks completed successfully
📄 See logs here

@SpecLad SpecLad marked this pull request as ready for review April 2, 2023 22:50
@SpecLad SpecLad requested a review from nmanovic as a code owner April 2, 2023 22:50
As explained in the comment in `_tus_chunk_action`, I don't think we need
explicit documentation for these endpoints. Hiding them makes the
documentation a bit cleaner, especially because these endpoints were
indistinguishable from one another.

It also removes the corresponding SDK code, which is good, since clients
should follow the URL returned by the creation endpoint, not invoke the
chunk endpoints directly.
`serializers` -> `view_utils` -> `mixins` -> `serializers`

The `serializers` -> `view_utils` dependency seemed like the most wrong one
to me (serializers are not views, so they shouldn't depend on view
utilities), so I broke it up by moving some stuff to `utils`.
@SpecLad SpecLad merged commit 57b8766 into cvat-ai:develop Apr 6, 2023
@SpecLad SpecLad deleted the hide-tus branch April 6, 2023 13:28
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Jul 1, 2023
As explained in the comment in `_tus_chunk_action`, I don't think we
need explicit documentation for these endpoints. Hiding them makes the
documentation a bit cleaner, especially because these endpoints were
indistinguishable from one another.

It also removes the corresponding SDK code, which is good, since clients
should follow the URL returned by the creation endpoint, not invoke the
chunk endpoints directly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants