From e9fd6f2a9aecb5cd0693710da93015724f8d20ab Mon Sep 17 00:00:00 2001 From: Adeel Ahmad Date: Tue, 9 Sep 2025 10:39:07 +0200 Subject: [PATCH 1/3] Revised OpenAPI v3 reserved header param names documentation --- .../published-rest-operation-parameter.md | 5 +++++ .../published-rest-technical-details/open-api.md | 3 --- .../published-rest-operation-parameter.md | 5 +++++ .../published-rest-technical-details/open-api.md | 3 --- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index 73f1659cf85..0b0897acf28 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -22,6 +22,11 @@ Specify where the parameter comes from. Possible values are the following: * **Path** – The operation path can contain parameters as well. If you add a path parameter, make sure you also add it to the operation. For more information, see [Published REST Path Parameters](/refguide/published-rest-path-parameters/). * **Body** – The microflow can have 0 or 1 body parameters. A body parameter is taken from the body of the request. If the body is a file document or an image, the contents will be filled with the body of the request. If the body parameter is another type of object or a list, an [import mapping](/refguide/import-mappings/) is needed to convert the body content of the request into an object or a list. `GET`, `HEAD`, and `OPTIONS` operations should not have body parameters. * **Header** – The value of a header parameter is taken from the (first) request header with that name. +{{% alert color="info" %}} + +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternatives names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). + +{{% /alert %}} * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). ### Name diff --git a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md index d54dfce536a..ce8f1c86161 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md @@ -51,6 +51,3 @@ Each operation generates an `Operation` object: | `responses` | The OK response. If security is enabled, this is also the unauthorized response. | | `deprecated` | Set to true when the operation is marked as deprecated. | -## Limitations - -- Certain [reserved keywords](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters) in OpenAPI 3.0 cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. diff --git a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index 0bad7eb50b6..e3135138687 100644 --- a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -22,6 +22,11 @@ Specify where the parameter comes from. Possible values are the following: * **Path** – The operation path can contain parameters as well. If you add a path parameter, make sure you also add it to the operation. For more information, see [Published REST Path Parameters](/refguide10/published-rest-path-parameters/). * **Body** – The microflow can have 0 or 1 body parameters. A body parameter is taken from the body of the request. If the body is a file document or an image, the contents will be filled with the body of the request. If the body parameter is another type of object or a list, an [import mapping](/refguide10/import-mappings/) is needed to convert the body content of the request into an object or a list. `GET`, `HEAD`, and `OPTIONS` operations should not have body parameters. * **Header** – The value of a header parameter is taken from the (first) request header with that name. +{{% alert color="info" %}} + +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternatives names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). + +{{% /alert %}} * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). ### Name diff --git a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md index 912febc09b2..9fab85b24bc 100644 --- a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md +++ b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-technical-details/open-api.md @@ -55,6 +55,3 @@ Each operation generates an `Operation` object: | `responses` | The OK response. If security is enabled, this is also the unauthorized response. | | `deprecated` | Set to true when the operation is marked as deprecated. | -## Limitations - -- Certain [reserved keywords](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters) in OpenAPI 3.0 cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. From 01f7a7f1e76dbcfef55b73bef9508e5eebdad9ba Mon Sep 17 00:00:00 2001 From: Adeel Ahmad Date: Tue, 9 Sep 2025 10:59:15 +0200 Subject: [PATCH 2/3] Corrected typo --- .../published-rest-operation-parameter.md | 2 +- .../published-rest-operation-parameter.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index 0b0897acf28..c81cbc44ee5 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -24,7 +24,7 @@ Specify where the parameter comes from. Possible values are the following: * **Header** – The value of a header parameter is taken from the (first) request header with that name. {{% alert color="info" %}} -Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternatives names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). {{% /alert %}} * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). diff --git a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index e3135138687..ca3472bb79d 100644 --- a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -24,7 +24,7 @@ Specify where the parameter comes from. Possible values are the following: * **Header** – The value of a header parameter is taken from the (first) request header with that name. {{% alert color="info" %}} -Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternatives names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). {{% /alert %}} * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). From 945423d04d7c7d2c75347ef2fe729dde637d6d1a Mon Sep 17 00:00:00 2001 From: MarkvanMents Date: Tue, 9 Sep 2025 16:55:21 +0200 Subject: [PATCH 3/3] Proofread --- .../published-rest-operation-parameter.md | 6 +++--- .../published-rest-operation-parameter.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index c81cbc44ee5..d2b4f11208d 100644 --- a/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -22,11 +22,11 @@ Specify where the parameter comes from. Possible values are the following: * **Path** – The operation path can contain parameters as well. If you add a path parameter, make sure you also add it to the operation. For more information, see [Published REST Path Parameters](/refguide/published-rest-path-parameters/). * **Body** – The microflow can have 0 or 1 body parameters. A body parameter is taken from the body of the request. If the body is a file document or an image, the contents will be filled with the body of the request. If the body parameter is another type of object or a list, an [import mapping](/refguide/import-mappings/) is needed to convert the body content of the request into an object or a list. `GET`, `HEAD`, and `OPTIONS` operations should not have body parameters. * **Header** – The value of a header parameter is taken from the (first) request header with that name. -{{% alert color="info" %}} - -Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). +{{% alert color="info" %}} +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in the Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). {{% /alert %}} + * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). ### Name diff --git a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md index ca3472bb79d..37469caca65 100644 --- a/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md +++ b/content/en/docs/refguide10/modeling/integration/rest-services/published-rest-services/published-rest-service/published-rest-operation-parameter.md @@ -22,11 +22,11 @@ Specify where the parameter comes from. Possible values are the following: * **Path** – The operation path can contain parameters as well. If you add a path parameter, make sure you also add it to the operation. For more information, see [Published REST Path Parameters](/refguide10/published-rest-path-parameters/). * **Body** – The microflow can have 0 or 1 body parameters. A body parameter is taken from the body of the request. If the body is a file document or an image, the contents will be filled with the body of the request. If the body parameter is another type of object or a list, an [import mapping](/refguide10/import-mappings/) is needed to convert the body content of the request into an object or a list. `GET`, `HEAD`, and `OPTIONS` operations should not have body parameters. * **Header** – The value of a header parameter is taken from the (first) request header with that name. -{{% alert color="info" %}} - -Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). +{{% alert color="info" %}} +Certain reserved keywords in **OpenAPI 3.0** cannot be used as header parameter names. For example, using `Authorization` as a custom header key can cause conflicts since it is already reserved by the specification. Using those reserved keywords only impacts OpenAPI v3 in the Swagger UI and not the actual API endpoints. For more details and alternative names, see [OpenAPI 3.0: Reserved header parameter names](https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters). {{% /alert %}} + * **Form** – The value of a form parameter is taken from the body part with that name (these are available for `multipart/form-data` requests). ### Name