Mention the API version bump in CONTRIBUTION.md #6436
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
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
|
Good idea, what we could also do is adding a pr template with a list of things one need to check. E.g.
So that people directly see what they need to take care when they submit the pr. What do you think @inventree/maintainer ? |
|
I am currently working on automated detections of API changes - #6269. If that triggers it will be an API bump |
Dauh, I should be looking around more deeply before creating PRs :D. |
|
A few lines in the docs won't hurt for sure - let's keep this one going. I think API automation should make it into 0.14.0 |
Yeah, but in this case you need to take care removing them when the automation will be implemented. |
|
The automation will just throw an error similar to the pre-commit CI for requirements |
|
Cheers @martonmiklos |
matmair
added a commit
to matmair/InvenTree
that referenced
this pull request
Feb 7, 2024
* Add basic task for generating apidocs * Fix SPECTACTULAR_SETTINGS - Some provided options were not correct * Update .gitignore * Fix for duplicated API path - `/api/plugins/activate` routed to PluginActivate view - Must be associated with a specific plugin ID * By default, fail if warnings are raised * Use GenericAPIView for GetAuthToken * Use GenericAPIView for RolesDetail endpoint * Refactor more endpoints to use GenericApiView * More API cleanup * Add extra type hints for exposed methods * Update RoleDetails endpoint - Specify serializer - Use RetrieveAPI class type * More type hints * Export API docs as part of CI * add more api views docs * even more docs * extend tests to api-version * simplify serializer * and more docs * fix serializer * added more API docs * clean diff * Added APISearch base * Mention the API version bump in CONTRIBUTION.md (inventree#6436) * Mention the API version bump in CONTRIBUTION.md * Update CONTRIBUTING.md --------- Co-authored-by: Oliver <oliver.henry.walters@gmail.com> * do not assume you know the user he might be anonymously creating the schema ;-) * set empty serializer where no input is needed * Fix for build.js (inventree#6437) - Catch potential empty build_detail attribute * Maintenance Mode Fix (inventree#6422) * Custom maintenance mode backend * Implement check and retries * Update debug formatting * Use dummy model for schema generation * fix OpenAPI docs section * Week number (inventree#6439) * Support week number for batch generation * Bug fix - hour is not minute * Update docs * only run if needed * remove schema task * Add version check * pin version * fix QC order * fix assign * refactor order * optimize compile times * fix assign * onyl use install * more fixing * use full update cycle * revert python change * use api_version * run py * why? * Fix for issue 6442 (inventree#6443) - Add null option to status field for stock adjustment - Prevent stock adjustments from setting status to OK * clean up output * only check for api version diff if api_version was not touched * add schema check again * Postgresql fix (inventree#6441) * Assume maintenance mode is *on* if database is inaccessible * Specify ash shell * Update psycopg requirements * Style fixes * style fix - backends.py * Update tasks.py (inventree#6446) * Update tasks.py - Exclude temporary settings when exporting data * Remove duplicate code * use seperate filter for API * increment api_version * Added push step --------- Co-authored-by: Oliver Walters <oliver.henry.walters@gmail.com> Co-authored-by: Miklós Márton <martonmiklosqdev@gmail.com>
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.
I had to lookup this again recently, so I think it has it's own place in the CONTRIBUTING.md
If necessary we can add more wording on what do we mean under API change?