Skip to content

Commit

Permalink
feature: update api v2 client
Browse files Browse the repository at this point in the history
  • Loading branch information
gibiw committed Oct 30, 2024
1 parent a3136a8 commit adf1bb8
Show file tree
Hide file tree
Showing 9 changed files with 947 additions and 200 deletions.
33 changes: 2 additions & 31 deletions qase-api-v2-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,39 +78,9 @@ ctx = context.WithValue(context.Background(), api_v2_client.ContextOperationServ
})
```

## Example

```go
package main

import (
"context"
"fmt"

api_v2_client "github.com/qase-tms/qase-go/qase-api-v2-client"
)

func main() {
ctx := context.WithValue(context.Background(), api_v2_client.ContextAPIKeys, map[string]api_v2_client.APIKey{
"TokenAuth": {
Key: "<TOKEN>",
},
})

configuration := api_v2_client.NewConfiguration()
apiClient := api_v2_client.NewAPIClient(configuration)

_, err := apiClient.ResultsAPI.ResultCreate(ctx, ResultCreate{}).Execute()
if err != nil {
fmt.Println(err)
return
}
}
```

## Documentation for API Endpoints

All URIs are relative to *<https://api.qase.io/v2>*
All URIs are relative to *https://api.qase.io/v2*

Class | Method | HTTP request | Description
--------------|-----------------------------------------------------------|-----------------------------------------------|------------------------------------
Expand All @@ -127,6 +97,7 @@ All URIs are relative to *<https://api.qase.io/v2>*
- [RelationSuite](docs/RelationSuite.md)
- [RelationSuiteItem](docs/RelationSuiteItem.md)
- [ResultCreate](docs/ResultCreate.md)
- [ResultCreateFields](docs/ResultCreateFields.md)
- [ResultExecution](docs/ResultExecution.md)
- [ResultRelations](docs/ResultRelations.md)
- [ResultStep](docs/ResultStep.md)
Expand Down
106 changes: 40 additions & 66 deletions qase-api-v2-client/docs/ResultCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ Name | Type | Description | Notes
**Signature** | Pointer to **string** | | [optional]
**TestopsId** | Pointer to **NullableInt64** | | [optional]
**Execution** | [**ResultExecution**](ResultExecution.md) | |
**Fields** | Pointer to **map[string]string** | | [optional]
**Fields** | Pointer to [**ResultCreateFields**](ResultCreateFields.md) | | [optional]
**Attachments** | Pointer to **[]string** | | [optional]
**Steps** | Pointer to [**[]ResultStep**](ResultStep.md) | | [optional]
**StepsType** | Pointer to [**NullableResultStepsType**](ResultStepsType.md) | | [optional]
**Params** | Pointer to **map[string]string** | | [optional]
**Author** | Pointer to **string** | | [optional]
**ParamGroups** | Pointer to **[][]string** | List parameter groups by name only. Add their values in the &#39;params&#39; field | [optional]
**Relations** | Pointer to [**NullableResultRelations**](ResultRelations.md) | | [optional]
**Muted** | Pointer to **bool** | | [optional]
**Message** | Pointer to **NullableString** | | [optional]
**CreatedAt** | Pointer to **NullableFloat64** | | [optional]
**Defect** | Pointer to **bool** | If true and the result is failed, the defect associated with the result will be created | [optional]

## Methods

Expand Down Expand Up @@ -166,20 +165,20 @@ SetExecution sets Execution field to given value.

### GetFields

`func (o *ResultCreate) GetFields() map[string]string`
`func (o *ResultCreate) GetFields() ResultCreateFields`

GetFields returns the Fields field if non-nil, zero value otherwise.

### GetFieldsOk

`func (o *ResultCreate) GetFieldsOk() (*map[string]string, bool)`
`func (o *ResultCreate) GetFieldsOk() (*ResultCreateFields, bool)`

GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetFields

`func (o *ResultCreate) SetFields(v map[string]string)`
`func (o *ResultCreate) SetFields(v ResultCreateFields)`

SetFields sets Fields field to given value.

Expand Down Expand Up @@ -299,31 +298,41 @@ SetParams sets Params field to given value.

HasParams returns a boolean if a field has been set.

### GetAuthor
### GetParamGroups

`func (o *ResultCreate) GetAuthor() string`
`func (o *ResultCreate) GetParamGroups() [][]string`

GetAuthor returns the Author field if non-nil, zero value otherwise.
GetParamGroups returns the ParamGroups field if non-nil, zero value otherwise.

### GetAuthorOk
### GetParamGroupsOk

`func (o *ResultCreate) GetAuthorOk() (*string, bool)`
`func (o *ResultCreate) GetParamGroupsOk() (*[][]string, bool)`

GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise
GetParamGroupsOk returns a tuple with the ParamGroups field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetAuthor
### SetParamGroups

`func (o *ResultCreate) SetAuthor(v string)`
`func (o *ResultCreate) SetParamGroups(v [][]string)`

SetAuthor sets Author field to given value.
SetParamGroups sets ParamGroups field to given value.

### HasAuthor
### HasParamGroups

`func (o *ResultCreate) HasAuthor() bool`
`func (o *ResultCreate) HasParamGroups() bool`

HasAuthor returns a boolean if a field has been set.
HasParamGroups returns a boolean if a field has been set.

### SetParamGroupsNil

`func (o *ResultCreate) SetParamGroupsNil(b bool)`

SetParamGroupsNil sets the value for ParamGroups to be an explicit nil

### UnsetParamGroups
`func (o *ResultCreate) UnsetParamGroups()`

UnsetParamGroups ensures that no value is present for ParamGroups, not even an explicit nil
### GetRelations

`func (o *ResultCreate) GetRelations() ResultRelations`
Expand Down Expand Up @@ -359,31 +368,6 @@ HasRelations returns a boolean if a field has been set.
`func (o *ResultCreate) UnsetRelations()`

UnsetRelations ensures that no value is present for Relations, not even an explicit nil
### GetMuted

`func (o *ResultCreate) GetMuted() bool`

GetMuted returns the Muted field if non-nil, zero value otherwise.

### GetMutedOk

`func (o *ResultCreate) GetMutedOk() (*bool, bool)`

GetMutedOk returns a tuple with the Muted field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetMuted

`func (o *ResultCreate) SetMuted(v bool)`

SetMuted sets Muted field to given value.

### HasMuted

`func (o *ResultCreate) HasMuted() bool`

HasMuted returns a boolean if a field has been set.

### GetMessage

`func (o *ResultCreate) GetMessage() string`
Expand Down Expand Up @@ -419,41 +403,31 @@ HasMessage returns a boolean if a field has been set.
`func (o *ResultCreate) UnsetMessage()`

UnsetMessage ensures that no value is present for Message, not even an explicit nil
### GetCreatedAt
### GetDefect

`func (o *ResultCreate) GetCreatedAt() float64`
`func (o *ResultCreate) GetDefect() bool`

GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.
GetDefect returns the Defect field if non-nil, zero value otherwise.

### GetCreatedAtOk
### GetDefectOk

`func (o *ResultCreate) GetCreatedAtOk() (*float64, bool)`
`func (o *ResultCreate) GetDefectOk() (*bool, bool)`

GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise
GetDefectOk returns a tuple with the Defect field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetCreatedAt

`func (o *ResultCreate) SetCreatedAt(v float64)`

SetCreatedAt sets CreatedAt field to given value.

### HasCreatedAt

`func (o *ResultCreate) HasCreatedAt() bool`
### SetDefect

HasCreatedAt returns a boolean if a field has been set.
`func (o *ResultCreate) SetDefect(v bool)`

### SetCreatedAtNil
SetDefect sets Defect field to given value.

`func (o *ResultCreate) SetCreatedAtNil(b bool)`
### HasDefect

SetCreatedAtNil sets the value for CreatedAt to be an explicit nil
`func (o *ResultCreate) HasDefect() bool`

### UnsetCreatedAt
`func (o *ResultCreate) UnsetCreatedAt()`
HasDefect returns a boolean if a field has been set.

UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading

0 comments on commit adf1bb8

Please sign in to comment.