Updated the Readme file

cdavernas · cdavernas · commit 50f05b51a27e · 2023-06-28T11:56:08.000+02:00
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ With the SDK, you can:
 
 | Latest Releases | Conformance to spec version |
 | :---: | :---: |
-| [0.8.0.10](https://github.com/serverlessworkflow/sdk-net/releases/) | [0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
+| [0.8.7](https://github.com/serverlessworkflow/sdk-net/releases/) | [0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
 
 ### Getting Started
 
@@ -107,6 +107,7 @@ which is a dynamic name/value mapping of properties used to enrich the serverles
 It has the advantage of being an easy, cross-compatible way of declaring additional data, but lacks well-defined, well-documented schema of the data, thus loosing the ability to validate it
 without custom implementation.
 
+*Adding metadata to a workflow:*
 ```csharp
 var workflow = new WorkflowBuilder()
     ...
@@ -115,6 +116,18 @@ var workflow = new WorkflowBuilder()
     .Build();
 ```
 
+*Resulting workflow:*
+
+```yaml
+id: sample-workflow
+version: 1.0.0
+specVersion: 0.8
+metadata:
+  metadataPropertyName: metadataPropertyValue #added to the metadata property of supporting components
+...
+```
+
+
 #### Extension
 
 Users have the ability to define extensions, providing the ability to extend, override or replace parts of the Serverless Workflow schema.
@@ -203,8 +216,35 @@ A [Json Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) is performed
 *Extending a workflow:*
 ```csharp
 var workflow = new WorkflowBuilder()
-    ...
+    .WithId("sample-extended")
+    .WithName("Sample Extended Workflow")
+    .WithVersion("1.0.0")
+    .UseSpecVersion(ServerlessWorkflowSpecVersion.V08)
     .UseExtension("extensionId", new Uri("file://.../extensions/greet-function-type.json"))
+    .StartsWith("do-work", flow => flow.Execute("greet", action => action
+        .Invoke(function => function
+            .OfType("greet")
+            .WithName("greet")
+            .ForOperation("#"))))
+    .End()
+    .Build();
+```
+
+*Adding extension properties:*
+```csharp
+var workflow = new WorkflowBuilder()
+    ...
+    .WithExtensionProperty("extensionPropertyName", propertyValue } })
     ...
     .Build();
+```
+
+*Resulting workflow:*
+
+```yaml
+id: sample-workflow
+version: 1.0.0
+specVersion: 0.8
+extensionPropertyName: propertyValue #added as top level property of extended component, as opposed to metadata
+...
 ```
diff --git a/src/ServerlessWorkflow.Sdk/ServerlessWorkflowSpecVersion.cs b/src/ServerlessWorkflow.Sdk/ServerlessWorkflowSpecVersion.cs
@@ -22,11 +22,11 @@ public static class ServerlessWorkflowSpecVersion
     /// <summary>
     /// Gets the v0.8 version
     /// </summary>
-    public const string VZero8 = "0.8";
+    public const string V08 = "0.8";
 
     /// <summary>
     /// Gets the latest version
     /// </summary>
-    public const string Latest = VZero8;
+    public const string Latest = V08;
 
 }
diff --git a/src/ServerlessWorkflow.Sdk/Services/FluentBuilders/Interfaces/IWorkflowBuilder.cs b/src/ServerlessWorkflow.Sdk/Services/FluentBuilders/Interfaces/IWorkflowBuilder.cs
@@ -60,7 +60,7 @@ public interface IWorkflowBuilder
     /// </summary>
     /// <param name="specVersion">The Serverless Workflow specification version</param>
     /// <returns>The configured <see cref="IWorkflowBuilder"/></returns>
-    IWorkflowBuilder WithSpecVersion(string specVersion);
+    IWorkflowBuilder UseSpecVersion(string specVersion);
 
     /// <summary>
     /// Sets the workflow definition's data input <see cref="JSchema"/> uri
diff --git a/src/ServerlessWorkflow.Sdk/Services/FluentBuilders/WorkflowBuilder.cs b/src/ServerlessWorkflow.Sdk/Services/FluentBuilders/WorkflowBuilder.cs
@@ -91,7 +91,7 @@ public virtual IWorkflowBuilder WithVersion(string version)
     }
 
     /// <inheritdoc/>
-    public virtual IWorkflowBuilder WithSpecVersion(string specVersion)
+    public virtual IWorkflowBuilder UseSpecVersion(string specVersion)
     {
         if (string.IsNullOrWhiteSpace(specVersion))
             throw new ArgumentNullException(nameof(specVersion));
diff --git a/tests/ServerlessWorkflow.Sdk.UnitTests/Cases/Validation/WorkflowValidationTests.cs b/tests/ServerlessWorkflow.Sdk.UnitTests/Cases/Validation/WorkflowValidationTests.cs
@@ -41,7 +41,7 @@ public async Task Validate_WorkflowDefinition_WithStateTypeExtensions_Should_Wor
             .WithId("fake")
             .WithName("Fake Workflow")
             .WithDescription("Fake Workflow Description")
-            .WithSpecVersion(ServerlessWorkflowSpecVersion.Latest)
+            .UseSpecVersion(ServerlessWorkflowSpecVersion.Latest)
             .WithVersion("1.0.0")
             .UseExtension("fake-extension", new($"file://{Path.Combine(AppContext.BaseDirectory, "Assets", "WorkflowExtensions", "condition-state-type.json")}"))
             .StartsWith("fake-state", flow => flow
@@ -68,7 +68,7 @@ public async Task Validate_WorkflowDefinition_WithFunctionTypeExtension_Should_W
             .WithId("fake")
             .WithName("Fake Workflow")
             .WithDescription("Fake Workflow Description")
-            .WithSpecVersion(ServerlessWorkflowSpecVersion.Latest)
+            .UseSpecVersion(ServerlessWorkflowSpecVersion.Latest)
             .WithVersion("1.0.0")
             .UseExtension("fake-extension", new($"file://{Path.Combine(AppContext.BaseDirectory, "Assets", "WorkflowExtensions", "greet-function-type.json")}"))
             .StartsWith("fake-state", flow => flow
diff --git a/tests/ServerlessWorkflow.Sdk.UnitTests/ServerlessWorkflow.Sdk.UnitTests.csproj b/tests/ServerlessWorkflow.Sdk.UnitTests/ServerlessWorkflow.Sdk.UnitTests.csproj
@@ -9,14 +9,14 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" Version="6.9.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
+    <PackageReference Include="FluentAssertions" Version="6.11.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/tests/ServerlessWorkflow.Sdk.UnitTests/Services/WorkflowDefinitionFactory.cs b/tests/ServerlessWorkflow.Sdk.UnitTests/Services/WorkflowDefinitionFactory.cs
@@ -22,7 +22,7 @@ public static WorkflowDefinition Create()
             .WithId("fake")
             .WithName("Fake Workflow")
             .WithDescription("Fake Workflow Description")
-            .WithSpecVersion(ServerlessWorkflowSpecVersion.Latest)
+            .UseSpecVersion(ServerlessWorkflowSpecVersion.Latest)
             .WithVersion("1.0.0")
             .WithAnnotation("fake-annotation: Fake value")
             .WithDataInputSchema(new Uri("https://tests.serverlessworkflow.io"))

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public virtual IWorkflowBuilder WithVersion(string version)`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`/// <inheritdoc/>`
`94`		`- public virtual IWorkflowBuilder WithSpecVersion(string specVersion)`
	`94`	`+ public virtual IWorkflowBuilder UseSpecVersion(string specVersion)`
`95`	`95`	`{`
`96`	`96`	`if (string.IsNullOrWhiteSpace(specVersion))`
`97`	`97`	`throw new ArgumentNullException(nameof(specVersion));`