Updating the JavaDoc http links (graphql-java#3083)

bbakerman · dondonz · web-flow · commit 322c5c2b4dc6 · 2023-02-04T12:17:09.000+11:00
* Updating the JavaDoc http links

* Update src/main/java/graphql/Scalars.java

Co-authored-by: dondonz &lt;13839920+dondonz@users.noreply.github.com&gt;

* Update src/main/java/graphql/execution/SubscriptionExecutionStrategy.java

Co-authored-by: dondonz &lt;13839920+dondonz@users.noreply.github.com&gt;

---------

Co-authored-by: dondonz &lt;13839920+dondonz@users.noreply.github.com&gt;
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -44,7 +44,7 @@ incident.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+[https://contributor-covenant.org/version/1/3/0/][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/3/0/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,7 +9,7 @@ The overall goal of graphql-java is to have a correct implementation of the [Gra
 
 In order to achieve that we have a strong focus on maintainability and high test coverage:
 
-- We expect new or modified unit test for every change (written in [Spock](http://spockframework.org/)).
+- We expect new or modified unit test for every change (written in [Spock](https://spockframework.org/)).
 
 - Your code should be formatted with our IntelliJ [graphql-java-code-style](graphql-java-code-style.xml).
 
diff --git a/coding-guidelines.md b/coding-guidelines.md
@@ -26,7 +26,7 @@ We have a mix of Optional and allowing null values because GraphQL Java was orig
 We are aiming to not use Optional moving forward in order to be consistent overall.
 
 ### Unit testing and dependencies
-All tests are written in [Spock](http://spockframework.org).
+All tests are written in [Spock](https://spockframework.org).
 
 All new code has to have unit tests. 
 
diff --git a/src/main/java/graphql/Scalars.java b/src/main/java/graphql/Scalars.java
@@ -13,7 +13,8 @@
  * by the graphql specification (Int, Float, String, Boolean and ID) while others are offer because they are common on
  * Java platforms.
  * <p>
- * For more info see http://graphql.org/learn/schema/#scalar-types and more specifically https://spec.graphql.org/October2021/#sec-Scalars
+ * For more info see <a href="https://graphql.org/learn/schema/#scalar-types">https://graphql.org/learn/schema/#scalar-types</a> and
+ * more specifically <a href="https://spec.graphql.org/draft/#sec-Scalars">https://spec.graphql.org/draft/#sec-Scalars</a>
  */
 @PublicApi
 public class Scalars {
diff --git a/src/main/java/graphql/execution/SubscriptionExecutionStrategy.java b/src/main/java/graphql/execution/SubscriptionExecutionStrategy.java
@@ -30,8 +30,9 @@
  * Afterwards each object delivered on that stream will be mapped via running the original selection set over that object and hence producing an ExecutionResult
  * just like a normal graphql query.
  * <p>
- * See https://github.com/facebook/graphql/blob/master/spec/Section%206%20--%20Execution.md
- * See http://www.reactive-streams.org/
+ * See <a href="https://spec.graphql.org/draft/#sec-Subscription">https://spec.graphql.org/draft/#sec-Subscription</a>
+ * <p>
+ * See <a href="https://www.reactive-streams.org/">https://www.reactive-streams.org/</a>
  */
 @PublicApi
 public class SubscriptionExecutionStrategy extends ExecutionStrategy {
diff --git a/src/main/java/graphql/execution/directives/QueryAppliedDirective.java b/src/main/java/graphql/execution/directives/QueryAppliedDirective.java
@@ -30,7 +30,7 @@
  * classes have been introduced to better model when a directive is applied to a query element,
  * as opposed to its schema definition itself.
  * <p>
- * See http://graphql.org/learn/queries/#directives for more details on the concept.
+ * See <a href="https://graphql.org/learn/queries/#directives">https://graphql.org/learn/queries/#directives</a> for more details on the concept.
  */
 @PublicApi
 public class QueryAppliedDirective {
diff --git a/src/main/java/graphql/schema/GraphQLAppliedDirective.java b/src/main/java/graphql/schema/GraphQLAppliedDirective.java
@@ -28,7 +28,7 @@
  * classes have been introduced to better model when a directive is applied to a schema element,
  * as opposed to its schema definition itself.
  * <p>
- * See http://graphql.org/learn/queries/#directives for more details on the concept.
+ * See <a href="https://graphql.org/learn/queries/#directives">https://graphql.org/learn/queries/#directives</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLAppliedDirective implements GraphQLNamedSchemaElement {
diff --git a/src/main/java/graphql/schema/GraphQLArgument.java b/src/main/java/graphql/schema/GraphQLArgument.java
@@ -23,15 +23,15 @@
 import static graphql.execution.ValuesResolver.getInputValueImpl;
 
 /**
- * This defines an argument that can be supplied to a graphql field (via {@link graphql.schema.GraphQLFieldDefinition}.
+ * This defines an argument that can be supplied to a graphql field (via {@link GraphQLFieldDefinition}.
  * <p>
  * Fields can be thought of as "functions" that take arguments and return a value.
  * <p>
- * See http://graphql.org/learn/queries/#arguments for more details on the concept.
+ * See <a href="https://graphql.org/learn/queries/#arguments">https://graphql.org/learn/queries/#arguments</a> for more details on the concept.
  * <p>
- * {@link graphql.schema.GraphQLArgument} is used in two contexts, one context is graphql queries where it represents the arguments that can be
+ * {@link GraphQLArgument} is used in two contexts, one context is graphql queries where it represents the arguments that can be
  * set on a field and the other is in Schema Definition Language (SDL) where it can be used to represent the argument value instances
- * that have been supplied on a {@link graphql.schema.GraphQLDirective}.
+ * that have been supplied on a {@link GraphQLDirective}.
  * <p>
  * The difference is the 'value' and 'defaultValue' properties.  In a query argument, the 'value' is never in the GraphQLArgument
  * object but rather in the AST direct or in the query variables map and the 'defaultValue' represents a value to use if both of these are
diff --git a/src/main/java/graphql/schema/GraphQLDirective.java b/src/main/java/graphql/schema/GraphQLDirective.java
@@ -23,7 +23,7 @@
 /**
  * A directive can be used to modify the behavior of a graphql field or type.
  * <p>
- * See http://graphql.org/learn/queries/#directives for more details on the concept.
+ * See <a href="https://graphql.org/learn/queries/#directives">https://graphql.org/learn/queries/#directives</a> for more details on the concept.
  * <p>
  * A directive has a definition, that is what arguments it takes, and it can also be applied
  * to other schema elements.  Originally graphql-java re-used the {@link GraphQLDirective} and {@link GraphQLArgument}
diff --git a/src/main/java/graphql/schema/GraphQLEnumType.java b/src/main/java/graphql/schema/GraphQLEnumType.java
@@ -38,7 +38,7 @@
  * This allows you to validate that any arguments of this type are one of the allowed values
  * and communicate through the type system that a field will always be one of a finite set of values.
  * <p>
- * See http://graphql.org/learn/schema/#enumeration-types for more details
+ * See <a href="https://graphql.org/learn/schema/#enumeration-types">https://graphql.org/learn/schema/#enumeration-types</a> for more details
  */
 @PublicApi
 public class GraphQLEnumType implements GraphQLNamedInputType, GraphQLNamedOutputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer {
diff --git a/src/main/java/graphql/schema/GraphQLEnumValueDefinition.java b/src/main/java/graphql/schema/GraphQLEnumValueDefinition.java
@@ -19,7 +19,7 @@
 /**
  * A graphql enumeration type has a limited set of values and this defines one of those unique values
  * <p>
- * See http://graphql.org/learn/schema/#enumeration-types for more details
+ * See <a href="https://graphql.org/learn/schema/#enumeration-types">https://graphql.org/learn/schema/#enumeration-types</a> for more details
  *
  * @see graphql.schema.GraphQLEnumType
  */
diff --git a/src/main/java/graphql/schema/GraphQLFieldDefinition.java b/src/main/java/graphql/schema/GraphQLFieldDefinition.java
@@ -24,13 +24,13 @@
 
 /**
  * Fields are the ways you get data values in graphql and a field definition represents a field, its type, the arguments it takes
- * and the {@link graphql.schema.DataFetcher} used to get data values for that field.
+ * and the {@link DataFetcher} used to get data values for that field.
  * <p>
  * Fields can be thought of as functions in graphql, they have a name, take defined arguments and return a value.
  * <p>
  * Fields can also be deprecated, which indicates the consumers that a field wont be supported in the future.
  * <p>
- * See http://graphql.org/learn/queries/#fields for more details on the concept.
+ * See <a href="https://graphql.org/learn/queries/#fields">https://graphql.org/learn/queries/#fields</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLFieldDefinition implements GraphQLNamedSchemaElement, GraphQLDirectiveContainer {
diff --git a/src/main/java/graphql/schema/GraphQLInputObjectField.java b/src/main/java/graphql/schema/GraphQLInputObjectField.java
@@ -22,12 +22,12 @@
 import static graphql.execution.ValuesResolver.getInputValueImpl;
 
 /**
- * Input objects defined via {@link graphql.schema.GraphQLInputObjectType} contains these input fields.
+ * Input objects defined via {@link GraphQLInputObjectType} contains these input fields.
  *
- * There are similar to {@link graphql.schema.GraphQLFieldDefinition} however they can ONLY be used on input objects, that
+ * There are similar to {@link GraphQLFieldDefinition} however they can ONLY be used on input objects, that
  * is to describe values that are fed into a graphql mutation.
  *
- * See http://graphql.org/learn/schema/#input-types for more details on the concept.
+ * See <a href="https://graphql.org/learn/schema/#input-types">https://graphql.org/learn/schema/#input-types</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLInputObjectField implements GraphQLNamedSchemaElement, GraphQLInputValueDefinition {
diff --git a/src/main/java/graphql/schema/GraphQLInputObjectType.java b/src/main/java/graphql/schema/GraphQLInputObjectType.java
@@ -28,7 +28,7 @@
  * graphql clearly delineates between the types of objects that represent the output of a query and input objects that
  * can be fed into a graphql mutation.  You can define objects as input to graphql via this class
  * <p>
- * See http://graphql.org/learn/schema/#input-types for more details on the concept
+ * See <a href="https://graphql.org/learn/schema/#input-types">https://graphql.org/learn/schema/#input-types</a> for more details on the concept
  */
 @PublicApi
 public class GraphQLInputObjectType implements GraphQLNamedInputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLInputFieldsContainer, GraphQLDirectiveContainer {
diff --git a/src/main/java/graphql/schema/GraphQLInterfaceType.java b/src/main/java/graphql/schema/GraphQLInterfaceType.java
@@ -32,10 +32,10 @@
  * In graphql, an interface is an abstract type that defines the set of fields that a type must include to
  * implement that interface.
  * <p>
- * At runtime a {@link graphql.schema.TypeResolver} is used to take an interface object value and decide what {@link graphql.schema.GraphQLObjectType}
+ * At runtime a {@link TypeResolver} is used to take an interface object value and decide what {@link GraphQLObjectType}
  * represents this interface type.
  * <p>
- * See http://graphql.org/learn/schema/#interfaces for more details on the concept.
+ * See <a href="https://graphql.org/learn/schema/#interfaces">https://graphql.org/learn/schema/#interfaces</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLInterfaceType implements GraphQLNamedType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer, GraphQLImplementingType {
diff --git a/src/main/java/graphql/schema/GraphQLList.java b/src/main/java/graphql/schema/GraphQLList.java
@@ -13,8 +13,8 @@
 
 /**
  * A modified type that indicates there is a list of the underlying wrapped type, eg a list of strings or a list of booleans.
- *
- * See http://graphql.org/learn/schema/#lists-and-non-null for more details on the concept
+ * <p>
+ * See <a href="https://graphql.org/learn/schema/#lists-and-non-null">https://graphql.org/learn/schema/#lists-and-non-null</a> for more details on the concept
  */
 @PublicApi
 public class GraphQLList implements GraphQLType, GraphQLInputType, GraphQLOutputType, GraphQLModifiedType, GraphQLNullableType {
diff --git a/src/main/java/graphql/schema/GraphQLNonNull.java b/src/main/java/graphql/schema/GraphQLNonNull.java
@@ -15,7 +15,7 @@
 /**
  * A modified type that indicates there the underlying wrapped type will not be null.
  * <p>
- * See http://graphql.org/learn/schema/#lists-and-non-null for more details on the concept
+ * See <a href="https://graphql.org/learn/schema/#lists-and-non-null">https://graphql.org/learn/schema/#lists-and-non-null</a> for more details on the concept
  */
 @PublicApi
 public class GraphQLNonNull implements GraphQLType, GraphQLInputType, GraphQLOutputType, GraphQLModifiedType {
diff --git a/src/main/java/graphql/schema/GraphQLObjectType.java b/src/main/java/graphql/schema/GraphQLObjectType.java
@@ -33,9 +33,9 @@
  * by the graphql system.
  * <p>
  * Those fields can themselves by object types and so on until you reach the leaf nodes of the type tree represented
- * by {@link graphql.schema.GraphQLScalarType}s.
+ * by {@link GraphQLScalarType}s.
  * <p>
- * See http://graphql.org/learn/schema/#object-types-and-fields for more details on the concept.
+ * See <a href="https://graphql.org/learn/schema/#object-types-and-fields">https://graphql.org/learn/schema/#object-types-and-fields</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLObjectType implements GraphQLNamedOutputType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer, GraphQLImplementingType {
diff --git a/src/main/java/graphql/schema/GraphQLSchema.java b/src/main/java/graphql/schema/GraphQLSchema.java
@@ -45,7 +45,7 @@
  * The schema represents the combined type system of the graphql engine.  This is how the engine knows
  * what graphql queries represent what data.
  * <p>
- * See http://graphql.org/learn/schema/#type-language for more details
+ * See <a href="https://graphql.org/learn/schema/#type-language">https://graphql.org/learn/schema/#type-language</a> for more details
  */
 @PublicApi
 public class GraphQLSchema {
diff --git a/src/main/java/graphql/schema/GraphQLUnionType.java b/src/main/java/graphql/schema/GraphQLUnionType.java
@@ -28,12 +28,12 @@
 /**
  * A union type is a polymorphic type that dynamically represents one of more concrete object types.
  * <p>
- * At runtime a {@link graphql.schema.TypeResolver} is used to take an union object value and decide what {@link graphql.schema.GraphQLObjectType}
+ * At runtime a {@link TypeResolver} is used to take an union object value and decide what {@link GraphQLObjectType}
  * represents this union of types.
  * <p>
  * Note that members of a union type need to be concrete object types; you can't create a union type out of interfaces or other unions.
  * <p>
- * See http://graphql.org/learn/schema/#union-types for more details on the concept.
+ * See <a href="https://graphql.org/learn/schema/#union-types">https://graphql.org/learn/schema/#union-types</a> for more details on the concept.
  */
 @PublicApi
 public class GraphQLUnionType implements GraphQLNamedOutputType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer {
diff --git a/src/main/java/graphql/util/EscapeUtil.java b/src/main/java/graphql/util/EscapeUtil.java
@@ -9,7 +9,7 @@ private EscapeUtil() {
     }
 
     /**
-     * Encodes the value as a JSON string according to http://json.org/ rules
+     * Encodes the value as a JSON string according to <a href="https://json.org/">https://json.org/</a> rules
      *
      * @param stringValue the value to encode as a JSON string
      *
diff --git a/src/test/groovy/example/http/HttpMain.java b/src/test/groovy/example/http/HttpMain.java
@@ -49,7 +49,7 @@
 /**
  * A very simple example of serving a graphql schema over http.
  * <p>
- * More info can be found here : http://graphql.org/learn/serving-over-http/
+ * More info can be found here : <a href="https://graphql.org/learn/serving-over-http/">https://graphql.org/learn/serving-over-http/</a>
  */
 @SuppressWarnings("unchecked")
 public class HttpMain extends AbstractHandler {
diff --git a/src/test/groovy/example/http/QueryParameters.java b/src/test/groovy/example/http/QueryParameters.java
@@ -10,15 +10,15 @@
 /**
  * Graphql clients can send GET or POST HTTP requests.  The spec does not make an explicit
  * distinction.  So you may need to handle both.  The following was tested using
- * a graphiql client tool found here : https://github.com/skevy/graphiql-app
- *
+ * a graphiql client tool found here : <a href="https://github.com/skevy/graphiql-app">graphiql-app</a>
+ * <p>
  * You should consider bundling graphiql in your application
- *
- * https://github.com/graphql/graphiql
- *
+ * <p>
+ * <a href="https://github.com/graphql/graphiql">https://github.com/graphql/graphiql</a>
+ * <p>
  * This outlines more information on how to handle parameters over http
- *
- * http://graphql.org/learn/serving-over-http/
+ * <p>
+ * <a href="https://graphql.org/learn/serving-over-http/">https://graphql.org/learn/serving-over-http/</a>
  */
 class QueryParameters {
 
diff --git a/src/test/groovy/example/http/package-info.java b/src/test/groovy/example/http/package-info.java
@@ -1,11 +1,11 @@
 /**
  * The purpose of this code is to show an example of serving a graphql query over HTTP
- *
- * More info can be found here : http://graphql.org/learn/serving-over-http/
- *
+ * <p>
+ * More info can be found here : <a href="https://graphql.org/learn/serving-over-http/">https://graphql.org/learn/serving-over-http/</a>
+ * <p>
  * There are more concerns in a fully fledged application such as your approach to permissions
  * and authentication and so on that are not shown here.
- *
+ * <p>
  * The backing data is the "star wars" example schema.  And fairly complex example query is as follows :
  *
  * <pre>
