Skip to content

Commit 8250103

Browse files
committed
Fix field name to 'required` of ConfigurationParameterDescriptor
The TSP specifies `required` instead of `isRequired`. This commit aligns the implementation with the specification. See also: eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#246 Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
1 parent 565e2d9 commit 8250103

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

tsp-typescript-client/fixtures/tsp-client/fetch-configuration-sources-0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"keyName": "path",
99
"description": "path description",
1010
"dataType": "STRING",
11-
"isRequired": "True"
11+
"required": "True"
1212
},
1313
{
1414
"keyName": "test1"

tsp-typescript-client/src/models/configuration-source.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ export interface ConfigurationParameterDescriptor {
5555
/**
5656
* If parameter needs to in the query parameters or not. Default is false.
5757
*/
58-
isRequired?: boolean;
58+
required?: boolean;
5959
}

tsp-typescript-client/src/protocol/tsp-client.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,12 +539,12 @@ describe('HttpTspClient Deserialization', () => {
539539
expect(paramDesc[0].keyName).toEqual('path');
540540
expect(paramDesc[0].description).toEqual('path description');
541541
expect(paramDesc[0].dataType).toEqual('STRING');
542-
expect(paramDesc[0].isRequired).toBeTruthy();
542+
expect(paramDesc[0].required).toBeTruthy();
543543

544544
expect(paramDesc[1].keyName).toEqual('test1');
545545
expect(paramDesc[1].description).toBeUndefined();
546546
expect(paramDesc[1].dataType).toBeUndefined();
547-
expect(paramDesc[1].isRequired).toBeUndefined();
547+
expect(paramDesc[1].required).toBeUndefined();
548548
expect(sourceTypes[0].schema).toBeUndefined();
549549

550550
expect(sourceTypes[1].parameterDescriptors).toBeUndefined();

0 commit comments

Comments
 (0)