Merge 3.1

api-platform · Nov 6, 2023 · b1b4f14 · b1b4f14
2 parents 3ab7e87 + c47b588
commit b1b4f14
Show file tree

Hide file tree

Showing 23 changed files with 206 additions and 106 deletions.
diff --git a/src/Doctrine/Odm/Filter/BooleanFilter.php b/src/Doctrine/Odm/Filter/BooleanFilter.php
@@ -23,7 +23,8 @@
  *
  * Syntax: `?property=<true|false|1|0>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -94,7 +95,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?published=true`.
  *

diff --git a/src/Doctrine/Odm/Filter/DateFilter.php b/src/Doctrine/Odm/Filter/DateFilter.php
@@ -36,7 +36,8 @@
  * - Consider items as youngest: use `ApiPlatform\Doctrine\Odm\Filter\DateFilter::INCLUDE_NULL_AFTER` (`include_null_after`) strategy
  * - Always include items: use `ApiPlatform\Doctrine\Odm\Filter\DateFilter::INCLUDE_NULL_BEFORE_AND_AFTER` (`include_null_before_and_after`) strategy
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -107,7 +108,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by date with the following query: `/books?createdAt[after]=2018-03-19`.
  *

diff --git a/src/Doctrine/Odm/Filter/ExistsFilter.php b/src/Doctrine/Odm/Filter/ExistsFilter.php
@@ -27,7 +27,8 @@
  *
  * Syntax: `?exists[property]=<true|false|1|0>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -98,7 +99,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?exists[comment]=true`.
  *

diff --git a/src/Doctrine/Odm/Filter/NumericFilter.php b/src/Doctrine/Odm/Filter/NumericFilter.php
@@ -23,7 +23,8 @@
  *
  * Syntax: `?property=<int|bigint|decimal...>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -94,7 +95,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price=10`.
  *

diff --git a/src/Doctrine/Odm/Filter/OrderFilter.php b/src/Doctrine/Odm/Filter/OrderFilter.php
@@ -26,7 +26,8 @@
  *
  * Syntax: `?order[property]=<asc|desc>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -100,13 +101,15 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by title in ascending order and then by ID in descending order with the following query: `/books?order[title]=desc&order[id]=asc`.
  *
  * By default, whenever the query does not specify the direction explicitly (e.g.: `/books?order[title]&order[id]`), filters will not be applied unless you configure a default order direction to use:
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -179,7 +182,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * When the property used for ordering can contain `null` values, you may want to specify how `null` values are treated in the comparison:
  * - Use the default behavior of the DBMS: use `null` strategy

diff --git a/src/Doctrine/Odm/Filter/RangeFilter.php b/src/Doctrine/Odm/Filter/RangeFilter.php
@@ -23,7 +23,8 @@
  *
  * Syntax: `?property[<lt|gt|lte|gte|between>]=value`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -95,7 +96,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price[between]=12.99..15.99`.
  *

diff --git a/src/Doctrine/Odm/Filter/SearchFilter.php b/src/Doctrine/Odm/Filter/SearchFilter.php
@@ -56,7 +56,8 @@
  *
  * Syntax: `?property[]=foo&property[]=bar`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -129,7 +130,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * @author Kévin Dunglas <[email protected]>
  * @author Alan Poulain <[email protected]>

diff --git a/src/Doctrine/Orm/Filter/BooleanFilter.php b/src/Doctrine/Orm/Filter/BooleanFilter.php
@@ -25,7 +25,8 @@
  *
  * Syntax: `?property=<true|false|1|0>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -97,7 +98,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?published=true`.
  *

diff --git a/src/Doctrine/Orm/Filter/DateFilter.php b/src/Doctrine/Orm/Filter/DateFilter.php
@@ -39,7 +39,8 @@
  * - Consider items as youngest: use `ApiPlatform\Doctrine\Orm\Filter\DateFilter::INCLUDE_NULL_AFTER` (`include_null_after`) strategy
  * - Always include items: use `ApiPlatform\Doctrine\Orm\Filter\DateFilter::INCLUDE_NULL_BEFORE_AND_AFTER` (`include_null_before_and_after`) strategy
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -111,7 +112,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by date with the following query: `/books?createdAt[after]=2018-03-19`.
  *

diff --git a/src/Doctrine/Orm/Filter/ExistsFilter.php b/src/Doctrine/Orm/Filter/ExistsFilter.php
@@ -30,7 +30,8 @@
  *
  * Syntax: `?exists[property]=<true|false|1|0>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -102,7 +103,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?exists[comment]=true`.
  *

diff --git a/src/Doctrine/Orm/Filter/NumericFilter.php b/src/Doctrine/Orm/Filter/NumericFilter.php
@@ -25,7 +25,8 @@
  *
  * Syntax: `?property=<int|bigint|decimal...>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -97,7 +98,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price=10`.
  *

diff --git a/src/Doctrine/Orm/Filter/OrderFilter.php b/src/Doctrine/Orm/Filter/OrderFilter.php
@@ -28,7 +28,8 @@
  *
  * Syntax: `?order[property]=<asc|desc>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -102,7 +103,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by title in ascending order and then by ID in descending order with the following query: `/books?order[title]=desc&order[id]=asc`.
  *

diff --git a/src/Doctrine/Orm/Filter/RangeFilter.php b/src/Doctrine/Orm/Filter/RangeFilter.php
@@ -25,7 +25,8 @@
  *
  * Syntax: `?property[<lt|gt|lte|gte|between>]=value`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -97,7 +98,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price[between]=12.99..15.99`.
  *

diff --git a/src/Doctrine/Orm/Filter/SearchFilter.php b/src/Doctrine/Orm/Filter/SearchFilter.php
@@ -56,7 +56,8 @@
  *
  * Syntax: `?property[]=foo&property[]=bar`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -129,7 +130,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * @author Kévin Dunglas <[email protected]>
  */

diff --git a/src/Elasticsearch/Filter/MatchFilter.php b/src/Elasticsearch/Filter/MatchFilter.php
@@ -18,7 +18,8 @@
  *
  * Syntax: `?property[]=value`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -90,7 +91,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by title content with the following query: `/books?title=Foundation`.
  *

diff --git a/src/Elasticsearch/Filter/OrderFilter.php b/src/Elasticsearch/Filter/OrderFilter.php
@@ -24,7 +24,8 @@
  *
  * Syntax: `?order[property]=<asc|desc>`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -97,7 +98,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by ID and date in ascending or descending order: `/books?order[id]=asc&order[date]=desc`.
  *

diff --git a/src/Elasticsearch/Filter/TermFilter.php b/src/Elasticsearch/Filter/TermFilter.php
@@ -18,7 +18,8 @@
  *
  * Syntax: `?property[]=value`.
  *
- * <CodeSelector>
+ * <div data-code-selector>
+ *
  * ```php
  * <?php
  * // api/src/Entity/Book.php
@@ -89,7 +90,8 @@
  *     </resource>
  * </resources>
  * ```
- * </CodeSelector>
+ *
+ * </div>
  *
  * Given that the collection endpoint is `/books`, you can filter books by title with the following query: `/books?title=Foundation`.
  *

diff --git a/src/Metadata/ApiProperty.php b/src/Metadata/ApiProperty.php
@@ -55,7 +55,8 @@ public function __construct(
         /**
          * The `deprecationReason` option deprecates the current operation with a deprecation message.
          *
-         * <CodeSelector>
+         * <div data-code-selector>
+         *
          * ```php
          * <?php
          * // api/src/Entity/Review.php
@@ -90,7 +91,8 @@ public function __construct(
          *     <property resource="App\Entity\Review" name="letter" deprecationReason="Create a Book instead" />
          * </properties>
          * ```
-         * </CodeSelector>
+         *
+         * </div>
          *
          * - With JSON-lD / Hydra, [an `owl:deprecated` annotation property](https://www.w3.org/TR/owl2-syntax/#Annotation_Properties) will be added to the appropriate data structure
          * - With Swagger / OpenAPI, [a `deprecated` property](https://swagger.io/docs/specification/2-0/paths-and-operations/) will be added