ProjectsAPI.md

\ProjectsAPI

All URIs are relative to http://localhost:3000/api

Method	HTTP request	Description
ProjectsGet	Get /projects	Get projects
ProjectsPost	Post /projects	Create a new project
ProjectsRestorePost	Post /projects/restore	Restore Project

ProjectsGet

[]Project ProjectsGet(ctx).Execute()

Get projects

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/client-api/semaphore-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProjectsAPI.ProjectsGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProjectsAPI.ProjectsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ProjectsGet`: []Project
	fmt.Fprintf(os.Stdout, "Response from `ProjectsAPI.ProjectsGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]Project

Authorization

cookie, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain; charset=utf-8

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

ProjectsPost

Project ProjectsPost(ctx).Project(project).Execute()

Create a new project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/client-api/semaphore-go"
)

func main() {
	project := *openapiclient.NewProjectRequest() // ProjectRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProjectsAPI.ProjectsPost(context.Background()).Project(project).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProjectsAPI.ProjectsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ProjectsPost`: Project
	fmt.Fprintf(os.Stdout, "Response from `ProjectsAPI.ProjectsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
project	ProjectRequest

Return type

Project

Authorization

cookie, bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain; charset=utf-8

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

ProjectsRestorePost

Project ProjectsRestorePost(ctx).Backup(backup).Execute()

Restore Project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/client-api/semaphore-go"
)

func main() {
	backup := *openapiclient.NewProjectBackup() // ProjectBackup | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProjectsAPI.ProjectsRestorePost(context.Background()).Backup(backup).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProjectsAPI.ProjectsRestorePost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ProjectsRestorePost`: Project
	fmt.Fprintf(os.Stdout, "Response from `ProjectsAPI.ProjectsRestorePost`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
backup	ProjectBackup

Return type

Project

Authorization

cookie, bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain; charset=utf-8

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