Skip to content

Latest commit

 

History

History
350 lines (220 loc) · 8.55 KB

File metadata and controls

350 lines (220 loc) · 8.55 KB

\ProjectsAPI

All URIs are relative to https://nitrozen.io/api/v1

Method HTTP request Description
ProjectsGet Get /projects List projects
ProjectsPost Post /projects Create a project
ProjectsProjectDelete Delete /projects/{project} Delete a project
ProjectsProjectGet Get /projects/{project} Get a project
ProjectsProjectPut Put /projects/{project} Update a project

ProjectsGet

ProjectsGet200Response ProjectsGet(ctx).Execute()

List projects

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/nitrozenio/nitrozen-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`: ProjectsGet200Response
	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

ProjectsGet200Response

Authorization

BearerAuth

HTTP request headers

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

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

ProjectsPost

ProjectsPost201Response ProjectsPost(ctx).ProjectInput(projectInput).Execute()

Create a project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/nitrozenio/nitrozen-go"
)

func main() {
	projectInput := *openapiclient.NewProjectInput("Name_example") // ProjectInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProjectsAPI.ProjectsPost(context.Background()).ProjectInput(projectInput).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`: ProjectsPost201Response
	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
projectInput ProjectInput

Return type

ProjectsPost201Response

Authorization

BearerAuth

HTTP request headers

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

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

ProjectsProjectDelete

ProjectsProjectDelete(ctx, project).Execute()

Delete a project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/nitrozenio/nitrozen-go"
)

func main() {
	project := int32(56) // int32 | Project ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ProjectsAPI.ProjectsProjectDelete(context.Background(), project).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProjectsAPI.ProjectsProjectDelete``: %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.
project int32 Project ID

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

ProjectsProjectGet

ProjectsPost201Response ProjectsProjectGet(ctx, project).Execute()

Get a project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/nitrozenio/nitrozen-go"
)

func main() {
	project := int32(56) // int32 | Project ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
project int32 Project ID

Other Parameters

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

Name Type Description Notes

Return type

ProjectsPost201Response

Authorization

BearerAuth

HTTP request headers

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

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

ProjectsProjectPut

ProjectsPost201Response ProjectsProjectPut(ctx, project).ProjectInput(projectInput).Execute()

Update a project

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/nitrozenio/nitrozen-go"
)

func main() {
	project := int32(56) // int32 | Project ID
	projectInput := *openapiclient.NewProjectInput("Name_example") // ProjectInput | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
project int32 Project ID

Other Parameters

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

Name Type Description Notes

projectInput | ProjectInput | |

Return type

ProjectsPost201Response

Authorization

BearerAuth

HTTP request headers

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

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