diff --git a/.ci/validation/src/index.ts b/.ci/validation/src/index.ts index 744234a8..1b972e58 100644 --- a/.ci/validation/src/index.ts +++ b/.ci/validation/src/index.ts @@ -24,7 +24,7 @@ export module SWSchemaValidator { const ajv = new Ajv({ strict: false, allowUnionTypes: true }); addFormats(ajv); - const workflowSchemaId = "https://serverlessworkflow.io/schemas/1.0.3/workflow.yaml"; + const workflowSchemaId = "https://open-workflow-specification.org/schemas/1.0.3/workflow.yaml"; const schemaPath = "../../../schema"; export const defaultEncoding = "utf-8"; diff --git a/README.md b/README.md index ac2d02ff..69fba988 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/serverlessworkflow/specification/blob/master/LICENSE) [GitHub Release](https://github.com/serverlessworkflow/specification/releases/latest)
-[](https://serverlessworkflow.io/) -[](https://cloud-native.slack.com/messages/open-workflow) +[](https://open-workflow-specification.org/) +[](https://cloud-native.slack.com/messages/open-workflow) [](https://www.linkedin.com/company/serverless-workflow/) [](https://twitter.com/CNCFWorkflow) diff --git a/community/README.md b/community/README.md index 456e19b7..ecf322e7 100644 --- a/community/README.md +++ b/community/README.md @@ -4,4 +4,4 @@ Here you can find information about our: - [Contributors](contributors.md): People and companies contributing to the Serverless workflow specification and ecosystem -- [Presentations](https://serverlessworkflow.io/): Community presentations about the project (see the 'Resources' section) \ No newline at end of file +- [Presentations](https://open-workflow-specification.org/): Community presentations about the project (see the 'Resources' section) \ No newline at end of file diff --git a/ctk/features/raise.feature b/ctk/features/raise.feature index 1cdf4cf0..871783df 100644 --- a/ctk/features/raise.feature +++ b/ctk/features/raise.feature @@ -16,14 +16,14 @@ Feature: Raise Task raise: error: status: 400 - type: https://serverlessworkflow.io/errors/types/compliance + type: https://open-workflow-specification.org/errors/types/compliance title: Compliance Error """ When the workflow is executed Then the workflow should fault with error: """yaml status: 400 - type: https://serverlessworkflow.io/errors/types/compliance + type: https://open-workflow-specification.org/errors/types/compliance title: Compliance Error instance: /do/0/raiseError """ diff --git a/ctk/features/try.feature b/ctk/features/try.feature index 9de783fd..78c82e38 100644 --- a/ctk/features/try.feature +++ b/ctk/features/try.feature @@ -27,7 +27,7 @@ Feature: Try Task catch: errors: with: - type: https://serverlessworkflow.io/dsl/errors/types/communication + type: https://open-workflow-specification.org/dsl/errors/types/communication status: 404 as: err do: @@ -71,7 +71,7 @@ Feature: Try Task catch: errors: with: - type: https://serverlessworkflow.io/dsl/errors/types/communication + type: https://open-workflow-specification.org/dsl/errors/types/communication status: 503 as: err do: diff --git a/dsl-reference.md b/dsl-reference.md index d8973f7f..964a2118 100644 --- a/dsl-reference.md +++ b/dsl-reference.md @@ -504,7 +504,7 @@ The [A2A Call](#a2a-call) enables workflows to interact with AI agents described > [!NOTE] > The `security` and `securitySchemes` fields of the AgentCard contain authentication requirements and schemes for when communicating with the agent. > -> On success the output is the JSON-RPC result. On failure runtimes must raise an error with type [https://serverlessworkflow.io/spec/1.0.0/errors/runtime](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#standard-error-types). +> On success the output is the JSON-RPC result. On failure runtimes must raise an error with type [https://open-workflow-specification.org/spec/1.0.0/errors/runtime](#standard-error-types). > > For `message/stream` and `tasks/resubscribe` methods the output is a sequentially ordered array of all the result objects. @@ -550,7 +550,7 @@ The [MCP Call](#mcp-call) enables workflows to interact with [Model Context Prot > In most cases, client libraries handle this initialization automatically. > [!NOTE] -> On success the output of the call is the JSON-RPC result. On failure, runtimes must raise an error with type [https://serverlessworkflow.io/spec/1.0.0/errors/runtime](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#standard-error-types). +> On success the output of the call is the JSON-RPC result. On failure, runtimes must raise an error with type [https://open-workflow-specification.org/spec/1.0.0/errors/runtime](#standard-error-types). ###### Examples @@ -1228,7 +1228,7 @@ do: catch: errors: with: - type: https://serverlessworkflow.io.io/dsl/errors/types/communication + type: https://open-workflow-specification.org/dsl/errors/types/communication status: 503 as: error retry: @@ -1436,7 +1436,7 @@ The data carried by the cloud event that notifies that a workflow has faulted. name: orderPetWorkflow-ix7iryakiem8j.samples faultedAt: '2024-07-26T16:59:57-05:00' error: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication title: Service Not Available status: 503 ``` @@ -1623,7 +1623,7 @@ workflow: orderPetWorkflow-ix7iryakiem8j.samples task: '/do/1/initialize' faultedAt: '2024-07-26T16:59:57-05:00' error: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication title: Service Not Available status: 503 ``` @@ -2089,7 +2089,7 @@ Defines the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807) #### Examples ```yaml -type: https://serverlessworkflow.io/spec/1.0.0/errors/communication +type: https://open-workflow-specification.org/spec/1.0.0/errors/communication title: Service Not Available status: 503 ``` @@ -2100,14 +2100,14 @@ Standard error types serve the purpose of categorizing errors consistently acros | Type | Status¹ | Description | |------|:-------:|-------------| -| [https://serverlessworkflow.io/spec/1.0.0/errors/configuration](#) | `400` | Errors resulting from incorrect or invalid configuration settings, such as missing or misconfigured environment variables, incorrect parameter values, or configuration file errors. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/validation](#) | `400` | Errors arising from validation processes, such as validation of input data, schema validation failures, or validation constraints not being met. These errors indicate that the provided data or configuration does not adhere to the expected format or requirements specified by the workflow. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/expression](#) | `400` | Errors occurring during the evaluation of runtime expressions, such as invalid syntax or unsupported operations. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/authentication](#) | `401` | Errors related to authentication failures. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/authorization](#) | `403` | Errors related to unauthorized access attempts or insufficient permissions to perform certain actions within the workflow. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/timeout](#) | `408` | Errors caused by timeouts during the execution of tasks or during interactions with external services. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/communication](#) | `500` | Errors encountered while communicating with external services, including network errors, service unavailable, or invalid responses. | -| [https://serverlessworkflow.io/spec/1.0.0/errors/runtime](#) | `500` | Errors occurring during the runtime execution of a workflow, including unexpected exceptions, errors related to resource allocation, or failures in handling workflow tasks. These errors typically occur during the actual execution of workflow components and may require runtime-specific handling and resolution strategies. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/configuration](#) | `400` | Errors resulting from incorrect or invalid configuration settings, such as missing or misconfigured environment variables, incorrect parameter values, or configuration file errors. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/validation](#) | `400` | Errors arising from validation processes, such as validation of input data, schema validation failures, or validation constraints not being met. These errors indicate that the provided data or configuration does not adhere to the expected format or requirements specified by the workflow. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/expression](#) | `400` | Errors occurring during the evaluation of runtime expressions, such as invalid syntax or unsupported operations. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/authentication](#) | `401` | Errors related to authentication failures. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/authorization](#) | `403` | Errors related to unauthorized access attempts or insufficient permissions to perform certain actions within the workflow. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/timeout](#) | `408` | Errors caused by timeouts during the execution of tasks or during interactions with external services. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/communication](#) | `500` | Errors encountered while communicating with external services, including network errors, service unavailable, or invalid responses. | +| [https://open-workflow-specification.org/spec/1.0.0/errors/runtime](#) | `500` | Errors occurring during the runtime execution of a workflow, including unexpected exceptions, errors related to resource allocation, or failures in handling workflow tasks. These errors typically occur during the actual execution of workflow components and may require runtime-specific handling and resolution strategies. | ¹ *Default value. The `status code` that best describe the error should always be used.* @@ -2469,7 +2469,7 @@ To substitute a variable within a URI, use the `{}` syntax. The identifier insid This has the following limitations compared to runtime expressions: - Only top-level properties can be interpolated within strings, thus identifiers are treated verbatim. This means that `{pet.id}` will be replaced with the value of the `"pet.id"` property, not the value of the `id` property of the `pet` property. -- The referenced variable must be of type `string`, `number`, `boolean`, or `null`. If the variable is of a different type an error with type `https://https://serverlessworkflow.io/spec/1.0.0/errors/expression` and status `400` will be raised. +- The referenced variable must be of type `string`, `number`, `boolean`, or `null`. If the variable is of a different type an error with type `https://open-workflow-specification.org/spec/1.0.0/errors/expression` and status `400` will be raised. - [Runtime expression arguments](./dsl.md#runtime-expression-arguments) are not available for string substitution. #### Examples @@ -2762,7 +2762,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io/samples + source: https://open-workflow-specification.org/samples type: io.serverlessworkflow.samples.asyncapi.message.consumed.v1 data: message: '${ $message }' diff --git a/dsl.md b/dsl.md index a4faaaa1..245ff65a 100644 --- a/dsl.md +++ b/dsl.md @@ -186,7 +186,7 @@ To ensure they conform to the DSL, runtimes **should** pass all the feature conf Secrets are sensitive information required by a workflow to securely access protected resources or services. They provide a way to securely store and manage credentials, tokens, or other sensitive data used during workflow execution. -Runtime **must** implement a mechanism capable of providing the workflow with the data contained within the defined secrets. If a workflow attempts to access a secret to which it does not have access rights or which does not exist, runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/authorization` and status `403`. +Runtime **must** implement a mechanism capable of providing the workflow with the data contained within the defined secrets. If a workflow attempts to access a secret to which it does not have access rights or which does not exist, runtimes **must** raise an error with type `https://open-workflow-specification.org/spec/1.0.0/errors/authorization` and status `403`. #### Scheduling @@ -238,7 +238,7 @@ Here's how data flows through a workflow based on various transformation stages: 1. **Validate Workflow Input** Before the workflow starts, the input data provided to the workflow can be validated against the `input.schema` property to ensure it conforms to the expected structure. -The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). +The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://open-workflow-specification.org/spec/1.0.0/errors/validation)](dsl-reference.md#error). 2. **Transform Workflow Input** Before the workflow starts, the input data provided to the workflow can be transformed to ensure only relevant data in the expected format is passed into the workflow context. This can be done using the top level `input.from` expression. It evaluates on the raw workflow input and defaults to the identity expression which leaves the input unchanged. This step allows the workflow to start with a clean and focused dataset, reducing potential overhead and complexity in subsequent tasks. The result of this expression will set as the initial value for the `$input` runtime expression argument and be passed to the first task. @@ -249,7 +249,7 @@ After workflow input validation and transformation, the transformed input is pas 3. **Validate Task Input** Before a task executes, its raw input can be validated against the `input.schema` property to ensure it conforms to the expected structure. -The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). +The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://open-workflow-specification.org/spec/1.0.0/errors/validation)](dsl-reference.md#error). 4. **Transform Task Input** The input data for the task can be transformed to match the specific requirements of that task. This ensures that the task receives only the data required to perform its operations. This can be done using the task's `input.from` expression. It evaluates the raw task input (i.e., the transformed workflow input for the first task or the transformed output of the previous task) and defaults to the identity expression, which leaves the input unchanged. The result of this expression will be set as the `$input` runtime expression argument and be passed to the task. This transformed input will be evaluated against any runtime expressions used within the task definition. @@ -262,13 +262,13 @@ After completing the task, its output can be transformed before passing it to th *Example: If the task returns a large dataset, a transformation can be applied to retain only the relevant results needed for subsequent tasks.* 6. **Validate Task Output** -After `output.as` is evaluated, the transformed task output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). +After `output.as` is evaluated, the transformed task output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://open-workflow-specification.org/spec/1.0.0/errors/validation)](dsl-reference.md#error). 7. **Update Workflow Context** To update the context, one uses the `export.as` runtime expression. It evaluates the transformed task output and defaults to the expression that returns the existing context. The result of this runtime expression replaces the workflow's current context and the content of the `$context` runtime expression argument. This helps manage the data flow and keep the context clean by removing any unnecessary data produced by the task. 8. **Validate Exported Context** -After the context is updated, the exported context is validated against the `export.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the exported context is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). +After the context is updated, the exported context is validated against the `export.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the exported context is valid. Otherwise, it will fault with a [ValidationError (https://open-workflow-specification.org/spec/1.0.0/errors/validation)](dsl-reference.md#error). 9. **Continue Workflow** After the context is updated, the workflow continues to the next task in the sequence. The transformed output of the previous task is passed as the raw input to the next task, and the data flow cycle repeats. @@ -280,7 +280,7 @@ Finally, the overall workflow output can be transformed before it is returned to *Example: If the workflow's final output is a summary report, a transformation can ensure that the report contains only the most important summaries and conclusions, excluding any intermediate data.* 11. **Validate Workflow Output** -After `output.as` is evaluated, the transformed workflow output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). +After `output.as` is evaluated, the transformed workflow output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://open-workflow-specification.org/spec/1.0.0/errors/validation)](dsl-reference.md#error). By applying transformations at these strategic points, Open Workflow DSL ensures that data flows through the workflow in a controlled and efficient manner, maintaining clarity and relevance at each execution stage. This approach helps manage complex workflows and ensures that each task operates with the precise data required, leading to more predictable and reliable workflow outcomes. @@ -380,7 +380,7 @@ Runtimes **may** optionally support other runtime expression languages, which au CloudFlows defines [several arguments](#runtime-expression-arguments) that runtimes **must** provide during the evaluation of runtime expressions. -When the evaluation of an expression fails, runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/expression` and status `400`. +When the evaluation of an expression fails, runtimes **must** raise an error with type `https://open-workflow-specification.org/spec/1.0.0/errors/expression` and status `400`. > [!WARNING] > Runtimes **must** evaluate only runtime expressions that are defined in workflow definitions, and **must not** parse or evaluate expression syntax embedded in workflow input or task input data (for example, `jq`, regular expressions, or similar). Treating input data as executable expressions exposes the system to injection attacks, potentially allowing unauthorized access to system data and resources. @@ -473,7 +473,7 @@ Errors in Open Workflow Specification are described using the [Problem Details R *Example error:* ```yaml -type: https://serverlessworkflow.io/spec/1.0.0/errors/communication +type: https://open-workflow-specification.org/spec/1.0.0/errors/communication title: Service Unavailable status: 503 detail: The service is currently unavailable. Please try again later. @@ -516,7 +516,7 @@ Workflows and tasks alike can be configured to timeout after a defined amount of When a timeout occur, runtimes **must** abruptly interrupt the execution of the workflow/task, and **must** raise an error that, if uncaught, force the workflow/task to transition to the [`faulted` status phase](#status-phases). -A timeout error **must** have its `type` set to `https://serverlessworkflow.io/spec/1.0.0/errors/timeout` and **should** have its `status` set to `408`. +A timeout error **must** have its `type` set to `https://open-workflow-specification.org/spec/1.0.0/errors/timeout` and **should** have its `status` set to `408`. ### Catalogs @@ -601,7 +601,7 @@ Open Workflow DSL is designed to seamlessly interact with a variety of services, - [**OpenAPI**](dsl-reference.md#openapi-call): Enables communication with services that provide OpenAPI specifications, which is useful for defining and consuming RESTful APIs. - [**A2A**](dsl-reference.md#a2a-call): Enables interaction with A2A servers (agents described by A2A). -Runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/communication` if and when a problem occurs during a call. +Runtimes **must** raise an error with type `https://open-workflow-specification.org/spec/1.0.0/errors/communication` if and when a problem occurs during a call. #### Custom and Non-Standard Interactions diff --git a/examples/call-asyncapi-subscribe-consume-forever-foreach.yaml b/examples/call-asyncapi-subscribe-consume-forever-foreach.yaml index d81cd526..9f119ecf 100644 --- a/examples/call-asyncapi-subscribe-consume-forever-foreach.yaml +++ b/examples/call-asyncapi-subscribe-consume-forever-foreach.yaml @@ -21,7 +21,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io/samples + source: https://open-workflow-specification.org/samples type: io.serverlessworkflow.samples.asyncapi.message.consumed.v1 data: message: '${ $message }' diff --git a/examples/try-catch-retry-inline.yaml b/examples/try-catch-retry-inline.yaml index b560aecd..4731f4be 100644 --- a/examples/try-catch-retry-inline.yaml +++ b/examples/try-catch-retry-inline.yaml @@ -14,7 +14,7 @@ do: catch: errors: with: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication status: 503 retry: delay: diff --git a/examples/try-catch-retry-reusable.yaml b/examples/try-catch-retry-reusable.yaml index 0077f932..1e59287a 100644 --- a/examples/try-catch-retry-reusable.yaml +++ b/examples/try-catch-retry-reusable.yaml @@ -24,7 +24,7 @@ do: catch: errors: with: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication status: 503 retry: default \ No newline at end of file diff --git a/examples/try-catch-then.yaml b/examples/try-catch-then.yaml index fbe8dc37..ecb766a9 100644 --- a/examples/try-catch-then.yaml +++ b/examples/try-catch-then.yaml @@ -14,7 +14,7 @@ do: catch: errors: with: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication status: 404 as: error do: diff --git a/examples/try-catch.yaml b/examples/try-catch.yaml index ad7f8a0a..f8607cb8 100644 --- a/examples/try-catch.yaml +++ b/examples/try-catch.yaml @@ -14,5 +14,5 @@ do: catch: errors: with: - type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + type: https://open-workflow-specification.org/spec/1.0.0/errors/communication status: 404 \ No newline at end of file diff --git a/schema/workflow.yaml b/schema/workflow.yaml index 80b62578..62aede63 100644 --- a/schema/workflow.yaml +++ b/schema/workflow.yaml @@ -1,4 +1,4 @@ -$id: https://serverlessworkflow.io/schemas/1.0.3/workflow.yaml +$id: https://open-workflow-specification.org/schemas/1.0.3/workflow.yaml $schema: https://json-schema.org/draft/2020-12/schema description: Open Workflow DSL - Workflow Schema. type: object diff --git a/use-cases/managing-ev-charging-stations/README.md b/use-cases/managing-ev-charging-stations/README.md index 0e40f5da..7936c6b4 100644 --- a/use-cases/managing-ev-charging-stations/README.md +++ b/use-cases/managing-ev-charging-stations/README.md @@ -249,7 +249,7 @@ do: - raiseUnsupportedEventError: raise: error: - type: https://serverlessworkflow.io/spec/1.0.0/errors/runtime + type: https://open-workflow-specification.org/spec/1.0.0/errors/runtime status: 400 title: Unsupported Event detail: ${ "The specified station event '\($context.event.type)' is not supported in this context" } diff --git a/use-cases/managing-github-issues/README.md b/use-cases/managing-github-issues/README.md index 0b8212c5..2159c17b 100644 --- a/use-cases/managing-github-issues/README.md +++ b/use-cases/managing-github-issues/README.md @@ -92,7 +92,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io + source: https://open-workflow-specification.org type: com.github.events.issues.assignedToDevTeam.v1 data: issue: ${ .issue } @@ -129,7 +129,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io + source: https://open-workflow-specification.org type: com.github.events.issues.assignedToQATeam.v1 data: issue: ${ $context.issue } @@ -154,7 +154,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io + source: https://open-workflow-specification.org type: com.github.events.issues.pendingReview.v1 data: issue: ${ $context.issue } @@ -188,7 +188,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io + source: https://open-workflow-specification.org type: com.github.events.issues.evaluateReview.v1 data: issue: ${ $context.issue } @@ -230,7 +230,7 @@ do: emit: event: with: - source: https://serverlessworkflow.io + source: https://open-workflow-specification.org type: com.github.events.issues.closed.v1 data: issue: ${ $context.issue } @@ -240,7 +240,7 @@ do: - raiseUnsupportedActionError: raise: error: - type: https://serverlessworkflow.io/spec/1.0.0/errors/runtime + type: https://open-workflow-specification.org/spec/1.0.0/errors/runtime status: 400 title: Unsupported Action detail: The specified action is not supported in this context @@ -249,7 +249,7 @@ do: - raiseAssignedDevCannotBeReviewer: raise: error: - type: https://serverlessworkflow.io/spec/1.0.0/errors/runtime + type: https://open-workflow-specification.org/spec/1.0.0/errors/runtime status: 400 title: Invalid Reviewer detail: The developer that has performed the work associated with the issue cannot be the reviewer of its own work