From 7e5e1f5c99acf790b2cb7d5416e25c56e48b1b2c Mon Sep 17 00:00:00 2001 From: Kevin Stich Date: Wed, 20 Mar 2024 09:20:19 -0700 Subject: [PATCH] Clarify HTTP compliance test params field --- .../spec/http-protocol-compliance-tests.rst | 13 ++++++++----- .../http-protocol-compliance-tests.rst | 13 ++++++++----- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/source-1.0/spec/http-protocol-compliance-tests.rst b/docs/source-1.0/spec/http-protocol-compliance-tests.rst index 796d26dc4ce..a2654d0ab91 100644 --- a/docs/source-1.0/spec/http-protocol-compliance-tests.rst +++ b/docs/source-1.0/spec/http-protocol-compliance-tests.rst @@ -207,8 +207,10 @@ that support the following members: to parse and validate the expected data against generated data. * - params - ``document`` - - Defines the input parameters used to generate the HTTP request. These - parameters MUST be compatible with the input of the operation. + - For clients, defines the input parameters used to generate the HTTP + request. For servers, defines the input parameters extracted from the + HTTP request. These parameters MUST be compatible with the input of the + operation. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" @@ -391,9 +393,10 @@ structures that support the following members: base64 encoded. * - params - ``document`` - - Defines the output or error parameters used to generate the HTTP - response. These parameters MUST be compatible with the targeted - operation's output or the targeted error structure. + - For clients, defines the output or error parameters extracted from the + HTTP response. For servers, defines the output or error parameters used + to generate the HTTP response. These parameters MUST be compatible with + the targeted operation's output or the targeted error structure. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" diff --git a/docs/source-2.0/additional-specs/http-protocol-compliance-tests.rst b/docs/source-2.0/additional-specs/http-protocol-compliance-tests.rst index da92e4f562b..5a0703bc52a 100644 --- a/docs/source-2.0/additional-specs/http-protocol-compliance-tests.rst +++ b/docs/source-2.0/additional-specs/http-protocol-compliance-tests.rst @@ -208,8 +208,10 @@ that support the following members: to parse and validate the expected data against generated data. * - params - ``document`` - - Defines the input parameters used to generate the HTTP request. These - parameters MUST be compatible with the input of the operation. + - For clients, defines the input parameters used to generate the HTTP + request. For servers, defines the input parameters extracted from the + HTTP request. These parameters MUST be compatible with the input of the + operation. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" @@ -393,9 +395,10 @@ structures that support the following members: base64 encoded. * - params - ``document`` - - Defines the output or error parameters used to generate the HTTP - response. These parameters MUST be compatible with the targeted - operation's output or the targeted error structure. + - For clients, defines the output or error parameters extracted from the + HTTP response. For servers, defines the output or error parameters used + to generate the HTTP response. These parameters MUST be compatible with + the targeted operation's output or the targeted error structure. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo"