ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.400.1

unclesp1d3r · Sep 20, 2024 · 4772f01 · 4772f01
1 parent cce2e23
commit 4772f01
Show file tree

Hide file tree

Showing 21 changed files with 1,094 additions and 331 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 go:
-  version: 0.8.3
+  version: 0.8.4
   additionalDependencies: {}
   allowUnknownFieldsInWeakUnions: false
   clientServerStatusCodesAsErrors: true

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,19 +1,18 @@
-speakeasyVersion: 1.379.0
+speakeasyVersion: 1.400.1
 sources:
     CipherSwarm_agent_api:
         sourceNamespace: cipher-swarm-agent-api
-        sourceRevisionDigest: sha256:abb0a124fd1e548164b96b8e56803106daadc61116cecc0042426a24ea65afb4
-        sourceBlobDigest: sha256:756d43108a60dd436d2afd7c659609e4608fe45f36b01bf6be1ed50d1db7f83b
+        sourceRevisionDigest: sha256:f9787ad737cfb6a94a7230bcfabc8f5edd188432525efd4b67ddc7bb8f1a0e2e
+        sourceBlobDigest: sha256:93c3f31880777a5d06b7df353d9dffb8066729999e96794680edd65284d8c216
         tags:
             - latest
             - main
 targets:
     golang-sdk:
         source: CipherSwarm_agent_api
         sourceNamespace: cipher-swarm-agent-api
-        sourceRevisionDigest: sha256:abb0a124fd1e548164b96b8e56803106daadc61116cecc0042426a24ea65afb4
-        sourceBlobDigest: sha256:756d43108a60dd436d2afd7c659609e4608fe45f36b01bf6be1ed50d1db7f83b
-        outLocation: /github/workspace/repo
+        sourceRevisionDigest: sha256:f9787ad737cfb6a94a7230bcfabc8f5edd188432525efd4b67ddc7bb8f1a0e2e
+        sourceBlobDigest: sha256:93c3f31880777a5d06b7df353d9dffb8066729999e96794680edd65284d8c216
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -20,9 +20,30 @@ Prerequisites
 - Go 1.16 or later
 - A working installation of the CipherSwarm platform. Refer to the [CipherSwarm documentation](https://github.com/unclesp1d3r/CipherSwarm) for setup instructions.
 
+<!-- Start Summary [summary] -->
+## Summary
+
+CipherSwarm Agent API: The CipherSwarm Agent API is used to allow agents to connect to the CipherSwarm server.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [SDK Installation](#sdk-installation)
+* [SDK Example Usage](#sdk-example-usage)
+* [Available Resources and Operations](#available-resources-and-operations)
+* [Retries](#retries)
+* [Error Handling](#error-handling)
+* [Server Selection](#server-selection)
+* [Custom HTTP Client](#custom-http-client)
+* [Authentication](#authentication)
+* [Special Types](#special-types)
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+To add the SDK as a dependency to your project:
 ```bash
 go get github.com/unclesp1d3r/cipherswarm-agent-sdk-go
 ```
@@ -46,9 +67,9 @@ func main() {
 	s := cipherswarmagentsdkgo.New(
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -63,6 +84,9 @@ func main() {
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
+<details open>
+<summary>Available methods</summary>
+
 ### [Agents](docs/sdks/agents/README.md)
 
 * [GetAgent](docs/sdks/agents/README.md#getagent) - Gets an instance of an agent
@@ -77,6 +101,12 @@ func main() {
 * [GetAttack](docs/sdks/attacks/README.md#getattack) - show attack
 * [GetHashList](docs/sdks/attacks/README.md#gethashlist) - Get the hash list
 
+
+### [Client](docs/sdks/client/README.md)
+
+* [GetConfiguration](docs/sdks/client/README.md#getconfiguration) - Get Agent Configuration
+* [Authenticate](docs/sdks/client/README.md#authenticate) - Authenticate Client
+
 ### [Crackers](docs/sdks/crackers/README.md)
 
 * [CheckForCrackerUpdate](docs/sdks/crackers/README.md#checkforcrackerupdate) - Check for Cracker Update
@@ -92,10 +122,7 @@ func main() {
 * [SetTaskAbandoned](docs/sdks/tasks/README.md#settaskabandoned) - Abandon Task
 * [GetTaskZaps](docs/sdks/tasks/README.md#gettaskzaps) - Get Completed Hashes
 
-### [Client](docs/sdks/client/README.md)
-
-* [GetConfiguration](docs/sdks/client/README.md#getconfiguration) - Get Agent Configuration
-* [Authenticate](docs/sdks/client/README.md#authenticate) - Authenticate Client
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Error Handling [errors] -->
@@ -125,9 +152,9 @@ func main() {
 	s := cipherswarmagentsdkgo.New(
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 
 		var e *sdkerrors.ErrorObject
@@ -175,9 +202,9 @@ func main() {
 		cipherswarmagentsdkgo.WithServerIndex(1),
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -212,9 +239,9 @@ func main() {
 		cipherswarmagentsdkgo.WithServerURL("https://{defaultHost}"),
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -280,9 +307,9 @@ func main() {
 	s := cipherswarmagentsdkgo.New(
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -321,9 +348,9 @@ func main() {
 	s := cipherswarmagentsdkgo.New(
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id, operations.WithRetries(
+	res, err := s.Agents.GetAgent(ctx, 135003, operations.WithRetries(
 		retry.Config{
 			Strategy: "backoff",
 			Backoff: &retry.BackoffStrategy{
@@ -370,9 +397,9 @@ func main() {
 			}),
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/RELEASES.md b/RELEASES.md
@@ -268,4 +268,14 @@ Based on:
 ### Generated
 - [go v0.8.3] .
 ### Releases
-- [Go v0.8.3] https://github.com/unclesp1d3r/cipherswarm-agent-sdk-go/releases/tag/v0.8.3 - .
+- [Go v0.8.3] https://github.com/unclesp1d3r/cipherswarm-agent-sdk-go/releases/tag/v0.8.3 - .
+
+## 2024-09-20 00:25:26
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.400.1 (2.420.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [go v0.8.4] .
+### Releases
+- [Go v0.8.4] https://github.com/unclesp1d3r/cipherswarm-agent-sdk-go/releases/tag/v0.8.4 - .
diff --git a/USAGE.md b/USAGE.md
@@ -12,9 +12,9 @@ func main() {
 	s := cipherswarmagentsdkgo.New(
 		cipherswarmagentsdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
 	)
-	var id int64 = 135003
+
 	ctx := context.Background()
-	res, err := s.Agents.GetAgent(ctx, id)
+	res, err := s.Agents.GetAgent(ctx, 135003)
 	if err != nil {
 		log.Fatal(err)
 	}