Test Executor API

team@openapitools.org v1 :numbered: :toclevels: 3 :source-highlighter: highlightjs :keywords: openapi, rest, Test Executor API :specDir: :snippetDir: :generator-template: v1 2019-12-20 :info-url: openapi-generator.tech :app-name: Test Executor API

Endpoints

ExecutorController

addStory

POST /stories/add-story

Description
Parameters
Form Parameters
Name Description Required Default Pattern

file

[file]

X

null
Query Parameters
Name Description Required Default Pattern

tag

X

null
Return Type

AddStoryResponseDTO

Content Type

  • application/json

Responses
http response codes
Code Message Datatype

200

OK

AddStoryResponseDTO
Samples

getReport

GET /stories/report

Description
Parameters
Return Type

JsonReportDTO

Content Type

  • application/json

Responses
http response codes
Code Message Datatype

200

OK

JsonReportDTO
Samples

getStories

GET /stories/get-stories

Description
Parameters
Query Parameters
Name Description Required Default Pattern

tag

-

null
Return Type

StoryDirectoryDTO

Content Type

  • application/json

Responses
http response codes
Code Message Datatype

200

OK

StoryDirectoryDTO
Samples

getStoryDetail

GET /stories/story-detail

Description
Parameters
Query Parameters
Name Description Required Default Pattern

name

X

null
Return Type

[String]

Content Type

  • text/plain

Responses
http response codes
Code Message Datatype

200

OK

[String]

404

The file cannot be found

[String]
Samples

runStories

POST /stories/run-stories

Description
Parameters
Query Parameters
Name Description Required Default Pattern

tag

-

null

name

-

null
Return Type

RunStoriesResponseDTO

Content Type

  • application/json

Responses
http response codes
Code Message Datatype

200

OK

RunStoriesResponseDTO
Samples

Models

AddStoryResponseDTO

Field Name Required Type Description Format

status

String

Enum: SUCCESS, SUBMITTED, FAILURE, RUN_IN_PROGRESS,

failures

List of [string]

JSONObject

Field Name Required Type Description Format

empty

Boolean

JsonReportDTO

Field Name Required Type Description Format

status

String

Enum: SUCCESS, SUBMITTED, FAILURE, RUN_IN_PROGRESS,

error

String

reports

List of JSONObject

RunStoriesResponseDTO

Field Name Required Type Description Format

status

String

Enum: SUCCESS, SUBMITTED, FAILURE, RUN_IN_PROGRESS,

StoryDirectoryDTO

Field Name Required Type Description Format

name

String

subdirectories

List of StoryDirectoryDTO

fileNames

List of [string]