From 74ba215f98804a6e3723d289e8f4f50ba0de81ab Mon Sep 17 00:00:00 2001 From: Rhys Brett-Bowen Date: Fri, 16 Oct 2020 11:54:05 -0400 Subject: [PATCH 1/4] Add deprecated key to more definitions --- conjure-api/src/main/conjure/conjure-api.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/conjure-api/src/main/conjure/conjure-api.yml b/conjure-api/src/main/conjure/conjure-api.yml index 0d461a14b..78bba0ccc 100644 --- a/conjure-api/src/main/conjure/conjure-api.yml +++ b/conjure-api/src/main/conjure/conjure-api.yml @@ -111,21 +111,25 @@ types: typeName: TypeName alias: Type docs: optional + deprecated: optional EnumDefinition: fields: typeName: TypeName values: list docs: optional + deprecated: optional ObjectDefinition: fields: typeName: TypeName fields: list docs: optional + deprecated: optional UnionDefinition: fields: typeName: TypeName union: list docs: optional + deprecated: optional EnumValueDefinition: fields: value: string @@ -147,6 +151,7 @@ types: serviceName: TypeName endpoints: list docs: optional + deprecated: optional EndpointDefinition: fields: endpointName: EndpointName From 61bb053e8edfe8d71ec50a8558804803b41d83bf Mon Sep 17 00:00:00 2001 From: Rhys Brett-Bowen Date: Fri, 16 Oct 2020 11:59:45 -0400 Subject: [PATCH 2/4] changelog --- .../@unreleased/deprecate-key-for-more-definitions.v2.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml diff --git a/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml b/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml new file mode 100644 index 000000000..c136033b3 --- /dev/null +++ b/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml @@ -0,0 +1,5 @@ +type: improvement +improvement: + description: More definitions take deprecated key + urls: + - https://github.com/palantir/conjure/pull/726 \ No newline at end of file From 1d7ee4814b64b9be270f76d8085751ce2ea12694 Mon Sep 17 00:00:00 2001 From: Rhys Brett-Bowen Date: Fri, 16 Oct 2020 12:28:59 -0400 Subject: [PATCH 3/4] fix-tests --- .../@unreleased/deprecate-key-for-more-definitions.v2.yml | 2 +- .../conjure/defs/validator/EndpointDefinitionTest.java | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml b/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml index c136033b3..cec265333 100644 --- a/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml +++ b/changelog/@unreleased/deprecate-key-for-more-definitions.v2.yml @@ -2,4 +2,4 @@ type: improvement improvement: description: More definitions take deprecated key urls: - - https://github.com/palantir/conjure/pull/726 \ No newline at end of file + - https://github.com/palantir/conjure/pull/726 diff --git a/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java b/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java index 2379b6237..b29c94cd2 100644 --- a/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java +++ b/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java @@ -140,6 +140,7 @@ public void testNoOptionalBinaryBodyParamValidator_throughAlias() { TypeDefinition.alias(AliasDefinition.of( typeName, Type.optional(OptionalType.of(Type.primitive(PrimitiveType.BINARY))), + Documentation.of(""), Documentation.of(""))))); assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition, dealiasingVisitor)) @@ -325,7 +326,7 @@ public void testComplexHeaderObject() { DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(ImmutableMap.of( typeName, - TypeDefinition.object(ObjectDefinition.of(typeName, ImmutableList.of(), Documentation.of(""))))); + TypeDefinition.object(ObjectDefinition.of(typeName, ImmutableList.of(), Documentation.of(""), Documentation.of(""))))); assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition.build(), dealiasingVisitor)) .isInstanceOf(IllegalStateException.class) From f29253504bbbe812d9ca0ccd1aa57621fff25473 Mon Sep 17 00:00:00 2001 From: Rhys Brett-Bowen Date: Tue, 20 Oct 2020 10:24:53 -0400 Subject: [PATCH 4/4] tests --- .../defs/validator/EndpointDefinitionTest.java | 13 +++++++------ .../src/test/resources/normalized.conjure.json | 15 ++++++++++----- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java b/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java index b29c94cd2..61a2d9c5c 100644 --- a/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java +++ b/conjure-core/src/test/java/com/palantir/conjure/defs/validator/EndpointDefinitionTest.java @@ -137,11 +137,10 @@ public void testNoOptionalBinaryBodyParamValidator_throughAlias() { DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(ImmutableMap.of( typeName, - TypeDefinition.alias(AliasDefinition.of( - typeName, - Type.optional(OptionalType.of(Type.primitive(PrimitiveType.BINARY))), - Documentation.of(""), - Documentation.of(""))))); + TypeDefinition.alias(AliasDefinition.builder() + .typeName(typeName) + .alias(Type.optional(OptionalType.of(Type.primitive(PrimitiveType.BINARY)))) + .build()))); assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition, dealiasingVisitor)) .isInstanceOf(IllegalStateException.class) @@ -326,7 +325,9 @@ public void testComplexHeaderObject() { DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(ImmutableMap.of( typeName, - TypeDefinition.object(ObjectDefinition.of(typeName, ImmutableList.of(), Documentation.of(""), Documentation.of(""))))); + TypeDefinition.object(ObjectDefinition.builder() + .typeName(typeName) + .build()))); assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition.build(), dealiasingVisitor)) .isInstanceOf(IllegalStateException.class) diff --git a/conjure-core/src/test/resources/normalized.conjure.json b/conjure-core/src/test/resources/normalized.conjure.json index d09aac6ac..88e2d6cd8 100644 --- a/conjure-core/src/test/resources/normalized.conjure.json +++ b/conjure-core/src/test/resources/normalized.conjure.json @@ -53,7 +53,8 @@ "docs" : null, "deprecated" : null } ], - "docs" : null + "docs" : null, + "deprecated" : null } }, { "type" : "alias", @@ -66,7 +67,8 @@ "type" : "primitive", "primitive" : "STRING" }, - "docs" : null + "docs" : null, + "deprecated" : null } }, { "type" : "alias", @@ -79,7 +81,8 @@ "type" : "primitive", "primitive" : "STRING" }, - "docs" : null + "docs" : null, + "deprecated" : null } } ], "services" : [ { @@ -98,7 +101,8 @@ "deprecated" : null, "markers" : [ ] } ], - "docs" : null + "docs" : null, + "deprecated" : null }, { "serviceName" : { "name" : "TestService2", @@ -115,7 +119,8 @@ "deprecated" : null, "markers" : [ ] } ], - "docs" : null + "docs" : null, + "deprecated" : null } ], "extensions" : { } }