From 0d9c2873c1835b06af300a25b6413928c86b19de Mon Sep 17 00:00:00 2001 From: debugtalk Date: Wed, 8 Dec 2021 14:29:15 +0800 Subject: [PATCH] docs: add description for interfaces --- models.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/models.go b/models.go index 4d63e509..5b840044 100644 --- a/models.go +++ b/models.go @@ -78,20 +78,25 @@ type TCase struct { TestSteps []*TStep `json:"teststeps" yaml:"teststeps"` } -// IConfig represents interface for testcase config. +// IConfig represents interface for testcase config, +// includes Config. type IConfig interface { Name() string ToStruct() *TConfig } -// IStep represents interface for all types for teststeps. +// IStep represents interface for all types for teststeps, includes: +// StepRequest, StepRequestWithOptionalArgs, StepRequestValidation, StepRequestExtraction, +// StepTestCaseWithOptionalArgs, +// StepTransaction, StepRendezvous. type IStep interface { Name() string Type() string ToStruct() *TStep } -// ITestCase represents interface for all types for testcases. +// ITestCase represents interface for testcases, +// includes TestCase and TestCasePath. type ITestCase interface { ToTestCase() (*TestCase, error) ToTCase() (*TCase, error)