Skip to content
This repository has been archived by the owner on Apr 4, 2023. It is now read-only.

Latest commit

 

History

History
161 lines (106 loc) · 5.49 KB

VariablesApi.md

File metadata and controls

161 lines (106 loc) · 5.49 KB

{{classname}}

All URIs are relative to /

Method HTTP request Description
VariablesControllerCreate Post /v1/projects/{project}/variables Create a Variable
VariablesControllerFindAll Get /v1/projects/{project}/variables List Variables
VariablesControllerFindOne Get /v1/projects/{project}/variables/{key} Get a Variable
VariablesControllerRemove Delete /v1/projects/{project}/variables/{key} Delete a Variable
VariablesControllerUpdate Patch /v1/projects/{project}/variables/{key} Update a Variable

VariablesControllerCreate

Variable VariablesControllerCreate(ctx, body, project) Create a Variable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateVariableDto
project Object A Project key or ID

Return type

Variable

Authorization

No authorization required

HTTP request headers

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

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

VariablesControllerFindAll

[]Variable VariablesControllerFindAll(ctx, project, optional) List Variables

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
project Object A Project key or ID
optional *VariablesApiVariablesControllerFindAllOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a VariablesApiVariablesControllerFindAllOpts 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| | feature | optional.String| | type_ | optional.String| |

Return type

[]Variable

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]

VariablesControllerFindOne

Variable VariablesControllerFindOne(ctx, key, project) Get a Variable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
key string A Variable key or ID
project Object A Project key or ID

Return type

Variable

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]

VariablesControllerRemove

VariablesControllerRemove(ctx, key, project) Delete a Variable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
key string A Variable key or ID
project Object A Project key or ID

Return type

(empty response body)

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]

VariablesControllerUpdate

Variable VariablesControllerUpdate(ctx, body, key, project) Update a Variable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UpdateVariableDto
key string A Variable key or ID
project Object A Project key or ID

Return type

Variable

Authorization

No authorization required

HTTP request headers

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

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