Skip to content

arcalot/arcaflow-plugin-example

Repository files navigation

Arcaflow Plugin Example Python

Operation

Download example.yaml from this repository.

Run the example.

cat example.yaml | docker run -i quay.io/arcalot/arcaflow-plugin-example -f -

Autogenerated Input/Output Documentation by Arcaflow-Docsgen Below

Hello world! (hello-world)

Says hello :)

Input

Type:scope
Root object:InputParams
Properties
name (one of[string])
Name:Name
Description:Who do we say hello to?
Required:Yes
Examples (JSON encoded):
{"_type": "fullname", "first_name": "Arca", "last_name": "Lot"}
{"_type": "nickname", "nick": "Arcalot"}
Type:one of[string]
Objects
FullName (object)
Type:object
Properties
first_name (string)
Name:First name
Required:Yes
Examples (JSON encoded):
"Arca"
Type:string
Minimum length:1
Must match pattern:^[a-zA-Z]+$
last_name (string)
Name:Last name
Required:Yes
Examples (JSON encoded):
"Lot"
Type:string
Minimum length:1
Must match pattern:^[a-zA-Z]+$
InputParams (object)
Type:object
Properties
name (one of[string])
Name:Name
Description:Who do we say hello to?
Required:Yes
Examples (JSON encoded):
{"_type": "fullname", "first_name": "Arca", "last_name": "Lot"}
{"_type": "nickname", "nick": "Arcalot"}
Type:one of[string]
Nickname (object)
Type:object
Properties
nick (string)
Name:Nickname
Required:Yes
Examples (JSON encoded):
"Arcalot"
Type:string
Minimum length:1
Must match pattern:^[a-zA-Z]+$

Outputs

error

Type:scope
Root object:ErrorOutput
Properties
error (string)
Required:Yes
Type:string
Objects
ErrorOutput (object)
Type:object
Properties
error (string)
Required:Yes
Type:string

success

Type:scope
Root object:SuccessOutput
Properties
message (string)
Required:Yes
Type:string
Objects
SuccessOutput (object)
Type:object
Properties
message (string)
Required:Yes
Type:string