Skip to content

Commit eb31542

Browse files
committed
- Added a new README.md to the examples directory
- Fixed and renamed examples - Added new examples Signed-off-by: Charles d'Avernas <[email protected]>
1 parent 430f5cc commit eb31542

25 files changed

+388
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,11 @@ It is a member project of the [CNCF Serverless Working Group](https://github.com
109109
## Documentation
110110

111111
The documentation for Serverless Workflow includes:
112+
112113
- [**DSL**](dsl.md): Documents the fundamentals aspects and concepts of the Serverless Workflow DSL
113114
- [**DSL Reference**](dsl-reference.md): References all the definitions used by the Serverless Workflow DSL
115+
- [**Examples**](./examples/README.md): A collection of practical examples demonstrating specific features and functionalities of Serverless Workflow.
116+
- [**Use Cases**](./use-cases/README.md): Detailed use cases illustrating how Serverless Workflow can be applied in various real-world scenarios.
114117

115118
## Community
116119

examples/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Examples
2+
3+
Welcome to the Serverless Workflow Examples directory! This section contains a collection of brief YAML files, each representing a single workflow definition.
4+
5+
These examples are designed to demonstrate specific features and functionalities of the Serverless Workflow DSL. They serve as a practical reference to help you understand and implement different aspects of Serverless Workflows in your own projects.
6+
7+
## Contributing
8+
9+
We welcome contributions! If you have an example that demonstrates a unique feature or use case of Serverless Workflow, feel free to submit a pull request.
10+
11+
For more detailed information on how to contribute, including guidelines and best practices, please refer to our [Contributing Guide](./CONTRIBUTING.md).

examples/bearer-auth-uri-format.yaml renamed to examples/authentication-bearer.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ do:
1212
uri: https://petstore.swagger.io/v2/pet/1
1313
authentication:
1414
bearer:
15-
token: ${ .token }
15+
token: ${ .token }
File renamed without changes.
File renamed without changes.
File renamed without changes.

examples/call-custom-function.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
document:
2+
dsl: '1.0.0'
3+
namespace: samples
4+
name: call-custom-function
5+
version: '1.0.0'
6+
do:
7+
- log:
8+
call: https://raw.githubusercontent.com/serverlessworkflow/catalog/main/functions/log/1.0.0/function.yaml
9+
with:
10+
message: Hello, world!
11+
level: information
12+
timestamp: true
13+
format: '{TIMESTAMP} [{LEVEL}] ({CONTEXT}): {MESSAGE}'

examples/call-grpc.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
document:
2+
dsl: '1.0.0-alpha1'
3+
namespace: test
4+
name: grpc-example
5+
version: '0.1.0'
6+
do:
7+
- greet:
8+
call: grpc
9+
with:
10+
proto:
11+
endpoint: file://app/greet.proto
12+
service:
13+
name: GreeterApi.Greeter
14+
host: localhost
15+
port: 5011
16+
method: SayHello
17+
arguments:
18+
name: ${ .user.preferredDisplayName }

0 commit comments

Comments
 (0)