Werk 16501 was adapted. The following is the new Werk, a diff is shown at the end of the message. [//]: # (werk v2) # introduce command to start openapi-spec generation background job key | value ---------- | --- date | 2024-02-29T13:06:16+00:00 version | 2.4.0b1 class | feature edition | cre component | rest-api level | 1 compatible | yes Werk 15724 introduces a mechanism for regenerating the API specification, which, in certain instances, is executed as a background job due to the potential time required for completion. This update introduces a command to trigger the background job for the regeneration of the API specification. Users should be aware that triggering the job does not result in immediate availability of the updated documentation; there may be a delay before the documentation is updated. This saves the user from having to trigger and wait for the specification regeneration manually. ------------------------------------<diff>------------------------------------------- [//]: # (werk v2) - # omd: trigger openapi-spec generation job during start, restart and reload + # introduce command to start openapi-spec generation background job key | value ---------- | --- date | 2024-02-29T13:06:16+00:00 version | 2.4.0b1 class | feature edition | cre - component | omd + component | rest-api level | 1 compatible | yes Werk 15724 introduces a mechanism for regenerating the API specification, which, in certain instances, is executed as a background job due to the - potential time required for completion. This update modifies the omd start, ? ^ ^^^ ^^^^ ------- + potential time required for completion. This update introduces a command ? ^^^^ ^^ ^^^ +++ - restart, and reload commands to initiate this specific background job upon + to trigger the background job for the regeneration of the API specification. - execution. Users should be aware that triggering the job does not result ? ----------- + Users should be aware that triggering the job does not result in immediate availability of the updated documentation; there may be a delay before the documentation is updated. This saves the user from having - to trigger and wait for the specification regeneration manually in case ? ^^^^^^^^ + to trigger and wait for the specification regeneration manually. ? ^ - relevant changes have been made outside the user interface and the apache - process needs to be restarted. - Based on werk 15724 the specification is now updated in these situations: - - * post-create hook: Create the initial spec after a site has been created - * post rename action: Update the spec after a site has been copied, restored or renamed - * update-config action: Update the spec after the site has been updated - * omd apache: Update the spec when the apache process is started, restarted or reloaded - - -