Merge pull request #988 from neuroglia-io/feat-add-use-cases

Add use cases and examples

Author: cdavernas

README.md

@@ -109,8 +109,11 @@ It is a member project of the [CNCF Serverless Working Group](https://github.com
 ## Documentation
 
 The documentation for Serverless Workflow includes:
+
 - [**DSL**](dsl.md): Documents the fundamentals aspects and concepts of the Serverless Workflow DSL
 - [**DSL Reference**](dsl-reference.md): References all the definitions used by the Serverless Workflow DSL
+- [**Examples**](./examples/README.md): A collection of practical examples demonstrating specific features and functionalities of Serverless Workflow.
+- [**Use Cases**](./use-cases/README.md): Detailed use cases illustrating how Serverless Workflow can be applied in various real-world scenarios.
 
 ## Community
 

dsl-reference.md

@@ -1451,7 +1451,7 @@ Defines the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807)
 |----------|:----:|:--------:|-------------|
 | type | [`uri-template`](#uri-template) | `yes` | A URI reference that identifies the [`error`](#error) type. <br><u>For cross-compatibility concerns, it is strongly recommended to use [Standard Error Types](#standard-error-types) whenever possible.<u><br><u>Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error).<u> |
 | status | `integer` | `yes` | The status code generated by the origin for this occurrence of the [`error`](#error).<br><u>For cross-compatibility concerns, it is strongly recommended to use [HTTP Status Codes](https://datatracker.ietf.org/doc/html/rfc7231#section-6) whenever possible.<u><br><u>Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error).<u> |
-| instance | `string` | `yes` | A [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) used to reference the component the [`error`](#error) originates from.<br><u>Runtimes **MUST** set the property when raising or escalating the [`error`](#error). Otherwise ignore.<u> |
+| instance | `string` | `no` | A [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) used to reference the component the [`error`](#error) originates from.<br><u>Runtimes **MUST** set the property when raising or escalating the [`error`](#error). Otherwise ignore.<u> |
 | title | `string` | `no` | A short, human-readable summary of the [`error`](#error). |
 | detail | `string` | `no` | A human-readable explanation specific to this occurrence of the [`error`](#error). |
 

examples/README.md

@@ -0,0 +1,11 @@
+# Examples
+
+Welcome to the Serverless Workflow Examples directory! This section contains a collection of brief YAML files, each representing a single workflow definition. 
+
+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 projects.
+
+## Contributing
+
+We welcome contributions! If you have an example demonstrating a unique feature or use case of Serverless Workflow, feel free to submit a pull request.
+
+For more detailed information on contributing, including guidelines and best practices, please refer to our [Contributing Guide](./CONTRIBUTING.md).

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

@@ -12,4 +12,4 @@ do:
           uri: https://petstore.swagger.io/v2/pet/1
           authentication:
             bearer:
-              token: ${ .token }
+              token: ${ .token }

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

@@ -0,0 +1,13 @@
+document:
+  dsl: '1.0.0'
+  namespace: samples
+  name: call-custom-function-cataloged
+  version: '1.0.0'
+do:
+  - log:
+      call: https://raw.githubusercontent.com/serverlessworkflow/catalog/main/functions/log/1.0.0/function.yaml
+      with:
+        message: Hello, world!
+        level: information
+        timestamp: true
+        format: '{TIMESTAMP} [{LEVEL}] ({CONTEXT}): {MESSAGE}'