Escape *s in OpenAPI documentation.

gbif · Nov 11, 2024 · fac4f5e · fac4f5e
1 parent fca2efa
commit fac4f5e
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/registry-ws/src/main/java/org/gbif/registry/ws/resources/BaseNetworkEntityResource.java b/registry-ws/src/main/java/org/gbif/registry/ws/resources/BaseNetworkEntityResource.java
@@ -193,7 +193,7 @@ protected BaseNetworkEntityResource(
         @Parameter(
             name = "modified",
             description =
-                "The modified date of the dataset. Accepts ranges and a '*' can be used as a wildcard, e.g.:modified=2023-04-01,*",
+                "The modified date of the dataset. Accepts ranges and a `*` can be used as a wildcard, e.g. `modified=2023-04-01,*`",
             schema = @Schema(implementation = Range.class),
             in = ParameterIn.QUERY,
             explode = Explode.TRUE),

diff --git a/registry-ws/src/main/java/org/gbif/registry/ws/resources/DatasetResource.java b/registry-ws/src/main/java/org/gbif/registry/ws/resources/DatasetResource.java
@@ -311,14 +311,14 @@ public DatasetResource(
         @Parameter(
             name = "recordCount",
             description =
-                "Number of records of the dataset. Accepts ranges and a '*' can be used as a wildcard.",
+                "Number of records of the dataset. Accepts ranges and a `*` can be used as a wildcard.",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY,
             example = "100,*"),
         @Parameter(
             name = "modifiedDate",
             description =
-                "Date when the dataset was modified the last time. Accepts ranges and a '*' can be used as a wildcard.",
+                "Date when the dataset was modified the last time. Accepts ranges and a `*` can be used as a wildcard.",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY,
             example = "2022-05-01,*"),

diff --git a/...rc/main/java/org/gbif/registry/ws/resources/collections/BaseCollectionEntityResource.java b/...rc/main/java/org/gbif/registry/ws/resources/collections/BaseCollectionEntityResource.java
@@ -210,7 +210,7 @@ protected BaseCollectionEntityResource(
         @Parameter(
             name = "numberSpecimens",
             description =
-                "Number of specimens. It supports ranges and a '*' can be used as a wildcard",
+                "Number of specimens. It supports ranges and a `*` can be used as a wildcard",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY),
         @Parameter(
@@ -226,13 +226,13 @@ protected BaseCollectionEntityResource(
         @Parameter(
             name = "occurrenceCount",
             description =
-                "Count of occurrences linked. It supports ranges and a '*' can be used as a wildcard",
+                "Count of occurrences linked. It supports ranges and a `*` can be used as a wildcard",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY),
         @Parameter(
             name = "typeSpecimenCount",
             description =
-                "Count of type specimens linked. It supports ranges and a '*' can be used as a wildcard",
+                "Count of type specimens linked. It supports ranges and a `*` can be used as a wildcard",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY),
         @Parameter(

diff --git a/registry-ws/src/main/java/org/gbif/registry/ws/resources/collections/CollectionResource.java b/registry-ws/src/main/java/org/gbif/registry/ws/resources/collections/CollectionResource.java
@@ -798,7 +798,7 @@ private static Path zipFiles(
         @Parameter(
             name = "individualCount",
             description =
-                "Individual count of the descriptor. It supports ranges and a '*' can be used as a wildcard",
+                "Individual count of the descriptor. It supports ranges and a `*` can be used as a wildcard",
             schema = @Schema(implementation = String.class),
             in = ParameterIn.QUERY),
         @Parameter(