diff --git a/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/actuate/metrics/package-info.java b/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/actuate/metrics/package-info.java new file mode 100644 index 00000000..c4927f6d --- /dev/null +++ b/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/actuate/metrics/package-info.java @@ -0,0 +1,9 @@ +/** + * Provides instrumentation support. + */ +@NonNullApi +@NonNullFields +package org.springframework.graphql.boot.actuate.metrics; + +import org.springframework.lang.NonNullApi; +import org.springframework.lang.NonNullFields; diff --git a/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/package-info.java b/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/package-info.java index 6aaf504e..495b8015 100644 --- a/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/package-info.java +++ b/graphql-spring-boot-starter/src/main/java/org/springframework/graphql/boot/package-info.java @@ -1,17 +1,8 @@ -/* - * Copyright 2020-2020 the original author or authors. - * - * Licensed 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 - * - * https://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. +/** + * Auto-configuration classes to configure + * {@link org.springframework.graphql.execution.GraphQLSource}, + * {@link org.springframework.graphql.GraphQLService}, and HTTP and WebSocket + * endpoints. */ @NonNullApi @NonNullFields diff --git a/spring-graphql/src/main/java/org/springframework/graphql/RequestInput.java b/spring-graphql/src/main/java/org/springframework/graphql/RequestInput.java index 059b6e93..4a3b229f 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/RequestInput.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/RequestInput.java @@ -29,7 +29,10 @@ import org.springframework.util.Assert; import org.springframework.util.CollectionUtils; /** - * Container for a GraphQL request. + * Common representation for GraphQL request input. This can be converted to + * {@link ExecutionInput} via {@link #toExecutionInput()} and the + * {@code ExecutionInput} further customized via + * {@link #configureExecutionInput(BiFunction)}. */ public class RequestInput { diff --git a/spring-graphql/src/main/java/org/springframework/graphql/execution/package-info.java b/spring-graphql/src/main/java/org/springframework/graphql/execution/package-info.java index 1c8b7b17..70567d52 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/execution/package-info.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/execution/package-info.java @@ -1,6 +1,6 @@ /** - * Provides support for GraphQL request execution, including abstractions to - * configure and invoke {@link graphql.GraphQL}. + * Support for GraphQL request execution, including abstractions to configure + * and invoke {@link graphql.GraphQL}. */ @NonNullApi @NonNullFields diff --git a/spring-graphql/src/main/java/org/springframework/graphql/package-info.java b/spring-graphql/src/main/java/org/springframework/graphql/package-info.java index c6809f53..274456d3 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/package-info.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/package-info.java @@ -1,17 +1,8 @@ -/* - * Copyright 2020-2020 the original author or authors. - * - * Licensed 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 - * - * https://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. +/** + * Top level abstractions for processing GraphQL requests including + * {@link org.springframework.graphql.GraphQLService} for executing a request and + * {@link org.springframework.graphql.RequestInput} to represent the input for + * a request. */ @NonNullApi @NonNullFields diff --git a/spring-graphql/src/main/java/org/springframework/graphql/web/package-info.java b/spring-graphql/src/main/java/org/springframework/graphql/web/package-info.java index 84333cfb..3a599cdf 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/web/package-info.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/web/package-info.java @@ -1,17 +1,10 @@ -/* - * Copyright 2020-2021 the original author or authors. - * - * Licensed 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 - * - * https://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. +/** + * Support for executing GraphQL requests over the Web, including handlers for + * HTTP and WebSocket. Handlers are provided for use in ether + * {@link org.springframework.graphql.web.webmvc Spring WebMvc} or + * {@link org.springframework.graphql.web.webflux Spring WebFlux} with a common + * {@link org.springframework.graphql.web.WebInterceptor interception} model + * that allows applications to customize request input and output. */ @NonNullApi @NonNullFields diff --git a/spring-graphql/src/main/java/org/springframework/graphql/web/webflux/package-info.java b/spring-graphql/src/main/java/org/springframework/graphql/web/webflux/package-info.java index e3afacbe..bb2f8e9e 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/web/webflux/package-info.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/web/webflux/package-info.java @@ -1,17 +1,5 @@ -/* - * Copyright 2020-2020 the original author or authors. - * - * Licensed 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 - * - * https://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. +/** + * HTTP and WebSocket handlers for use in a Spring WebFlux application. */ @NonNullApi @NonNullFields diff --git a/spring-graphql/src/main/java/org/springframework/graphql/web/webmvc/package-info.java b/spring-graphql/src/main/java/org/springframework/graphql/web/webmvc/package-info.java index 9f717a32..e07bdb2e 100644 --- a/spring-graphql/src/main/java/org/springframework/graphql/web/webmvc/package-info.java +++ b/spring-graphql/src/main/java/org/springframework/graphql/web/webmvc/package-info.java @@ -1,17 +1,5 @@ -/* - * Copyright 2020-2020 the original author or authors. - * - * Licensed 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 - * - * https://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. +/** + * HTTP and WebSocket handlers for use in a Spring WebMvc application. */ @NonNullApi @NonNullFields