Skip to content

Commit

Permalink
Update docs for new Arguments method in Func interface
Browse files Browse the repository at this point in the history
  • Loading branch information
viveksinghggits committed Feb 22, 2022
1 parent 2fa4d8c commit 477487b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ implements the following go interface:
Name() string
Exec(ctx context.Context, args ...string) (map[string]interface{}, error)
RequiredArgs() []string
Arguments() []string
}
Kanister Functions are registered by the return value of ``Name()``, which must be
Expand All @@ -24,7 +25,9 @@ a ``BlueprintPhase`` is used to lookup a Kanister Function. After
``BlueprintPhase.Args`` are rendered, they are passed into the Kanister Function's
``Exec()`` method.

The ``RequiredArgs`` method returns the list of argument names that are required.
The ``RequiredArgs`` method returns the list of argument names that are required. And
``Arguments`` method returns the list of all the argument names that are supported
by the function.

Existing Functions
==================
Expand Down

0 comments on commit 477487b

Please sign in to comment.