Commit graph

185 commits

Author SHA1 Message Date
Ad Schellevis
37119d5626 collect_api_endpoints.py - skip empty endpoints (unknown contents) 2025-05-06 12:41:50 +02:00
Ad Schellevis
ed4048d011 change Action.method to Action.methods as this can be a list of (unique) options. for https://github.com/opnsense/docs/pull/713 2025-05-04 17:04:43 +02:00
Freddie Sackur
dfcf9f3aeb
Note about menu cache file (#711)
* dev doc: note about menu cache file

* dev doc: note about ACL cache file

* dev doc: remove mention of version from notes about UI caching
2025-05-04 13:23:58 +02:00
Ad Schellevis
f44b9b32ea api doc: fix method sort order 2025-05-01 13:06:32 +02:00
Ad Schellevis
e8d878d186 api update: plugins 2025-05-01 10:05:15 +02:00
Ad Schellevis
dedf145f2f api update: core 2025-05-01 10:03:43 +02:00
Ad Schellevis
02823b6055 collect_api_endpoints.py: refactor and split extraction logic, uses a lexer now to aase further extensions. 2025-05-01 09:58:59 +02:00
Ad Schellevis
83d9aa86c4 development/api - camel to snake case for commands and update endpoints. 2025-04-29 20:03:20 +02:00
Monviech
604b71fcde
api: Guide how to use browser console to inspect API (#694) 2025-04-14 10:11:19 +02:00
Ad Schellevis
7eaec85f51 backend/configd - update for https://github.com/opnsense/core/issues/8525 amd add missing streaming type 2025-04-10 08:40:19 +02:00
Franco Fichtner
c0cc48032a development: adjust for monitor facility argument 2025-03-25 14:20:49 +01:00
Franco Fichtner
b7ebdfd5ec development: de-deprecate 'monitor' hook
PR: https://github.com/opnsense/core/issues/8199
2025-02-14 11:13:02 +01:00
Franco Fichtner
0346fee27e development: document "import" hook
PR: https://github.com/opnsense/core/issues/8325
2025-02-14 10:50:56 +01:00
Ad Schellevis
00ac8006b0 api update: plugins 2025-01-29 13:40:30 +01:00
Ad Schellevis
18aeffdc96 api update: core 2025-01-29 13:39:44 +01:00
Stephan de Wit
3e1c86c717 development: js_helpers: document UIBootgrid initialSearchPhrase and triggerEditFor 2025-01-06 09:59:16 +01:00
Ad Schellevis
444907c857 development/ModelRelationField - add filter tag to the list 2025-01-01 17:41:11 +01:00
Ad Schellevis
5382acda5c phalcon links 2024-12-11 17:39:42 +01:00
Ad Schellevis
69f5ae229b sync api docs 2024-11-27 11:37:44 +01:00
Ad Schellevis
a2f82bed67 development/frontend/models - explain app specific field types using SimpleXMLElement's implemented in 416b6ee144 2024-10-31 14:20:35 +01:00
Ad Schellevis
b067b7adc8 update screenshots and pictures 2024-10-30 18:08:37 +01:00
Ad Schellevis
523630aeb4 development - cleanups to be more aligned with reality 2024-10-26 17:42:26 +02:00
kumy
f0a8d7dd80 docs: Fix typo 2024-09-28 20:01:56 +02:00
Volodymyr Paprotski
07ee32effa
Update legacy.rst (#608)
* Update legacy.rst

Comments on syslog-ng use

* Update source/development/backend/legacy.rst

Co-authored-by: Ad Schellevis <AdSchellevis@users.noreply.github.com>

---------

Co-authored-by: Ad Schellevis <AdSchellevis@users.noreply.github.com>
2024-09-26 17:21:06 +02:00
Franco Fichtner
adf6e9f403 development: document the end result state of newwanip/vpn events
The "_map" variants are now consideren transitional for the 24.7 release
to be used as things are carried over to plugins_argument_map() is being
introduced.  25.1 will use the backwards-compatible standard events.
2024-09-22 11:42:49 +01:00
kumy
cf5ca27100
docs: Fix typo (#604) 2024-09-21 15:00:44 +02:00
kumy
4e4d5f1757
doc: Fix typo in function name (#603) 2024-09-20 19:54:18 +02:00
Ad Schellevis
12967e36d6 devel/helloworld - remove some old cruft 2024-09-03 14:57:51 +02:00
Ad Schellevis
266d65fd8d devel/helloworld - fix typo 2024-09-03 14:48:45 +02:00
Ad Schellevis
36b6039c8b devel/helloworld - missed a spot 2024-09-03 14:41:52 +02:00
Ad Schellevis
440f27ec0b devel/helloworld - upgrade hello world example to latest standards 2024-09-03 14:31:22 +02:00
Franco Fichtner
ebbe8bfdd4 development: document newwanip_map and some related things 2024-08-23 09:20:54 +02:00
TotalGriffLock
934a9d810b
Update helloworld.rst (#593)
Correct a coding error in an example. The correct code is present in the example github repo, but incorrect in the docs.
2024-08-20 08:48:45 +02:00
Stephan de Wit
55a3e6a7ab dashboard: update development documentation 2024-08-19 13:24:57 +02:00
Ad Schellevis
5e92a50d40
Dashboard: merge pending changes (#583)
* development: add dashboard framework documentation

* dashboard: duplicate link

* dashboard: update development documentation

---------

Co-authored-by: Stephan de Wit <stephan.de.wit@deciso.com>
2024-08-03 16:05:31 +02:00
Ad Schellevis
cb7e43f85c api docs 2024-07-24 15:36:58 +02:00
Ad Schellevis
13bb3d908c update api docs 2024-05-04 10:03:42 +02:00
Monviech
94ee5e68e6
Update models_fieldtypes.rst - Add example to display multiple fields (#551) 2024-04-05 14:40:09 +02:00
Ad Schellevis
e88821a9e1 development - add csv import/export helpers. closes https://github.com/opnsense/docs/issues/541 2024-03-17 19:51:39 +01:00
Ad Schellevis
2795d75201 development/frontend/models - add volatile option. closes https://github.com/opnsense/docs/issues/542 2024-03-17 19:02:18 +01:00
Ad Schellevis
6c154cfaeb api endpoints (plugins) 2024-02-20 15:52:06 +01:00
Ad Schellevis
9728f6cf56 api endpoints (core) 2024-02-20 15:51:39 +01:00
Ad Schellevis
5dfe37f0d6 development - add "special model types" 2024-02-19 11:13:30 +01:00
Ad Schellevis
f3522bd358 frontend/models_fieldtypes : HostnameField add IsDNSName parameter 2024-01-23 20:44:31 +01:00
Ad Schellevis
c5bed41355 development/configd - add documentation for new config imports introduced in a1b0dd8071 , closes https://github.com/opnsense/docs/issues/532 2024-01-23 16:42:44 +01:00
Stephan de Wit
ca43be6a7c Development: Frontend: add documentation for DescriptionField and IPPortField types 2024-01-11 16:05:55 +01:00
Stephan de Wit
7bba0a44a5 Development: Field Types: Add MacAddressField and update HostnameField 2024-01-08 10:53:10 +01:00
Vangsguard
943811aede
Resolved duplicates, organized requests in alphabetical order, and corrected inconsistencies. (#519) 2023-11-21 11:36:11 +01:00
Ad Schellevis
b5a0d6fe10 update api endpoints 2023-11-20 10:51:24 +01:00
Ad Schellevis
ea8d486124 Development manual/API reference - reading reference about parameters and expected responses. https://github.com/opnsense/core/issues/7014 2023-11-20 09:51:06 +01:00