203 Commits

Author SHA1 Message Date
YueGuobin
2e4c42fadc feat(api): clarify default LLM model config selection logic
- Update API documentation to explicitly describe default configuration selection logic
- Add fallback behavior in repository to use first config when no default is marked
- Clarify difference between `/default` endpoint and `default_config` field
- Document that `default_config` is never null when configs list is not empty
2026-03-03 22:27:28 +08:00
YueGuobin
b06593cf2a feat(docs): add default config endpoints and clarify config inheritance
- Add `/default` endpoints for users and groups to retrieve default LLM model configurations
- Update documentation to clarify that users receive both own and inherited configurations
- Improve response examples to show combined configs with source field
- Add 404 response example for missing default configurations
- Fix optimistic locking documentation formatting
2026-03-03 22:15:17 +08:00
YueGuobin
d42fff49a5 feat(docs): enhance LLM model configs API documentation with schema updates
- Add `model_type` field to database schema with supported values (text, vision, stt, tts, multimodal, embedding, reranking, other)
- Add `name` field as table-level column for indexing and filtering
- Add reserved JSONB fields for future extensibility
- Update API request/response schemas to include `model_type` and `name` fields
- Add new `LLMModelConfigWithSource` schema for detailed configuration responses
- Update usage examples to reflect new required fields
- Improve database constraints and indexing documentation
2026-03-03 17:54:30 +08:00
YueGuobin
b968920a75 feat(docs): add optimistic locking documentation for LLM model configs API
Add comprehensive documentation for optimistic locking implementation in the LLM model configurations API. The update includes:

- Added "Optimistic Locking" feature to the overview section
- Added `version` field to the database schema table
- Updated `LLMModelConfigUpdate` schema to include `expected_version` parameter
- Updated `LLMModelConfigResponse` schema to include `version` field
- Added detailed examples for update operations with optimistic locking
- Included conflict handling workflow and client retry instructions

This documentation ensures users understand how to prevent concurrent modification conflicts when updating LLM model configurations.
2026-03-03 17:39:04 +08:00
YueGuobin
bbd34f1f67 feat(api): add LLM model configurations endpoint and schemas
- Introduce new API route `/access` for managing LLM model configurations
- Add LLMModelConfig model to database models
- Include comprehensive schemas for LLM model config CRUD operations
- Register new router with tags for LLM Model Configurations
2026-03-03 16:34:48 +08:00
grossmj
d6f8069739
Remove files from 2.2 doc 2024-01-28 13:03:06 +11:00
grossmj
0037f31553
Merge branch '2.2' into 3.0
# Conflicts:
#	CHANGELOG
#	docs/api/notifications/link.updated.json
#	docs/api/notifications/log.warning.json
#	docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst
#	docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst
#	docs/api/v2/compute/iou/projectsprojectidiounodes.rst
#	docs/api/v2/compute/project/projects.rst
#	docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst
#	docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
#	docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst
#	docs/api/v2/controller/link/projectsprojectidlinks.rst
#	docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
#	docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
#	docs/api/v2/controller/project/projects.rst
#	docs/api/v2/controller/project/projectsprojectidduplicate.rst
#	docs/controller_notifications.rst
#	docs/curl.rst
#	docs/gns3_file.json
#	docs/project_notifications.rst
#	gns3server/compute/qemu/qemu_vm.py
#	gns3server/controller/project.py
#	gns3server/crash_report.py
#	gns3server/schemas/ethernet_hub.py
#	gns3server/schemas/ethernet_switch.py
#	gns3server/static/web-ui/3rdpartylicenses.txt
#	gns3server/static/web-ui/index.html
#	gns3server/utils/asyncio/telnet_server.py
#	gns3server/version.py
#	gns3server/web/web_server.py
#	requirements.txt
#	tests/controller/test_project.py
#	tests/controller/test_topology.py
#	tests/handlers/api/controller/test_project.py
2024-01-28 12:30:43 +11:00
grossmj
218522b08c
Fix issues when generating docs 2024-01-28 12:13:10 +11:00
grossmj
8d160ad5ed
Update documentation 2024-01-28 12:13:10 +11:00
grossmj
30d6f1fa2a Make Swagger Ui the default for API documentation 2020-11-02 12:47:59 +10:30
grossmj
b2d81609be Publish API documentation 2020-10-24 16:32:09 +10:30
grossmj
ee6c70e243 Publish API documentation 2020-10-24 16:16:29 +10:30
github-actions
7d72b5e8b9 Publish API documentation 2020-10-23 09:13:49 +00:00
github-actions
3a55337d3f Publish API documentation 2020-10-23 08:52:41 +00:00
Jeremy Grossmann
407f6efa78 Create CNAME 2020-10-23 18:49:37 +10:30
grossmj
3185ebaa3d Publish API documentation generated by FastAPI. 2020-10-23 18:01:58 +10:30
eknoes
f53d6f1b66
Fix link for appliance JSON schema 2020-06-03 13:46:48 +02:00
Brian Candler
69986b0d0f Correct typo "Snasphot" 2020-04-15 09:46:45 +01:00
grossmj
c52abd973e Sync documentation 2020-01-08 10:52:15 +08:00
grossmj
c8f7d789f7 Update API documentation 2019-10-23 22:00:00 +08:00
grossmj
22854f1baa Refresh documentation 2019-03-30 15:56:26 +07:00
grossmj
5045c6cfbf Update documentation 2019-03-28 17:24:02 +08:00
grossmj
d7c2e16c21 Use "template" to name what we use to create new nodes. 2018-11-28 16:12:58 +07:00
grossmj
21c0a35f77 Use project instead of topology where appropriate. 2018-11-27 18:30:16 +07:00
grossmj
a17fa821bd Make sure nothing is named "compute server". 2018-11-27 18:14:51 +07:00
grossmj
2e79da5fe1 Fix broken examples in API documentation. 2018-11-20 16:24:59 +07:00
grossmj
4e2b8bfe7c Add more information about appliances to the API documentation. 2018-11-20 16:21:33 +07:00
grossmj
1289d20a14 Add missing files for API documentation. 2018-11-20 15:19:44 +07:00
grossmj
ff5ba3742e Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630 2018-11-20 13:04:27 +07:00
grossmj
1e33e94c15 Add missing doc pages. 2018-08-16 21:50:54 +07:00
grossmj
8699f2e2b0 Update docs for controller_notifications and project_notifications. 2018-08-16 21:40:51 +07:00
grossmj
7f72b90b0e The server has now 2 notification streams
* A new one for controller related events (compute, appliance templates etc.)
* The existing one for project related events (links, nodes etc.)
2018-08-16 21:31:57 +07:00
grossmj
033f005bde Merge branch '2.1' into 2.2
# Conflicts:
#	gns3server/compute/docker/docker_vm.py
#	gns3server/version.py
2018-08-07 21:06:42 +07:00
grossmj
0f496907a0 Fix API status code for start/stop/suspend/reload a node. Fixes #1353.
Fix issues with test.
Update documentation.
2018-06-14 16:39:32 +08:00
grossmj
96d5e351f7 Merge branch '2.1' into 2.2
# Conflicts:
#	gns3server/version.py
#	requirements.txt
2018-06-10 21:19:55 +07:00
Bernhard Ehlers
60a3ab87dc Update API documentation 2018-06-07 10:26:06 +02:00
grossmj
ea0009db6c Save state feature for VirtualBox and VMware. New "On close" setting to
select the action to execute when closing/stopping a Qemu/VirtualBox/VMware VM.
2018-03-30 21:18:44 +07:00
grossmj
658aa4bae9 Merge 2.1 into 2.2 branch 2018-03-12 13:38:50 +07:00
grossmj
07d2d7b340 Update documentation. 2018-01-31 23:37:02 +07:00
Bernhard Ehlers
e6d2bd4424 Update API documentation 2018-01-08 09:26:44 +01:00
grossmj
ffe21f6b73 Update API documentation. Fixes #1253. 2018-01-08 11:57:07 +07:00
Julien Duponchelle
08423eff96
Support packet filtering for VPCS
https://github.com/GNS3/gns3-gui/issues/765
2017-07-04 15:12:26 +02:00
Julien Duponchelle
8f72356bab
Rebuild the documentation 2017-06-29 17:14:46 +02:00
Julien Duponchelle
9dc6f0f486 Embed the appliances in the server. (#927)
This add a /appliances call
2017-04-12 14:35:49 +02:00
Julien Duponchelle
4f1b738ef5
Merge branch '2.0' into 2.1 2017-03-30 10:16:16 +02:00
Julien Duponchelle
73c31b4b87
Update docs 2017-03-21 13:32:04 +01:00
Julien Duponchelle
c608a4ab38
Remove port name format documentation (moved to docs.gns3.com) 2017-03-21 10:30:33 +01:00
Julien Duponchelle
6017ebbd97
Merge branch '2.0' into 2.1 2017-03-07 11:16:05 +01:00
Julien Duponchelle
54131bc9bb
Update the documentation 2017-03-06 14:35:39 +01:00
Julien Duponchelle
e892e5dfab
Manage base configuration on server
Fix #786
2017-02-03 13:19:14 +01:00