Skip to content

Latest commit

 

History

History
606 lines (385 loc) · 15.7 KB

NodeServiceApi.md

File metadata and controls

606 lines (385 loc) · 15.7 KB

\NodeServiceApi

All URIs are relative to http://api.madana.io/rest

Method HTTP request Description
CreateNode Post /nodes/v2
GetBootstrap Get /nodes/bootstrap
GetNodeLicenses Get /nodes/licenses
GetNodeV2 Get /nodes/v2/{ident}
GetNodes2 Get /nodes
GetNodesV2 Get /nodes/v2 Returns UUIDs of existing analyses.
KillNode Post /nodes/v2/{ident}/kill
PostNodeInfo Post /nodes
PostNodeInfo_0 Post /nodes/create

CreateNode

*os.File CreateNode(ctx).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    body := *openapiclient.NewJsonNodeRunRequest() // JsonNodeRunRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.CreateNode(context.Background()).Body(body).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.CreateNode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateNode`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.CreateNode`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateNodeRequest struct via the builder pattern

Name Type Description Notes
body JsonNodeRunRequest

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBootstrap

*os.File GetBootstrap(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.GetBootstrap(context.Background()).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.GetBootstrap``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetBootstrap`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.GetBootstrap`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetBootstrapRequest struct via the builder pattern

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeLicenses

*os.File GetNodeLicenses(ctx).Active(active).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    active := "active_example" // string |  (optional) (default to "true")

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.GetNodeLicenses(context.Background()).Active(active).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.GetNodeLicenses``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNodeLicenses`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.GetNodeLicenses`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetNodeLicensesRequest struct via the builder pattern

Name Type Description Notes
active string [default to "true"]

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeV2

*os.File GetNodeV2(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.GetNodeV2(context.Background(), ident).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.GetNodeV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNodeV2`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.GetNodeV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string

Other Parameters

Other parameters are passed through a pointer to a apiGetNodeV2Request struct via the builder pattern

Name Type Description Notes

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodes2

*os.File GetNodes2(ctx).Owner(owner).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    owner := "owner_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.GetNodes2(context.Background()).Owner(owner).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.GetNodes2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNodes2`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.GetNodes2`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetNodes2Request struct via the builder pattern

Name Type Description Notes
owner string

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodesV2

*os.File GetNodesV2(ctx).Authorization(authorization).Created(created).Limit(limit).Offset(offset).Status(status).Execute()

Returns UUIDs of existing analyses.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    authorization := "authorization_example" // string | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c (optional)
    created := "created_example" // string | - if Queryparam \"created=true\" only the UUIDs of own Requests are shown (optional) (default to "true")
    limit := "limit_example" // string | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row (optional) (default to "30")
    offset := "offset_example" // string | Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row (optional) (default to "0")
    status := "status_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.GetNodesV2(context.Background()).Authorization(authorization).Created(created).Limit(limit).Offset(offset).Status(status).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.GetNodesV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNodesV2`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.GetNodesV2`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetNodesV2Request struct via the builder pattern

Name Type Description Notes
authorization string Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
created string - if Queryparam "created=true" only the UUIDs of own Requests are shown [default to "true"]
limit string Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [default to "30"]
offset string Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [default to "0"]
status string

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KillNode

*os.File KillNode(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.KillNode(context.Background(), ident).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.KillNode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `KillNode`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.KillNode`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string

Other Parameters

Other parameters are passed through a pointer to a apiKillNodeRequest struct via the builder pattern

Name Type Description Notes

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostNodeInfo

*os.File PostNodeInfo(ctx).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    body := *openapiclient.NewJsonNodeInfo() // JsonNodeInfo |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.PostNodeInfo(context.Background()).Body(body).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.PostNodeInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PostNodeInfo`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.PostNodeInfo`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostNodeInfoRequest struct via the builder pattern

Name Type Description Notes
body JsonNodeInfo

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostNodeInfo_0

*os.File PostNodeInfo_0(ctx).Body(body).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    body := *openapiclient.NewJsonNodeRunRequest() // JsonNodeRunRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeServiceApi.PostNodeInfo_0(context.Background()).Body(body).Execute()
    if err.Error() != "" {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeServiceApi.PostNodeInfo_0``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PostNodeInfo_0`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `NodeServiceApi.PostNodeInfo_0`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostNodeInfo_1Request struct via the builder pattern

Name Type Description Notes
body JsonNodeRunRequest

Return type

*os.File

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]