Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FRR API reference outdated #310

Closed
2 tasks done
marcquark opened this issue Feb 10, 2021 · 1 comment
Closed
2 tasks done

FRR API reference outdated #310

marcquark opened this issue Feb 10, 2021 · 1 comment
Assignees
@AdSchellevis

Comments

@marcquark
Copy link
Contributor

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

Describe the issue

The API reference for FRR (aka quagga in the docs) is outdated. https://docs.opnsense.org/development/api/plugins/frr.html

Suggestions

Update the "quagga" API reference and while doing it, rename it to FRR

Version affected

21.1

Describe alternatives you considered

I guess automatic generation of the API reference from the code would be nice to keep things in sync automatically. I don't know that would best be done though.

Additional context

The API received a major overhaul recently
@AdSchellevis AdSchellevis self-assigned this Feb 11, 2021
@AdSchellevis
Copy link
Member

we have a script for that which reads the endpoints, I'll try to run it shortly and close this issue

Greelan added a commit to Greelan/opnsense-docs that referenced this issue Mar 3, 2021
@Greelan @AdSchellevis
@sjjh @tomlawesome @fichtner @swhite2 @kulikov-a @SalazarBruno @marcquark
Wireguard routing guide (#1)
c845ca2 
* udate changelogs

* update changelog collection script to cope with multiple flavours, while here, also swich to python3

* update changelogs

* netmap / bpf, adjust information, seemed to have been a side affect pre-21.1

* clarify number of Public Services needed (opnsense#309)

* Add new LTE card to interfaces.rst (opnsense#308)

@tomlawesome thanks for confirming

* fix broken links for the changelogs

* changelog: here be dragons

* remove custom theme instructions and templates and move back to standard using existing options.

* pip[3] in case pip3 doesn't exist :)

* update changelogs

* parse changelog Links

* update api docs, closes opnsense#310

* Fix typo (opnsense#311)

* Firmware: fix some spelling errors (opnsense#313)

* www/nginx update docs for upstream verify (opnsense#305)

* Correcting mismatched interfaces in upload rule (opnsense#314)

The names of the interfaces were wrong in the upload rule

* hint to cronjobs for shorter backup intervals (opnsense#315)

* release notes:

* Create wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-client-mullvad.rst

* Update wireguard-selective-routing.rst

* Update plugins.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

* Update wireguard-selective-routing.rst

Co-authored-by: Ad Schellevis <ad@opnsense.org>
Co-authored-by: sjjh <2787214+sjjh@users.noreply.github.com>
Co-authored-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
Co-authored-by: Franco Fichtner <franco@opnsense.org>
Co-authored-by: Stephan de Wit <33954429+swhite2@users.noreply.github.com>
Co-authored-by: kulikov-a <36099472+kulikov-a@users.noreply.github.com>
Co-authored-by: Bruno Magnum Vasconcelos Monteiro Salazar <salazar.bruno@gmail.com>
Co-authored-by: Marc Leuser <marcquark@users.noreply.github.com>
Greelan added a commit to Greelan/opnsense-docs that referenced this issue Mar 6, 2021
@Greelan @AdSchellevis
@sjjh @tomlawesome @fichtner @swhite2 @kulikov-a @SalazarBruno @marcquark
Update (#2)
92ea5a2 
* udate changelogs

* update changelog collection script to cope with multiple flavours, while here, also swich to python3

* update changelogs

* netmap / bpf, adjust information, seemed to have been a side affect pre-21.1

* clarify number of Public Services needed (opnsense#309)

* Add new LTE card to interfaces.rst (opnsense#308)

@tomlawesome thanks for confirming

* fix broken links for the changelogs

* changelog: here be dragons

* remove custom theme instructions and templates and move back to standard using existing options.

* pip[3] in case pip3 doesn't exist :)

* update changelogs

* parse changelog Links

* update api docs, closes opnsense#310

* Fix typo (opnsense#311)

* Firmware: fix some spelling errors (opnsense#313)

* www/nginx update docs for upstream verify (opnsense#305)

* Correcting mismatched interfaces in upload rule (opnsense#314)

The names of the interfaces were wrong in the upload rule

* hint to cronjobs for shorter backup intervals (opnsense#315)

* release notes:

* HA-Sync cron job: add documentation, closes opnsense/core#4604

* Wireguard selective routing how-to (opnsense#317)

* Update wireguard-client.rst to clarify use of WireGuard net (opnsense#304)

This proposed tweak to the how-to is intended to address the issue discussed in this forum thread: https://forum.opnsense.org/index.php?topic=21170.0

* API: Add a note for postman users (opnsense#318)

Co-authored-by: Ad Schellevis <ad@opnsense.org>
Co-authored-by: sjjh <2787214+sjjh@users.noreply.github.com>
Co-authored-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
Co-authored-by: Franco Fichtner <franco@opnsense.org>
Co-authored-by: Stephan de Wit <33954429+swhite2@users.noreply.github.com>
Co-authored-by: kulikov-a <36099472+kulikov-a@users.noreply.github.com>
Co-authored-by: Bruno Magnum Vasconcelos Monteiro Salazar <salazar.bruno@gmail.com>
Co-authored-by: Marc Leuser <marcquark@users.noreply.github.com>
Greelan added a commit to Greelan/opnsense-docs that referenced this issue Mar 8, 2021
@Greelan @AdSchellevis
@sjjh @tomlawesome @fichtner @swhite2 @kulikov-a @SalazarBruno @marcquark
Update (#3)
87674b8 
* udate changelogs

* update changelog collection script to cope with multiple flavours, while here, also swich to python3

* update changelogs

* netmap / bpf, adjust information, seemed to have been a side affect pre-21.1

* clarify number of Public Services needed (opnsense#309)

* Add new LTE card to interfaces.rst (opnsense#308)

@tomlawesome thanks for confirming

* fix broken links for the changelogs

* changelog: here be dragons

* remove custom theme instructions and templates and move back to standard using existing options.

* pip[3] in case pip3 doesn't exist :)

* update changelogs

* parse changelog Links

* update api docs, closes opnsense#310

* Fix typo (opnsense#311)

* Firmware: fix some spelling errors (opnsense#313)

* www/nginx update docs for upstream verify (opnsense#305)

* Correcting mismatched interfaces in upload rule (opnsense#314)

The names of the interfaces were wrong in the upload rule

* hint to cronjobs for shorter backup intervals (opnsense#315)

* release notes:

* HA-Sync cron job: add documentation, closes opnsense/core#4604

* Wireguard selective routing how-to (opnsense#317)

* Update wireguard-client.rst to clarify use of WireGuard net (opnsense#304)

This proposed tweak to the how-to is intended to address the issue discussed in this forum thread: https://forum.opnsense.org/index.php?topic=21170.0

* API: Add a note for postman users (opnsense#318)

Co-authored-by: Ad Schellevis <ad@opnsense.org>
Co-authored-by: sjjh <2787214+sjjh@users.noreply.github.com>
Co-authored-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
Co-authored-by: Franco Fichtner <franco@opnsense.org>
Co-authored-by: Stephan de Wit <33954429+swhite2@users.noreply.github.com>
Co-authored-by: kulikov-a <36099472+kulikov-a@users.noreply.github.com>
Co-authored-by: Bruno Magnum Vasconcelos Monteiro Salazar <salazar.bruno@gmail.com>
Co-authored-by: Marc Leuser <marcquark@users.noreply.github.com>
Greelan added a commit to Greelan/opnsense-docs that referenced this issue Aug 19, 2021
@Greelan @AdSchellevis
@sjjh @tomlawesome @fichtner @swhite2 @kulikov-a @SalazarBruno @marcquark
Update (#3)
55c14d0 
* udate changelogs

* update changelog collection script to cope with multiple flavours, while here, also swich to python3

* update changelogs

* netmap / bpf, adjust information, seemed to have been a side affect pre-21.1

* clarify number of Public Services needed (opnsense#309)

* Add new LTE card to interfaces.rst (opnsense#308)

@tomlawesome thanks for confirming

* fix broken links for the changelogs

* changelog: here be dragons

* remove custom theme instructions and templates and move back to standard using existing options.

* pip[3] in case pip3 doesn't exist :)

* update changelogs

* parse changelog Links

* update api docs, closes opnsense#310

* Fix typo (opnsense#311)

* Firmware: fix some spelling errors (opnsense#313)

* www/nginx update docs for upstream verify (opnsense#305)

* Correcting mismatched interfaces in upload rule (opnsense#314)

The names of the interfaces were wrong in the upload rule

* hint to cronjobs for shorter backup intervals (opnsense#315)

* release notes:

* HA-Sync cron job: add documentation, closes opnsense/core#4604

* Wireguard selective routing how-to (opnsense#317)

* Update wireguard-client.rst to clarify use of WireGuard net (opnsense#304)

This proposed tweak to the how-to is intended to address the issue discussed in this forum thread: https://forum.opnsense.org/index.php?topic=21170.0

* API: Add a note for postman users (opnsense#318)

Co-authored-by: Ad Schellevis <ad@opnsense.org>
Co-authored-by: sjjh <2787214+sjjh@users.noreply.github.com>
Co-authored-by: tomlawesome <76453276+tomlawesome@users.noreply.github.com>
Co-authored-by: Franco Fichtner <franco@opnsense.org>
Co-authored-by: Stephan de Wit <33954429+swhite2@users.noreply.github.com>
Co-authored-by: kulikov-a <36099472+kulikov-a@users.noreply.github.com>
Co-authored-by: Bruno Magnum Vasconcelos Monteiro Salazar <salazar.bruno@gmail.com>
Co-authored-by: Marc Leuser <marcquark@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AdSchellevis AdSchellevis

Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AdSchellevis @marcquark