All URIs are relative to /
| Method | HTTP request | Description |
|---|---|---|
| ProjectsControllerCreate | Post /v1/projects | Create Project |
| ProjectsControllerFindAll | Get /v1/projects | List Projects |
| ProjectsControllerFindOne | Get /v1/projects/{key} | Get a Project |
| ProjectsControllerRemove | Delete /v1/projects/{key} | Delete a Project |
| ProjectsControllerUpdate | Patch /v1/projects/{key} | Update a Project |
Project ProjectsControllerCreate(ctx, body) Create Project
Create a new Project
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | CreateProjectDto |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Project ProjectsControllerFindAll(ctx, optional) List Projects
List Projects
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ProjectsApiProjectsControllerFindAllOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ProjectsApiProjectsControllerFindAllOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.Float64 | [default to 1] | |
| perPage | optional.Float64 | [default to 100] | |
| sortBy | optional.String | [default to createdAt] | |
| sortOrder | optional.String | [default to desc] | |
| search | optional.String | ||
| createdBy | optional.String |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Project ProjectsControllerFindOne(ctx, key) Get a Project
Get a Project by ID or key
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | string | A Project key or ID |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProjectsControllerRemove(ctx, key) Delete a Project
Delete a Project by ID or key
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | string | A Project key or ID |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Project ProjectsControllerUpdate(ctx, body, key) Update a Project
Update a Project by ID or key
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | UpdateProjectDto | ||
| key | string | A Project key or ID |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]