From 273bcc7e7684947a41e5957d597700881465534c Mon Sep 17 00:00:00 2001 From: Vyacheslav Yurkov Date: Sun, 3 Sep 2023 21:44:45 +0200 Subject: [PATCH] Update Hawkbit's documentation references Hawkbit's base URL was changed to eclipse.dev Signed-off-by: Vyacheslav Yurkov --- docs/reference.rst | 4 ++-- docs/using.rst | 2 +- script/hawkbit_mgmt.py | 40 ++++++++++++++++++++-------------------- src/hawkbit-client.c | 6 +++--- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/reference.rst b/docs/reference.rst index 5007fb22..feff426d 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -47,7 +47,7 @@ Mandatory options: ``auth_token=`` Controller-specific authentication token. This is set for each device individually. - For details, refer to https://www.eclipse.org/hawkbit/concepts/authentication/. + For details, refer to https://eclipse.dev/hawkbit/concepts/authentication/. .. note:: Either ``auth_token`` or ``gateway_token`` must be provided @@ -56,7 +56,7 @@ Mandatory options: This is a tenant-wide token and must explicitly be enabled in hakwBit first. It is actually meant to authenticate a gateway that itself manages/authenticates multiple targets, thus use with care. - For details, refer to https://www.eclipse.org/hawkbit/concepts/authentication/. + For details, refer to https://eclipse.dev/hawkbit/concepts/authentication/. .. note:: Either ``auth_token`` or ``gateway_token`` must be provided diff --git a/docs/using.rst b/docs/using.rst index 0663ee26..56a4a42d 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -6,7 +6,7 @@ Using the RAUC hawkbit Updater Authentication -------------- -As described on the `hawkBit Authentication page `_ +As described on the `hawkBit Authentication page `_ in the "DDI API Authentication Modes" section, a device can be authenticated with a security token. A security token can be either a "Target" token or a "Gateway" token. The "Target" security token is specific to a single target diff --git a/script/hawkbit_mgmt.py b/script/hawkbit_mgmt.py index 5d51af5d..09cd3f8c 100755 --- a/script/hawkbit_mgmt.py +++ b/script/hawkbit_mgmt.py @@ -27,7 +27,7 @@ class HawkbitMgmtTestClient: Does not cover the whole Management API, only the parts required for the rauc-hawkbit-updater test suite. - https://www.eclipse.org/hawkbit/apis/management_api/ + https://eclipse.dev/hawkbit/apis/management_api/ """ host = attr.ib(validator=attr.validators.instance_of(str)) port = attr.ib(validator=attr.validators.instance_of(int)) @@ -134,7 +134,7 @@ def set_config(self, key: str, value: str): """ Changes a configuration `value` of a specific configuration `key`. - https://www.eclipse.org/hawkbit/rest-api/tenant-api-guide/#_put_rest_v1_system_configs_keyname + https://eclipse.dev/hawkbit/rest-api/tenant-api-guide.html#_put_restv1systemconfigskeyname """ self.put(f'system/configs/{key}', {'value' : value}) @@ -142,7 +142,7 @@ def get_config(self, key: str): """ Returns the configuration value of a specific configuration `key`. - https://www.eclipse.org/hawkbit/rest-api/tenant-api-guide/#_get_rest_v1_system_configs_keyname + https://eclipse.dev/hawkbit/rest-api/tenant-api-guide.html#_get_restv1systemconfigskeyname """ return self.get(f'system/configs/{key}')['value'] @@ -155,7 +155,7 @@ def add_target(self, target_id: str = None, token: str = None): Stores the id of the created target for future use by other methods. Returns the target's id. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_post_rest_v1_targets + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_post_restv1targets """ target_id = target_id or f'test-{time.monotonic()}' testdata = { @@ -177,7 +177,7 @@ def get_target(self, target_id: str = None): If `target_id` is not given, returns the target created by the most recent `add_target()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_get_rest_v1_targets_targetid + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_get_restv1targetstargetid """ target_id = target_id or self.id['target'] @@ -188,7 +188,7 @@ def delete_target(self, target_id: str = None): Deletes the target matching `target_id`. If target_id is not given, deletes the target created by the most recent add_target() call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_delete_rest_v1_targets_targetid + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_delete_restv1targetstargetid """ target_id = target_id or self.id['target'] self.delete(f'targets/{target_id}') @@ -201,7 +201,7 @@ def get_attributes(self, target_id: str = None): Returns the attributes of the target matching `target_id`. If `target_id` is not given, uses the target created by the most recent `add_target()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_get_rest_v1_targets_targetid_attributes + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_get_restv1targetstargetidattributes """ target_id = target_id or self.id['target'] @@ -214,7 +214,7 @@ def add_softwaremodule(self, name: str = None, module_type: str = 'os'): Stores the id of the created software module for future use by other methods. Returns the id of the created software module. - https://www.eclipse.org/hawkbit/rest-api/softwaremodules-api-guide/#_post_rest_v1_softwaremodules + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_post_restv1softwaremodules """ name = name or f'software module {time.monotonic()}' data = [{ @@ -232,7 +232,7 @@ def get_softwaremodule(self, module_id: str = None): If `module_id` is not given, returns the software module created by the most recent `add_softwaremodule()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_get_rest_v1_targets_targetid + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_get_restv1softwaremodulessoftwaremoduleid """ module_id = module_id or self.id['softwaremodule'] @@ -242,7 +242,7 @@ def delete_softwaremodule(self, module_id: str = None): """ Deletes the software module matching `module_id`. - https://www.eclipse.org/hawkbit/rest-api/softwaremodules-api-guide/#_delete_rest_v1_softwaremodules_softwaremoduleid + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_delete_restv1softwaremodulessoftwaremoduleid """ module_id = module_id or self.id['softwaremodule'] self.delete(f'softwaremodules/{module_id}') @@ -259,7 +259,7 @@ def add_distributionset(self, name: str = None, module_ids: list = [], dist_type Stores the id of the created distribution set for future use by other methods. Returns the id of the created distribution set. - https://www.eclipse.org/hawkbit/rest-api/distributionsets-api-guide/#_post_rest_v1_distributionsets + https://eclipse.dev/hawkbit/rest-api/distributionsets-api-guide.html#_post_restv1distributionsets """ assert isinstance(module_ids, list) @@ -284,7 +284,7 @@ def get_distributionset(self, dist_id: str = None): If `dist_id` is not given, returns the distribution set created by the most recent `add_distributionset()` call. - https://www.eclipse.org/hawkbit/rest-api/distributionsets-api-guide/#_get_rest_v1_distributionsets_distributionsetid + https://eclipse.dev/hawkbit/rest-api/distributionsets-api-guide.html#_get_restv1distributionsetsdistributionsetid """ dist_id = dist_id or self.id['distributionset'] @@ -296,7 +296,7 @@ def delete_distributionset(self, dist_id: str = None): If `dist_id` is not given, deletes the distribution set created by the most recent `add_distributionset()` call. - https://www.eclipse.org/hawkbit/rest-api/distributionsets-api-guide/#_delete_rest_v1_distributionsets_distributionsetid + https://eclipse.dev/hawkbit/rest-api/distributionsets-api-guide.html#_delete_restv1distributionsetsdistributionsetid """ dist_id = dist_id or self.id['distributionset'] @@ -313,7 +313,7 @@ def add_artifact(self, file_name: str, module_id: str = None): Stores the id of the created artifact for future use by other methods. Returns the id of the created artifact. - https://www.eclipse.org/hawkbit/rest-api/softwaremodules-api-guide/#_post_rest_v1_softwaremodules_softwaremoduleid_artifacts + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_post_restv1softwaremodulessoftwaremoduleidartifacts """ module_id = module_id or self.id['softwaremodule'] @@ -329,7 +329,7 @@ def get_artifact(self, artifact_id: str = None, module_id: str = None): If `module_id` is not given, uses the software module created by the most recent `add_softwaremodule()` call. - https://www.eclipse.org/hawkbit/rest-api/softwaremodules-api-guide/#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_get_restv1softwaremodulessoftwaremoduleidartifactsartifactid """ module_id = module_id or self.id['softwaremodule'] artifact_id = artifact_id or self.id['artifact'] @@ -344,7 +344,7 @@ def delete_artifact(self, artifact_id: str = None, module_id: str = None): If `module_id` is not given, uses the software module created by the most recent `add_softwaremodule()` call. - https://www.eclipse.org/hawkbit/rest-api/softwaremodules-api-guide/#_delete_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid + https://eclipse.dev/hawkbit/rest-api/softwaremodules-api-guide.html#_delete_restv1softwaremodulessoftwaremoduleidartifactsartifactid """ module_id = module_id or self.id['softwaremodule'] artifact_id = artifact_id or self.id['artifact'] @@ -363,7 +363,7 @@ def assign_target(self, dist_id: str = None, target_id: str = None, params: dict call. Stores the id of the assignment action for future use by other methods. - https://www.eclipse.org/hawkbit/rest-api/distributionsets-api-guide/#_post_rest_v1_distributionsets_distributionsetid_assignedtargets + https://eclipse.dev/hawkbit/rest-api/distributionsets-api-guide.html#_post_restv1distributionsetsdistributionsetidassignedtargets """ dist_id = dist_id or self.id['distributionset'] target_id = target_id or self.id['target'] @@ -388,7 +388,7 @@ def get_action(self, action_id: str = None, target_id: str = None): If `target_id` is not given, uses the target created by the most recent `add_target()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_get_rest_v1_targets_targetid_actions_actionid + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_get_restv1targetstargetidactionsactionid """ action_id = action_id or self.id['action'] target_id = target_id or self.id['target'] @@ -404,7 +404,7 @@ def get_action_status(self, action_id: str = None, target_id: str = None): If `target_id` is not given, uses the target created by the most recent `add_target()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_get_rest_v1_targets_targetid_actions_actionid_status + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_get_restv1targetstargetidactionsactionidstatus """ action_id = action_id or self.id['action'] target_id = target_id or self.id['target'] @@ -421,7 +421,7 @@ def cancel_action(self, action_id: str = None, target_id: str = None, *, force: If `target_id` is not given, uses the target created by the most recent `add_target()` call. - https://www.eclipse.org/hawkbit/rest-api/targets-api-guide/#_delete_rest_v1_targets_targetid_actions_actionid + https://eclipse.dev/hawkbit/rest-api/targets-api-guide.html#_delete_restv1targetstargetidactionsactionid """ action_id = action_id or self.id['action'] target_id = target_id or self.id['target'] diff --git a/src/hawkbit-client.c b/src/hawkbit-client.c index ffe932e6..dca518bf 100644 --- a/src/hawkbit-client.c +++ b/src/hawkbit-client.c @@ -7,7 +7,7 @@ * @brief Implementation of the hawkBit DDI API * * @see https://github.com/rauc/rauc-hawkbit - * @see https://www.eclipse.org/hawkbit/apis/ddi_api/ + * @see https://eclipse.dev/hawkbit/apis/ddi_api/ */ #ifndef _GNU_SOURCE @@ -526,7 +526,7 @@ static gboolean rest_request_retriable(enum HTTPMethod method, const gchar *url, /** * @brief Build hawkBit JSON request. * - * @see https://www.eclipse.org/hawkbit/rest-api/rootcontroller-api-guide/#_post_tenant_controller_v1_controllerid_deploymentbase_actionid_feedback + * @see https://eclipse.dev/hawkbit/rest-api/rootcontroller-api-guide.html#_post_tenantcontrollerv1controlleriddeploymentbaseactionidfeedback * * @param[in] id hawkBit action ID or NULL (configData usecase) * @param[in] detail Detail message or NULL (configData usecase) @@ -752,7 +752,7 @@ gboolean hawkbit_progress(const gchar *msg) * @brief Provide meta information that will allow the hawkBit to identify the device on a hardware * level. * - * @see https://www.eclipse.org/hawkbit/rest-api/rootcontroller-api-guide/#_put_tenant_controller_v1_controllerid_configdata + * @see https://eclipse.dev/hawkbit/rest-api/rootcontroller-api-guide.html#_put_tenantcontrollerv1controlleridconfigdata * * @param[out] error Error * @return TRUE if identification succeeded, FALSE otherwise (error set)