Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,50 @@ paths:
default:
$ref: '../result/request.yaml#/components/responses/Failure'
x-field-uid: 2
/config/append:
patch:
tags: ['Configuration']
operationId: append_config
description: >-
Append new attributes of resources to existing configuration on the traffic generator.
Resource names should not be part of existing configuration of that resource type;
it should be unique for the operation to succeed.
The fetched configuration shall also reflect the new configuration applied successfully.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../config/append.yaml#/components/schemas/Config.Append'
responses:
'200':
$ref: '../result/request.yaml#/components/responses/Success'
x-field-uid: 1
default:
$ref: '../result/request.yaml#/components/responses/Failure'
x-field-uid: 2
/config/delete:
patch:
tags: ['Configuration']
operationId: delete_config
description: >-
Delete attributes of resources from existing configuration on the traffic generator.
Resource names should already be part of existing configuration of that resource type;
for the operation to succeed.
The fetched configuration shall not reflect the removed configuration deleted successfully.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../config/delete.yaml#/components/schemas/Config.Delete'
responses:
'200':
$ref: '../result/request.yaml#/components/responses/Success'
x-field-uid: 1
default:
$ref: '../result/request.yaml#/components/responses/Failure'
x-field-uid: 2
/control/state:
post:
tags: ['Control']
Expand Down
41 changes: 32 additions & 9 deletions artifacts/openapi.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions artifacts/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

73 changes: 73 additions & 0 deletions artifacts/otg.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions config/append.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
components:
schemas:
Config.Append:
description: |-
A container for all configuration resources of various types to be appended.
type: array
items:
$ref: '#/components/schemas/Config.AppendResource'
x-field-uid: 1
Config.AppendResource:
description: |-
A container for an existing resource to be appended.
type: object
required:
- choice
properties:
choice:
type: string
x-enum:
flows:
x-field-uid: 1
x-field-uid: 1
flows:
description: |-
The flows that will be added to existing configuration on the traffic generator.
The flow name must not already be used in existing configuration.
type: array
items:
$ref: '../flow/flow.yaml#/components/schemas/Flow'
x-field-uid: 2
31 changes: 31 additions & 0 deletions config/delete.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
components:
schemas:
Config.Delete:
description: |-
A container for all configuration resources of various types to be deleted.
type: array
items:
$ref: '#/components/schemas/Config.DeleteResource'
x-field-uid: 1
Config.DeleteResource:
description: |-
A container for an existing resource to be deleted.
type: object
required:
- choice
properties:
choice:
type: string
x-enum:
flows:
x-field-uid: 1
x-field-uid: 1
flows:
description: |-
List of flows that will be deleted from existing configuration on the traffic generator.
type: array
items:
type: string
x-constraint:
- '/components/schemas/Flow/properties/name'
x-field-uid: 2
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
click==8.0.4
openapiart==0.3.21
openapiart==0.3.22
Loading