This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
orchestrator-swagger-go-client/docs/UserAPI.md
2024-07-15 10:24:50 +02:00

1.8 KiB

\UserAPI

All URIs are relative to /api/v1

Method HTTP request Description
UserUserIdPut Put /user/{user_id} Initiates a scraping operation for the entire user

UserUserIdPut

UserUserIdPut(ctx, userId).Execute()

Initiates a scraping operation for the entire user

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "git.dragse.it/anthrove/orchestrator-swagger-go-client"
)

func main() {
	userId := "userId_example" // string | Anthrove UserID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UserAPI.UserUserIdPut(context.Background(), userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UserAPI.UserUserIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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