Route GET /api/v1/openapi

  • Auch wenn es jetzt eine BETA ist, könnte man bei Änderungen der API die Version bei Info verändern?

    Code
    "info": {
        "title": "SCP (Server Control Panel) REST API",
        "version": "1.0"
      }

    Mir ist aufgefallen, dass auf einmal die zwei cloudinit Routen da waren, aber hier an der Version nichts verändert wurde.

    Für die Zukunft wäre auch eine art Changelog schön.

  • Hallo nitram

    wir möchten noch ein kurzes Update dazu geben! :)

    In einem ersten Schritt haben wir nun die Version des SCP in die OpenAPI Spec eingefügt.

    Die Version wird bei jedem SCP Release angepasst, unabhängig davon, ob es eine Änderung an der API gegeben hat oder nicht.

    Nach der Beta-Phase wird es keine breaking changes mehr an der API gegeben. Bei erforderlichen breaking changes erfolgt die Versionierung einzelner Endpoints über den Pfad.

    Das Thema Changelog haben wir weiterhin am Radar.

    Liebe Grüße

    Sarah & das netcup-Team

  • In einem ersten Schritt haben wir nun die Version des SCP in die OpenAPI Spec eingefügt.

    Die Version wird bei jedem SCP Release angepasst, unabhängig davon, ob es eine Änderung an der API gegeben hat oder nicht.

    Nach der Beta-Phase wird es keine breaking changes mehr an der API gegeben. Bei erforderlichen breaking changes erfolgt die Versionierung einzelner Endpoints über den Pfad.

    Das Thema Changelog haben wir weiterhin am Radar.

    Please include this important lifecycle management information somewhere in the Swagger documentation, such as in the description field:

    Einmal editiert, zuletzt von leee (29. November 2025 um 03:17)

  • Hello leee and nitram

    wishing you both a belated happy new year - all the best for 2026! :)

    I'm please to let you know that the description of versioning is now available in the OpenAPI Spec here under ‘info’ - ‘description’.

    ( leee Regarding some of your other feedback posts: I will get to them as well over the next days)

    Kind regards
    Sarah & the netcup team