-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-31383] Add support for documenting additionProperties of the R…
…EST API payloads.
- Loading branch information
Showing
9 changed files
with
341 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
flink-annotations/src/main/java/org/apache/flink/annotation/docs/FlinkJsonSchema.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* | ||
| * 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.flink.annotation.docs; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** Annotations for auto-generating a documentation of json payloads. */ | ||
| @Internal | ||
| public class FlinkJsonSchema { | ||
|
|
||
| private FlinkJsonSchema() {} | ||
|
|
||
| /** | ||
| * This allows documenting a class that supports setting dynamic properties of a certain type. | ||
| */ | ||
| @Target(ElementType.TYPE) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Internal | ||
| public @interface AdditionalFields { | ||
|
|
||
| /** | ||
| * An actual type the additional fields need to match. | ||
| * | ||
| * @return type of the additional fields | ||
| */ | ||
| Class<?> type(); | ||
| } | ||
| } |
62 changes: 62 additions & 0 deletions
62
flink-docs/src/main/java/org/apache/flink/docs/rest/ApiSpecGeneratorUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * 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.flink.docs.rest; | ||
|
|
||
| import org.apache.flink.annotation.docs.Documentation; | ||
| import org.apache.flink.annotation.docs.FlinkJsonSchema; | ||
| import org.apache.flink.runtime.rest.messages.MessageHeaders; | ||
| import org.apache.flink.runtime.rest.messages.MessageParameters; | ||
| import org.apache.flink.runtime.rest.messages.RequestBody; | ||
| import org.apache.flink.runtime.rest.messages.ResponseBody; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| /** Helper methods for generation API documentation. */ | ||
| public class ApiSpecGeneratorUtils { | ||
|
|
||
| private ApiSpecGeneratorUtils() {} | ||
|
|
||
| /** | ||
| * Checks whether the given endpoint should be documented. | ||
| * | ||
| * @param spec endpoint to check | ||
| * @return true if the endpoint should be documented | ||
| */ | ||
| public static boolean shouldBeDocumented( | ||
| MessageHeaders< | ||
| ? extends RequestBody, | ||
| ? extends ResponseBody, | ||
| ? extends MessageParameters> | ||
| spec) { | ||
| return spec.getClass().getAnnotation(Documentation.ExcludeFromDocumentation.class) == null; | ||
| } | ||
|
|
||
| /** | ||
| * Find whether the class contains dynamic fields that need to be documented. | ||
| * | ||
| * @param clazz class to check | ||
| * @return optional that is non-empty if the class is annotated with {@link | ||
| * FlinkJsonSchema.AdditionalFields} | ||
| */ | ||
| public static Optional<Class<?>> findAdditionalFieldType(Class<?> clazz) { | ||
| final FlinkJsonSchema.AdditionalFields annotation = | ||
| clazz.getAnnotation(FlinkJsonSchema.AdditionalFields.class); | ||
| return Optional.ofNullable(annotation).map(FlinkJsonSchema.AdditionalFields::type); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.