chore: rename InvocableScripts to InvokableScripts

for more info see influxdata/openapi#317

Author: bednar

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ### Features
 1. [#49](https://github.com/influxdata/influxdb-client-swift/pull/49): Add support `async/await` functions
-1. [#48](https://github.com/influxdata/influxdb-client-swift/pull/48): Add `InvocableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
+1. [#48](https://github.com/influxdata/influxdb-client-swift/pull/48): Add `InvokableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
 
 ### API
 1. [#49](https://github.com/influxdata/influxdb-client-swift/pull/49): Update InfluxDB API to latest version [OpenAPI]

Examples/InvocableScripts/.swiftlint.yml renamed to Examples/InvokableScripts/.swiftlint.yml

@@ -3,19 +3,19 @@
 import PackageDescription
 
 let package = Package(
-        name: "InvocableScripts",
+        name: "InvokableScripts",
         platforms: [
             .macOS(.v10_15)
         ],
         products: [
-            .executable(name: "invocable-scripts", targets: ["InvocableScripts"])
+            .executable(name: "invokable-scripts", targets: ["InvokableScripts"])
         ],
         dependencies: [
             .package(name: "influxdb-client-swift", path: "../../"),
             .package(url: "https://github.com/apple/swift-argument-parser", from: "1.1.2")
         ],
         targets: [
-            .executableTarget(name: "InvocableScripts", dependencies: [
+            .executableTarget(name: "InvokableScripts", dependencies: [
                 .product(name: "InfluxDBSwift", package: "influxdb-client-swift"),
                 .product(name: "ArgumentParser", package: "swift-argument-parser")
             ])

Examples/InvocableScripts/Package.swift renamed to Examples/InvokableScripts/Package.swift

@@ -1,19 +1,19 @@
-# InvocableScripts
+# InvokableScripts
 
-This is an example how to use Invocable scripts Cloud API to create custom endpoints that query data.
-> :warning: Invocable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+This is an example how to use Invokable scripts Cloud API to create custom endpoints that query data.
+> :warning: Invokable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
 
 ## Prerequisites:
 - Docker
 - Cloned examples:
    ```bash
    git clone git@github.com:influxdata/influxdb-client-swift.git
-   cd Examples/InvocableScripts
+   cd Examples/InvokableScripts
    ```
 
 ## Sources:
-- [Package.swift](/Examples/InvocableScripts/Package.swift)
-- [InvocableScripts.swift](/Examples/InvocableScripts/Sources/InvocableScripts/InvocableScripts.swift)
+- [Package.swift](/Examples/InvokableScripts/Package.swift)
+- [InvokableScripts.swift](/Examples/InvokableScripts/Sources/InvokableScripts/InvokableScripts.swift)
 
 ## How to test:
 1. Start SwiftCLI by:
@@ -23,12 +23,12 @@ This is an example how to use Invocable scripts Cloud API to create custom endpo
       --interactive \
       --tty \
       --volume $PWD/../..:/client \
-      --workdir /client/Examples/InvocableScripts \
+      --workdir /client/Examples/InvokableScripts \
       swift:5.6 /bin/bash
    ```
 1. Run Example by:
    ```bash
-   swift run invocable-scripts --org my-org --bucket my-bucket --token my-token --url https://us-west-2-1.aws.cloud2.influxdata.com
+   swift run invokable-scripts --org my-org --bucket my-bucket --token my-token --url https://us-west-2-1.aws.cloud2.influxdata.com
    ```
 
 ## Expected output

Examples/InvocableScripts/README.md renamed to Examples/InvokableScripts/README.md

@@ -1,13 +1,13 @@
 //
-// Warning: Invocable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+// Warning: Invokable Scripts are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
 //
 
 import ArgumentParser
 import Foundation
 import InfluxDBSwift
 
 @main
-struct InvocableScriptsAPI: AsyncParsableCommand {
+struct InvokableScriptsAPI: AsyncParsableCommand {
     @Option(name: .shortAndLong, help: "The bucket to query. The name or id of the bucket destination.")
     private var bucket: String
 
@@ -22,7 +22,7 @@ struct InvocableScriptsAPI: AsyncParsableCommand {
     private var url: String
 }
 
-extension InvocableScriptsAPI {
+extension InvokableScriptsAPI {
     mutating func run() async throws {
         //
         // Initialize Client with default Organization
@@ -32,7 +32,7 @@ extension InvocableScriptsAPI {
                 token: token,
                 options: InfluxDBClient.InfluxDBOptions(bucket: self.bucket, org: self.org))
 
-        let invocableScriptsApi = client.invocableScriptsApi
+        let invokableScriptsApi = client.invokableScriptsApi
 
         //
         // Prepare Data
@@ -48,7 +48,7 @@ extension InvocableScriptsAPI {
         try await client.makeWriteAPI().write(points: [point1, point2])
 
         //
-        // Create Invocable Script
+        // Create Invokable Script
         //
         print("------- Create -------\n")
         let scriptQuery = "from(bucket: params.bucket_name) |> range(start: -30d) |> limit(n:2)"
@@ -58,28 +58,28 @@ extension InvocableScriptsAPI {
                 script: scriptQuery,
                 language: ScriptLanguage.flux)
 
-        let createdScript = try await invocableScriptsApi.createScript(createRequest: createRequest)
+        let createdScript = try await invokableScriptsApi.createScript(createRequest: createRequest)
         guard let createdScript = createdScript else {
             return
         }
         dump(createdScript)
 
         //
-        // Update Invocable Script
+        // Update Invokable Script
         //
         print("\n------- Update -------\n")
         let updateRequest = ScriptUpdateRequest(description: "my updated description")
-        let updatedScript = try await invocableScriptsApi.updateScript(scriptId: createdScript.id!, updateRequest: updateRequest)
+        let updatedScript = try await invokableScriptsApi.updateScript(scriptId: createdScript.id!, updateRequest: updateRequest)
         guard let updatedScript = updatedScript else {
             return
         }
         dump(updatedScript)
 
         //
-        // List Invocable Scripts
+        // List Invokable Scripts
         //
         print("\n------- List -------\n")
-        let scripts = try await invocableScriptsApi.findScripts()
+        let scripts = try await invokableScriptsApi.findScripts()
         print("Scripts:")
         scripts?.scripts?.forEach { print("\t\($0.id ?? ""): \($0.name): \($0.description ?? "")") }
 
@@ -88,15 +88,15 @@ extension InvocableScriptsAPI {
         //
         // FluxRecords
         print("\n------- Invoke to FluxRecords -------\n")
-        let records = try await invocableScriptsApi.invokeScript(
+        let records = try await invokableScriptsApi.invokeScript(
                 scriptId: updatedScript.id!,
                 params: ["bucket_name": "\(self.bucket)"])
         try records.forEach { record in
             print("\t\(record.values["location"]!): \(record.values["_value"]!)")
         }
         // Raw
         print("\n------- Invoke to Raw -------\n")
-        let raw = try await invocableScriptsApi.invokeScriptRaw(
+        let raw = try await invokableScriptsApi.invokeScriptRaw(
                 scriptId: updatedScript.id!,
                 params: ["bucket_name": "\(self.bucket)"])
         print("RAW output:\n\n \(String(decoding: raw, as: UTF8.self))")
@@ -105,7 +105,7 @@ extension InvocableScriptsAPI {
         // Delete previously created Script
         //
         print("\n------- Delete -------\n")
-        try await invocableScriptsApi.deleteScript(scriptId: updatedScript.id!)
+        try await invokableScriptsApi.deleteScript(scriptId: updatedScript.id!)
         print("Successfully deleted script: '\(updatedScript.name)'")
 
         client.close()

Examples/InvocableScripts/Sources/InvocableScripts/InvocableScripts.swift renamed to Examples/InvokableScripts/Sources/InvokableScripts/InvokableScripts.swift

@@ -15,5 +15,5 @@
 - [DeleteData](DeleteData#deletedata) - How to delete data with specified predicate
 - [AsyncAwait](AsyncAwait#asyncawait) - How to use `async/await` with the InfluxDB client.
 - [InfluxDBStatus](InfluxDBStatus#influxdbstatus) - This is an example how to check status of InfluxDB
-- [InvocableScripts](InvocableScripts#invocablescripts) - How to use Invocable scripts Cloud API to create custom endpoints that query data
+- [InvokableScripts](InvokableScripts#invokablescripts) - How to use Invokable scripts Cloud API to create custom endpoints that query data
 

Examples/README.md

@@ -171,7 +171,7 @@ extension FluxCSVParser {
     enum ResponseMode {
         /// full information about types, default values and groups
         case full
-        /// useful for Invocable scripts
+        /// useful for Invokable scripts
         case onlyNames
     }
 }

Sources/InfluxDBSwift/FluxCSVParser.swift

@@ -44,9 +44,9 @@ public class InfluxDBClient {
         DeleteAPI(client: self)
     }()
 
-    /// Lazy initialized `InvocableScriptsApi`.
-    public lazy var invocableScriptsApi: InvocableScriptsAPI = {
-        InvocableScriptsAPI(client: self)
+    /// Lazy initialized `InvokableScriptsApi`.
+    public lazy var invokableScriptsApi: InvokableScriptsAPI = {
+        InvokableScriptsAPI(client: self)
     }()
 
     /// Create a new client for a InfluxDB.

Sources/InfluxDBSwift/InfluxDBClient.swift

@@ -8,11 +8,11 @@ import Foundation
 ///
 /// API invokable scripts let you assign scripts to API endpoints and then execute them
 /// as standard REST operations in InfluxDB Cloud.
-public class InvocableScriptsAPI {
+public class InvokableScriptsAPI {
     /// Shared client.
     private let client: InfluxDBClient
 
-    /// Create a new InvocableScriptsApi for InfluxDB
+    /// Create a new InvokableScriptsApi for InfluxDB
     ///
     /// - Parameters
     ///    - client: Client with shared configuration and http library.

Sources/InfluxDBSwift/InvocableScriptsAPI.swift renamed to Sources/InfluxDBSwift/InvokableScriptsAPI.swift

@@ -7,7 +7,7 @@ import Foundation
 @testable import InfluxDBSwift
 import XCTest
 
-final class InvocableScriptsAPITests: XCTestCase {
+final class InvokableScriptsAPITests: XCTestCase {
     private var client: InfluxDBClient!
 
     override func setUp() {
@@ -22,7 +22,7 @@ final class InvocableScriptsAPITests: XCTestCase {
         client.close()
     }
 
-    func testGetInvocableScriptsApi() {
-        XCTAssertNotNil(client.invocableScriptsApi)
+    func testGetInvokableScriptsApi() {
+        XCTAssertNotNil(client.invokableScriptsApi)
     }
 }