mirror of
				https://github.com/inventree/InvenTree.git
				synced 2025-11-04 07:05:41 +00:00 
			
		
		
		
	Render API docs (#6463)
* Render API docs
* Cleanup broken links
* Re-enable strict mode
* Change json to yaml
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Use neoteroi-mkdocs instead
- seems to render more reliably
* Fix SERVERS section for SPECTACTULAR_SETTINGS
* Script for splitting schema into smaller sections
* Generate an index file for the schema pages
* Move schema.md up one directory
* Fix formatting
* Remove tracked file
* Add hook for rebuilding API schema as part of RTD build
* Extract schema as RTD build step
* install invoke
* export env vars
* remove argparse
* Fix order of operations
* Compress env vars
* Remove custom env vars
- Now configured as part of RTD project
* Migrate db
* Revert "remove argparse"
This reverts commit 4665805340.
* Post-process generated schema file
* Fix file formatting
* Add note about schema repo
* no message
* Reduce schema overhead
* Ignore generated files
* Delete generated file
* Update .gitignore
* Add extra split for machine integration
* Remove schema files
- These will be auto-generated too
* Generate individual schema .md files
* Re-add .md files
- Need git commit log to work
* Update .gitignore
* Fix for CI test
* patch machine.api
* Revert previous change
* Formatting fix
* Adjust export step
* Bump API version
---------
Co-authored-by: Matthias Mair <code@mjmair.com>
			
			
This commit is contained in:
		
							
								
								
									
										4
									
								
								.github/workflows/qc_checks.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/qc_checks.yaml
									
									
									
									
										vendored
									
									
								
							@@ -144,7 +144,7 @@ jobs:
 | 
			
		||||
          dev-install: true
 | 
			
		||||
          update: true
 | 
			
		||||
      - name: Export API Documentation
 | 
			
		||||
        run: invoke schema --ignore-warnings
 | 
			
		||||
        run: invoke schema --ignore-warnings --filename InvenTree/schema.yml
 | 
			
		||||
      - name: Upload schema
 | 
			
		||||
        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # pin@v3.1.3
 | 
			
		||||
        with:
 | 
			
		||||
@@ -160,7 +160,7 @@ jobs:
 | 
			
		||||
          echo "URL: $url"
 | 
			
		||||
          curl -s -o api.yaml $url
 | 
			
		||||
          echo "Downloaded api.yaml"
 | 
			
		||||
      - name: Check for differences in schemas
 | 
			
		||||
      - name: Check for differences in API Schema
 | 
			
		||||
        if: needs.paths-filter.outputs.api == 'false'
 | 
			
		||||
        run: |
 | 
			
		||||
          diff --color -u InvenTree/schema.yml api.yaml
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user