mirror of
				https://github.com/inventree/InvenTree.git
				synced 2025-11-04 07:05:41 +00:00 
			
		
		
		
	Move API version information into a new file
- Keeping track of the API version history was making for a very long file!
This commit is contained in:
		
							
								
								
									
										149
									
								
								InvenTree/InvenTree/api_version.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										149
									
								
								InvenTree/InvenTree/api_version.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,149 @@
 | 
				
			|||||||
 | 
					"""
 | 
				
			||||||
 | 
					InvenTree API version information
 | 
				
			||||||
 | 
					"""
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# InvenTree API version
 | 
				
			||||||
 | 
					INVENTREE_API_VERSION = 40
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					"""
 | 
				
			||||||
 | 
					Increment this API version number whenever there is a significant change to the API that any clients need to know about
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v40 -> 2022-04-19
 | 
				
			||||||
 | 
					    - Adds ability to filter StockItem list by "tracked" parameter
 | 
				
			||||||
 | 
					        - This checks the serial number or batch code fields
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v39 -> 2022-04-18
 | 
				
			||||||
 | 
					    - Adds ability to filter StockItem list by "has_batch" parameter
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v38 -> 2022-04-14 : https://github.com/inventree/InvenTree/pull/2828
 | 
				
			||||||
 | 
					    - Adds the ability to include stock test results for "installed items"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v37 -> 2022-04-07 : https://github.com/inventree/InvenTree/pull/2806
 | 
				
			||||||
 | 
					    - Adds extra stock availability information to the BomItem serializer
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v36 -> 2022-04-03
 | 
				
			||||||
 | 
					    - Adds ability to filter part list endpoint by unallocated_stock argument
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v35 -> 2022-04-01 : https://github.com/inventree/InvenTree/pull/2797
 | 
				
			||||||
 | 
					    - Adds stock allocation information to the Part API
 | 
				
			||||||
 | 
					    - Adds calculated field for "unallocated_quantity"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v34 -> 2022-03-25
 | 
				
			||||||
 | 
					    - Change permissions for "plugin list" API endpoint (now allows any authenticated user)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v33 -> 2022-03-24
 | 
				
			||||||
 | 
					    - Adds "plugins_enabled" information to root API endpoint
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v32 -> 2022-03-19
 | 
				
			||||||
 | 
					    - Adds "parameters" detail to Part API endpoint (use ¶meters=true)
 | 
				
			||||||
 | 
					    - Adds ability to filter PartParameterTemplate API by Part instance
 | 
				
			||||||
 | 
					    - Adds ability to filter PartParameterTemplate API by PartCategory instance
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v31 -> 2022-03-14
 | 
				
			||||||
 | 
					    - Adds "updated" field to SupplierPriceBreakList and SupplierPriceBreakDetail API endpoints
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v30 -> 2022-03-09
 | 
				
			||||||
 | 
					    - Adds "exclude_location" field to BuildAutoAllocation API endpoint
 | 
				
			||||||
 | 
					    - Allows BuildItem API endpoint to be filtered by BomItem relation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v29 -> 2022-03-08
 | 
				
			||||||
 | 
					    - Adds "scheduling" endpoint for predicted stock scheduling information
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v28 -> 2022-03-04
 | 
				
			||||||
 | 
					    - Adds an API endpoint for auto allocation of stock items against a build order
 | 
				
			||||||
 | 
					    - Ref: https://github.com/inventree/InvenTree/pull/2713
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v27 -> 2022-02-28
 | 
				
			||||||
 | 
					    - Adds target_date field to individual line items for purchase orders and sales orders
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v26 -> 2022-02-17
 | 
				
			||||||
 | 
					    - Adds API endpoint for uploading a BOM file and extracting data
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v25 -> 2022-02-17
 | 
				
			||||||
 | 
					    - Adds ability to filter "part" list endpoint by "in_bom_for" argument
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v24 -> 2022-02-10
 | 
				
			||||||
 | 
					    - Adds API endpoint for deleting (cancelling) build order outputs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v23 -> 2022-02-02
 | 
				
			||||||
 | 
					    - Adds API endpoints for managing plugin classes
 | 
				
			||||||
 | 
					    - Adds API endpoints for managing plugin settings
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v22 -> 2021-12-20
 | 
				
			||||||
 | 
					    - Adds API endpoint to "merge" multiple stock items
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v21 -> 2021-12-04
 | 
				
			||||||
 | 
					    - Adds support for multiple "Shipments" against a SalesOrder
 | 
				
			||||||
 | 
					    - Refactors process for stock allocation against a SalesOrder
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v20 -> 2021-12-03
 | 
				
			||||||
 | 
					    - Adds ability to filter POLineItem endpoint by "base_part"
 | 
				
			||||||
 | 
					    - Adds optional "order_detail" to POLineItem list endpoint
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v19 -> 2021-12-02
 | 
				
			||||||
 | 
					    - Adds the ability to filter the StockItem API by "part_tree"
 | 
				
			||||||
 | 
					    - Returns only stock items which match a particular part.tree_id field
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v18 -> 2021-11-15
 | 
				
			||||||
 | 
					    - Adds the ability to filter BomItem API by "uses" field
 | 
				
			||||||
 | 
					    - This returns a list of all BomItems which "use" the specified part
 | 
				
			||||||
 | 
					    - Includes inherited BomItem objects
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v17 -> 2021-11-09
 | 
				
			||||||
 | 
					    - Adds API endpoints for GLOBAL and USER settings objects
 | 
				
			||||||
 | 
					    - Ref: https://github.com/inventree/InvenTree/pull/2275
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v16 -> 2021-10-17
 | 
				
			||||||
 | 
					    - Adds API endpoint for completing build order outputs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v15 -> 2021-10-06
 | 
				
			||||||
 | 
					    - Adds detail endpoint for SalesOrderAllocation model
 | 
				
			||||||
 | 
					    - Allows use of the API forms interface for adjusting SalesOrderAllocation objects
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v14 -> 2021-10-05
 | 
				
			||||||
 | 
					    - Stock adjustment actions API is improved, using native DRF serializer support
 | 
				
			||||||
 | 
					    - However adjustment actions now only support 'pk' as a lookup field
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v13 -> 2021-10-05
 | 
				
			||||||
 | 
					    - Adds API endpoint to allocate stock items against a BuildOrder
 | 
				
			||||||
 | 
					    - Updates StockItem API with improved filtering against BomItem data
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v12 -> 2021-09-07
 | 
				
			||||||
 | 
					    - Adds API endpoint to receive stock items against a PurchaseOrder
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v11 -> 2021-08-26
 | 
				
			||||||
 | 
					    - Adds "units" field to PartBriefSerializer
 | 
				
			||||||
 | 
					    - This allows units to be introspected from the "part_detail" field in the StockItem serializer
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v10 -> 2021-08-23
 | 
				
			||||||
 | 
					    - Adds "purchase_price_currency" to StockItem serializer
 | 
				
			||||||
 | 
					    - Adds "purchase_price_string" to StockItem serializer
 | 
				
			||||||
 | 
					    - Purchase price is now writable for StockItem serializer
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v9  -> 2021-08-09
 | 
				
			||||||
 | 
					    - Adds "price_string" to part pricing serializers
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v8  -> 2021-07-19
 | 
				
			||||||
 | 
					    - Refactors the API interface for SupplierPart and ManufacturerPart models
 | 
				
			||||||
 | 
					    - ManufacturerPart objects can no longer be created via the SupplierPart API endpoint
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v7  -> 2021-07-03
 | 
				
			||||||
 | 
					    - Introduced the concept of "API forms" in https://github.com/inventree/InvenTree/pull/1716
 | 
				
			||||||
 | 
					    - API OPTIONS endpoints provide comprehensive field metedata
 | 
				
			||||||
 | 
					    - Multiple new API endpoints added for database models
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v6  -> 2021-06-23
 | 
				
			||||||
 | 
					    - Part and Company images can now be directly uploaded via the REST API
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v5  -> 2021-06-21
 | 
				
			||||||
 | 
					    - Adds API interface for manufacturer part parameters
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v4  -> 2021-06-01
 | 
				
			||||||
 | 
					    - BOM items can now accept "variant stock" to be assigned against them
 | 
				
			||||||
 | 
					    - Many slight API tweaks were needed to get this to work properly!
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					v3  -> 2021-05-22:
 | 
				
			||||||
 | 
					    - The updated StockItem "history tracking" now uses a different interface
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					"""
 | 
				
			||||||
@@ -1,4 +1,5 @@
 | 
				
			|||||||
""" Version information for InvenTree.
 | 
					"""
 | 
				
			||||||
 | 
					Version information for InvenTree.
 | 
				
			||||||
Provides information on the current InvenTree version
 | 
					Provides information on the current InvenTree version
 | 
				
			||||||
"""
 | 
					"""
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -8,150 +9,11 @@ import re
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
import common.models
 | 
					import common.models
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					from InvenTree.api_version import INVENTREE_API_VERSION
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# InvenTree software version
 | 
					# InvenTree software version
 | 
				
			||||||
INVENTREE_SW_VERSION = "0.7.0 dev"
 | 
					INVENTREE_SW_VERSION = "0.7.0 dev"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# InvenTree API version
 | 
					 | 
				
			||||||
INVENTREE_API_VERSION = 39
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
"""
 | 
					 | 
				
			||||||
Increment this API version number whenever there is a significant change to the API that any clients need to know about
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v39 -> 2022-04-18
 | 
					 | 
				
			||||||
    - Adds ability to filter StockItem list by "has_batch" parameter
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v38 -> 2022-04-14 : https://github.com/inventree/InvenTree/pull/2828
 | 
					 | 
				
			||||||
    - Adds the ability to include stock test results for "installed items"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v37 -> 2022-04-07 : https://github.com/inventree/InvenTree/pull/2806
 | 
					 | 
				
			||||||
    - Adds extra stock availability information to the BomItem serializer
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v36 -> 2022-04-03
 | 
					 | 
				
			||||||
    - Adds ability to filter part list endpoint by unallocated_stock argument
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v35 -> 2022-04-01 : https://github.com/inventree/InvenTree/pull/2797
 | 
					 | 
				
			||||||
    - Adds stock allocation information to the Part API
 | 
					 | 
				
			||||||
    - Adds calculated field for "unallocated_quantity"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v34 -> 2022-03-25
 | 
					 | 
				
			||||||
    - Change permissions for "plugin list" API endpoint (now allows any authenticated user)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v33 -> 2022-03-24
 | 
					 | 
				
			||||||
    - Adds "plugins_enabled" information to root API endpoint
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v32 -> 2022-03-19
 | 
					 | 
				
			||||||
    - Adds "parameters" detail to Part API endpoint (use ¶meters=true)
 | 
					 | 
				
			||||||
    - Adds ability to filter PartParameterTemplate API by Part instance
 | 
					 | 
				
			||||||
    - Adds ability to filter PartParameterTemplate API by PartCategory instance
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v31 -> 2022-03-14
 | 
					 | 
				
			||||||
    - Adds "updated" field to SupplierPriceBreakList and SupplierPriceBreakDetail API endpoints
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v30 -> 2022-03-09
 | 
					 | 
				
			||||||
    - Adds "exclude_location" field to BuildAutoAllocation API endpoint
 | 
					 | 
				
			||||||
    - Allows BuildItem API endpoint to be filtered by BomItem relation
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v29 -> 2022-03-08
 | 
					 | 
				
			||||||
    - Adds "scheduling" endpoint for predicted stock scheduling information
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v28 -> 2022-03-04
 | 
					 | 
				
			||||||
    - Adds an API endpoint for auto allocation of stock items against a build order
 | 
					 | 
				
			||||||
    - Ref: https://github.com/inventree/InvenTree/pull/2713
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v27 -> 2022-02-28
 | 
					 | 
				
			||||||
    - Adds target_date field to individual line items for purchase orders and sales orders
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v26 -> 2022-02-17
 | 
					 | 
				
			||||||
    - Adds API endpoint for uploading a BOM file and extracting data
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v25 -> 2022-02-17
 | 
					 | 
				
			||||||
    - Adds ability to filter "part" list endpoint by "in_bom_for" argument
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v24 -> 2022-02-10
 | 
					 | 
				
			||||||
    - Adds API endpoint for deleting (cancelling) build order outputs
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v23 -> 2022-02-02
 | 
					 | 
				
			||||||
    - Adds API endpoints for managing plugin classes
 | 
					 | 
				
			||||||
    - Adds API endpoints for managing plugin settings
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v22 -> 2021-12-20
 | 
					 | 
				
			||||||
    - Adds API endpoint to "merge" multiple stock items
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v21 -> 2021-12-04
 | 
					 | 
				
			||||||
    - Adds support for multiple "Shipments" against a SalesOrder
 | 
					 | 
				
			||||||
    - Refactors process for stock allocation against a SalesOrder
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v20 -> 2021-12-03
 | 
					 | 
				
			||||||
    - Adds ability to filter POLineItem endpoint by "base_part"
 | 
					 | 
				
			||||||
    - Adds optional "order_detail" to POLineItem list endpoint
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v19 -> 2021-12-02
 | 
					 | 
				
			||||||
    - Adds the ability to filter the StockItem API by "part_tree"
 | 
					 | 
				
			||||||
    - Returns only stock items which match a particular part.tree_id field
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v18 -> 2021-11-15
 | 
					 | 
				
			||||||
    - Adds the ability to filter BomItem API by "uses" field
 | 
					 | 
				
			||||||
    - This returns a list of all BomItems which "use" the specified part
 | 
					 | 
				
			||||||
    - Includes inherited BomItem objects
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v17 -> 2021-11-09
 | 
					 | 
				
			||||||
    - Adds API endpoints for GLOBAL and USER settings objects
 | 
					 | 
				
			||||||
    - Ref: https://github.com/inventree/InvenTree/pull/2275
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v16 -> 2021-10-17
 | 
					 | 
				
			||||||
    - Adds API endpoint for completing build order outputs
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v15 -> 2021-10-06
 | 
					 | 
				
			||||||
    - Adds detail endpoint for SalesOrderAllocation model
 | 
					 | 
				
			||||||
    - Allows use of the API forms interface for adjusting SalesOrderAllocation objects
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v14 -> 2021-10-05
 | 
					 | 
				
			||||||
    - Stock adjustment actions API is improved, using native DRF serializer support
 | 
					 | 
				
			||||||
    - However adjustment actions now only support 'pk' as a lookup field
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v13 -> 2021-10-05
 | 
					 | 
				
			||||||
    - Adds API endpoint to allocate stock items against a BuildOrder
 | 
					 | 
				
			||||||
    - Updates StockItem API with improved filtering against BomItem data
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v12 -> 2021-09-07
 | 
					 | 
				
			||||||
    - Adds API endpoint to receive stock items against a PurchaseOrder
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v11 -> 2021-08-26
 | 
					 | 
				
			||||||
    - Adds "units" field to PartBriefSerializer
 | 
					 | 
				
			||||||
    - This allows units to be introspected from the "part_detail" field in the StockItem serializer
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v10 -> 2021-08-23
 | 
					 | 
				
			||||||
    - Adds "purchase_price_currency" to StockItem serializer
 | 
					 | 
				
			||||||
    - Adds "purchase_price_string" to StockItem serializer
 | 
					 | 
				
			||||||
    - Purchase price is now writable for StockItem serializer
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v9  -> 2021-08-09
 | 
					 | 
				
			||||||
    - Adds "price_string" to part pricing serializers
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v8  -> 2021-07-19
 | 
					 | 
				
			||||||
    - Refactors the API interface for SupplierPart and ManufacturerPart models
 | 
					 | 
				
			||||||
    - ManufacturerPart objects can no longer be created via the SupplierPart API endpoint
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v7  -> 2021-07-03
 | 
					 | 
				
			||||||
    - Introduced the concept of "API forms" in https://github.com/inventree/InvenTree/pull/1716
 | 
					 | 
				
			||||||
    - API OPTIONS endpoints provide comprehensive field metedata
 | 
					 | 
				
			||||||
    - Multiple new API endpoints added for database models
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v6  -> 2021-06-23
 | 
					 | 
				
			||||||
    - Part and Company images can now be directly uploaded via the REST API
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v5  -> 2021-06-21
 | 
					 | 
				
			||||||
    - Adds API interface for manufacturer part parameters
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v4  -> 2021-06-01
 | 
					 | 
				
			||||||
    - BOM items can now accept "variant stock" to be assigned against them
 | 
					 | 
				
			||||||
    - Many slight API tweaks were needed to get this to work properly!
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
v3  -> 2021-05-22:
 | 
					 | 
				
			||||||
    - The updated StockItem "history tracking" now uses a different interface
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
"""
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
def inventreeInstanceName():
 | 
					def inventreeInstanceName():
 | 
				
			||||||
    """ Returns the InstanceName settings for the current database """
 | 
					    """ Returns the InstanceName settings for the current database """
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user