Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecated key to more definitions #726

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: improvement
improvement:
description: More definitions take deprecated key
urls:
- https://github.com/palantir/conjure/pull/726
5 changes: 5 additions & 0 deletions conjure-api/src/main/conjure/conjure-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,21 +111,25 @@ types:
typeName: TypeName
alias: Type
docs: optional<Documentation>
deprecated: optional<Documentation>
EnumDefinition:
fields:
typeName: TypeName
values: list<EnumValueDefinition>
docs: optional<Documentation>
deprecated: optional<Documentation>
ObjectDefinition:
fields:
typeName: TypeName
fields: list<FieldDefinition>
docs: optional<Documentation>
deprecated: optional<Documentation>
UnionDefinition:
fields:
typeName: TypeName
union: list<FieldDefinition>
docs: optional<Documentation>
deprecated: optional<Documentation>
EnumValueDefinition:
fields:
value: string
Expand All @@ -147,6 +151,7 @@ types:
serviceName: TypeName
endpoints: list<EndpointDefinition>
docs: optional<Documentation>
deprecated: optional<Documentation>
EndpointDefinition:
fields:
endpointName: EndpointName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +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("")))));
TypeDefinition.alias(AliasDefinition.builder()
.typeName(typeName)
.alias(Type.optional(OptionalType.of(Type.primitive(PrimitiveType.BINARY))))
.build())));

assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition, dealiasingVisitor))
.isInstanceOf(IllegalStateException.class)
Expand Down Expand Up @@ -325,7 +325,9 @@ public void testComplexHeaderObject() {

DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(ImmutableMap.of(
typeName,
TypeDefinition.object(ObjectDefinition.of(typeName, ImmutableList.of(), Documentation.of("")))));
TypeDefinition.object(ObjectDefinition.builder()
.typeName(typeName)
.build())));

assertThatThrownBy(() -> EndpointDefinitionValidator.validateAll(definition.build(), dealiasingVisitor))
.isInstanceOf(IllegalStateException.class)
Expand Down
15 changes: 10 additions & 5 deletions conjure-core/src/test/resources/normalized.conjure.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
"docs" : null,
"deprecated" : null
} ],
"docs" : null
"docs" : null,
"deprecated" : null
}
}, {
"type" : "alias",
Expand All @@ -66,7 +67,8 @@
"type" : "primitive",
"primitive" : "STRING"
},
"docs" : null
"docs" : null,
"deprecated" : null
}
}, {
"type" : "alias",
Expand All @@ -79,7 +81,8 @@
"type" : "primitive",
"primitive" : "STRING"
},
"docs" : null
"docs" : null,
"deprecated" : null
}
} ],
"services" : [ {
Expand All @@ -98,7 +101,8 @@
"deprecated" : null,
"markers" : [ ]
} ],
"docs" : null
"docs" : null,
"deprecated" : null
}, {
"serviceName" : {
"name" : "TestService2",
Expand All @@ -115,7 +119,8 @@
"deprecated" : null,
"markers" : [ ]
} ],
"docs" : null
"docs" : null,
"deprecated" : null
} ],
"extensions" : { }
}