From b1f2aa3630ecc9b85bbafa6a47cfe14c1c675add Mon Sep 17 00:00:00 2001 From: Renan Rodrigo Date: Wed, 29 Nov 2023 16:38:58 -0300 Subject: [PATCH] docs: fix spelling errors and update custom wordlist Signed-off-by: Renan Rodrigo --- custom_wordlist.txt | 11 +++++++++++ docs/references/api.rst | 18 +++++++++--------- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/custom_wordlist.txt b/custom_wordlist.txt index 0fce78e84d..a6b3df6e54 100644 --- a/custom_wordlist.txt +++ b/custom_wordlist.txt @@ -1,3 +1,4 @@ +AdditionalData airgapped Airgapping amd @@ -25,6 +26,7 @@ cron CTRL cve CVE +CVEAPIFixExecuteResult CVEFixPlanResult cves CVEs @@ -39,10 +41,14 @@ EnabledService enablement esm ESM +FailedUpgrade fips FIPS firewalled Firewalled +FixExecuteError +FixExecuteResult +FixExecuteUSNResult FixPlanError FixPlanResult FixPlanStep @@ -74,7 +80,9 @@ motd MOTD Multipass NoOp +NoOpAlreadyFixed NoOpData +NoOpLivepatchFixData num PackageCannotBeInstalledData PackageSummary @@ -115,9 +123,12 @@ un unparsed UpdateInfo UpdateSummary +UpgradedPackage usg USG usn +usns +USNAPIFixExecuteResult USNFixPlanResult USNs usr diff --git a/docs/references/api.rst b/docs/references/api.rst index 09a157d469..08a376be93 100644 --- a/docs/references/api.rst +++ b/docs/references/api.rst @@ -699,13 +699,13 @@ This endpoint fixes the specified CVEs on the machine. - *str* - The status of fixing the CVE * - ``upgraded_packages`` - - *List[UpgradedPackages]* - - A list of UpgradedPackages objects + - *List[UpgradedPackage]* + - A list of UpgradedPackage objects * - ``error`` - *Optional[FixExecuteError]* - A FixExecuteError object - - ``uaclient.api.u.pro.security.fix.common.execute.v1.UpgradedPackages`` + - ``uaclient.api.u.pro.security.fix.common.execute.v1.UpgradedPackage`` .. list-table:: :header-rows: 1 @@ -850,7 +850,7 @@ This endpoint fixes the specified CVEs on the machine. prevents any required packages from being upgraded. The system is considered **not-affected** if the CVE doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package - that was upgraded during the fix operation. The UpgradePackage object always contain + that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. @@ -965,13 +965,13 @@ This endpoint fixes the specified USNs on the machine. - *str* - The status of fixing the USN * - ``upgraded_packages`` - - *List[UpgradedPackages]* - - A list of UpgradedPackages objects + - *List[UpgradedPackage]* + - A list of UpgradedPackage objects * - ``error`` - *Optional[FixExecuteError]* - A FixExecuteError object - - ``uaclient.api.u.pro.security.fix.common.execute.v1.UpgradedPackages`` + - ``uaclient.api.u.pro.security.fix.common.execute.v1.UpgradedPackage`` .. list-table:: :header-rows: 1 @@ -1094,7 +1094,7 @@ This endpoint fixes the specified USNs on the machine. * **status**: The status of the fix operation considering **all** USNs. This means that if one USN cannot be fixed, this field will reflect that. Note that related USNs don't interfere with this attribute, meaning - that a related USN can fail to be fixed without modyfing the **status** + that a related USN can fail to be fixed without modifying the **status** value. Each **usn** object contains a reference for both **target_usn** and **related_usns**. @@ -1116,7 +1116,7 @@ This endpoint fixes the specified USNs on the machine. prevents any required packages from being upgraded. The system is considered **not-affected** if the USN doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package - that was upgraded during the fix operation. The UpgradePackage object always contain + that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from.