Add codespell support (config, workflow to detect/not fix) and make it fix a typo

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,go.sum,*.css,.codespellrc
+check-hidden = true
+# ignore-regex = 
+ignore-words-list = transferd

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

app/python/src/examples/faspex5.py

@@ -90,7 +90,7 @@ def build_recipient_list(f5_api, emails):
     # Get access to the Faspex 5 API
     #
 
-    # bearer token is valid for some time and can (should) be re-used, until expired, then refresh it
+    # bearer token is valid for some time and can (should) be reused, until expired, then refresh it
     # in this example we generate a new bearer token for each script invocation
     f5_api = utils.rest.Rest(f'{config.param("faspex5", "url")}{F5_API_PATH_V5}')
     f5_api.setVerify(config.param('faspex5', 'verify', True))

app/python/src/utils/rest.py

@@ -60,7 +60,7 @@ def setDefaultScope(self, scope=None):
 
         In this example we generate a new bearer token for each script invocation.
 
-        But in real code, as the bearer token is valid for some time, it should be re-used, until expired, then refresh it.
+        But in real code, as the bearer token is valid for some time, it should be reused, until expired, then refresh it.
         """
         self.headers['Authorization'] = self.getBearerTokenAuthorization(scope)
 

openapi/IBM Aspera Faspex API-5.0.json

@@ -310,7 +310,7 @@
         "tags": [
           "Authorization"
         ],
-        "description": "When you call this endpoint, you are redirected to the Faspex login page to log in as a user. By logging in, you are implicitly authorizing the client to act as that user. Once authenticated, you are redirected to the given `redirect_uri`. Implement a GET endpoint that matches the `redirect_uri` on your application that can recieve and handle the URL-encoded authorization code.",
+        "description": "When you call this endpoint, you are redirected to the Faspex login page to log in as a user. By logging in, you are implicitly authorizing the client to act as that user. Once authenticated, you are redirected to the given `redirect_uri`. Implement a GET endpoint that matches the `redirect_uri` on your application that can receive and handle the URL-encoded authorization code.",
         "parameters": [
           {
             "name": "client_id",
@@ -571,7 +571,7 @@
         "tags": [
           "Authorization"
         ],
-        "description": "When you call this endpoint and link requires multi factor authentication, you are redirected to enter verification code page or if link does not require multi factor authentication, you are redirected to the given redirect_uri. Implement a GET endpoint that matches the redirect_uri on your application that can recieve and handle the URL-encoded authorization code.",
+        "description": "When you call this endpoint and link requires multi factor authentication, you are redirected to enter verification code page or if link does not require multi factor authentication, you are redirected to the given redirect_uri. Implement a GET endpoint that matches the redirect_uri on your application that can receive and handle the URL-encoded authorization code.",
         "security": [
           {
             "PasscodeAuth": []
@@ -5008,7 +5008,7 @@
             "schema": {
               "type": "integer"
             },
-            "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
+            "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
           }
         ],
         "responses": {
@@ -5698,7 +5698,7 @@
                           },
                           "code": {
                             "type": "string",
-                            "description": "Shorthand description for whether package was succesfully deleted or not."
+                            "description": "Shorthand description for whether package was successfully deleted or not."
                           },
                           "message": {
                             "type": "string",
@@ -6924,7 +6924,7 @@
             "schema": {
               "type": "integer"
             },
-            "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
+            "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
           },
           {
             "in": "query",
@@ -7172,7 +7172,7 @@
             "schema": {
               "type": "integer"
             },
-            "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
+            "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
           },
           {
             "in": "query",
@@ -10149,7 +10149,7 @@
                       "minLength": 1,
                       "maxLength": 255,
                       "type": "string",
-                      "description": "The SLO respone target URL."
+                      "description": "The SLO response target URL."
                     },
                     "cert_multi": {
                       "minLength": 1,
@@ -12663,7 +12663,7 @@
             "schema": {
               "type": "integer"
             },
-            "description": "The maximum number of resources to return. This has the same function as the limit paramater. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
+            "description": "The maximum number of resources to return. This has the same function as the limit parameter. **Note**: For file browsing APIs, HSTS will only return a maximum of 1000 records even if the request value is higher than 1000."
           }
         ],
         "responses": {
@@ -30338,7 +30338,7 @@
           },
           "multi_session": {
             "type": "integer",
-            "description": "The multi-session threshhold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split."
+            "description": "The multi-session threshold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split."
           },
           "rate_policy": {
             "minLength": 1,
@@ -53207,7 +53207,7 @@
           },
           "multi_session": {
             "type": "integer",
-            "description": "The multi-session threshhold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split."
+            "description": "The multi-session threshold value, which specifies (in bytes) the smallest-size file that can be split. Files greater than or equal to the threshold are split, while those smaller than the threshold are not. If the multi-session threshold is 0, files are not split."
           },
           "paths": {
             "type": "array",

openapi/IBM Aspera Node API-4.4.6.yaml

@@ -3002,15 +3002,15 @@ components:
           - aes-256
         content_protection_secret:
           type: string
-          description: "Provide a server side enryption at rest secret. Files transfered\
+          description: "Provide a server side encryption at rest secret. Files transferred\
             \ with server side encryption at rest are automatically encrypted on upload\
             \ and decrypted on download. This secret can not be changed via PUT. If\
             \ you need capabilities to rotate passwords, then consider the BYOK option\
             \ or one of the customer provided encryption key options from an object\
             \ storage provider."
         file_checksum_type:
           type: string
-          description: "The type of checksum reporting to perform on each file transfered.\
+          description: "The type of checksum reporting to perform on each file transferred.\
             \ Value is \"none\", \"md5\", \"sha1\", \"sha-256\", \"sha-384\", \"sha-512\"\
             . Default is unset, such that the transfer will not report file checksums\
             \ unless the remote server is configured to report file checksums."
@@ -3120,7 +3120,7 @@ components:
           - aes-256
         file_checksum_type:
           type: string
-          description: "The type of checksum reporting to perform on each file transfered.\
+          description: "The type of checksum reporting to perform on each file transferred.\
             \ Value is \"none\", \"md5\", \"sha1\", \"sha-256\", \"sha-384\", \"sha-512\"\
             . Default is unset, such that the transfer will not report file checksums\
             \ unless the remote server is configured to report file checksums."

openapi/IBM Aspera on Cloud API-0.2.6.yaml

@@ -3237,7 +3237,7 @@ components:
         invitation_to_send_to_me:
           description: >-
             An email notification setting; refer to email_notification_settings.
-            Notifiy users who receive an invitation to send a package to an
+            Notify users who receive an invitation to send a package to an
             individual (as opposed to sending to a dropbox; see
             dropbox_invitation). Refer also to
             external_package_sending_allowed(_by_managers).