Github user mcgilman commented on a diff in the pull request: https://github.com/apache/nifi/pull/1718#discussion_r116357168 --- Diff: nifi-api/src/main/java/org/apache/nifi/annotation/documentation/DeprecationNotice.java --- @@ -0,0 +1,51 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.annotation.documentation; + +import org.apache.nifi.components.ConfigurableComponent; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Inherited; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation that can be applied to a {@link org.apache.nifi.processor.Processor Processor}, + * {@link org.apache.nifi.controller.ControllerService ControllerService}, or + * {@link org.apache.nifi.reporting.ReportingTask ReportingTask} in order to + * warn about the deprecation of the component. The deprecation warning is informational only + * and doesn't affect the processor run time behavior in any way + */ +@Documented +@Target({ElementType.TYPE}) +@Retention(RetentionPolicy.RUNTIME) +@Inherited +public @interface DeprecationNotice { + Class<? extends ConfigurableComponent>[] value() default {}; + + String[] classNames() default {}; + + String reason() default ""; + + + // The following are still not utilised but implemented + // for future use. + String deprecationTargetVersion() default ""; --- End diff -- Since this field is not being used, what do you think about leaving it out for now? My only concern is that once something goes into nifi-api it becomes a public API. Because of that, it may make sense to introduce this field once it is ready to be used. Thoughts? Is the purpose of the field to show intent to deprecate a component in a future release?
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---