Skip to content

Commit

Permalink
docs: html code selector
Browse files Browse the repository at this point in the history
  • Loading branch information
soyuka committed Nov 6, 2023
1 parent bd65d5e commit c47b588
Show file tree
Hide file tree
Showing 23 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/BooleanFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?published=true`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/DateFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/ExistsFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?exists[comment]=true`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/NumericFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price=10`.
*
Expand Down
4 changes: 2 additions & 2 deletions src/Doctrine/Odm/Filter/OrderFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
* </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`.
*
Expand Down Expand Up @@ -183,7 +183,7 @@
* </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
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/RangeFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Odm/Filter/SearchFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* @author Kévin Dunglas <dunglas@gmail.com>
* @author Alan Poulain <contact@alanpoulain.eu>
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/BooleanFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?published=true`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/DateFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/ExistsFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?exists[comment]=true`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/NumericFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books with the following query: `/books?price=10`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/OrderFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/RangeFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Doctrine/Orm/Filter/SearchFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* @author Kévin Dunglas <dunglas@gmail.com>
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Elasticsearch/Filter/MatchFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books by title content with the following query: `/books?title=Foundation`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Elasticsearch/Filter/OrderFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
* </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`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Elasticsearch/Filter/TermFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Given that the collection endpoint is `/books`, you can filter books by title with the following query: `/books?title=Foundation`.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Metadata/ApiProperty.php
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public function __construct(
* </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
Expand Down
34 changes: 17 additions & 17 deletions src/Metadata/ApiResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?string $sunset = null,
protected ?string $acceptPatch = null,
Expand Down Expand Up @@ -277,7 +277,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?int $urlGenerationStrategy = null,
/**
Expand Down Expand Up @@ -317,7 +317,7 @@ public function __construct(
* </resources>
* ```
*
* </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
Expand Down Expand Up @@ -382,7 +382,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?array $filters = null,
protected ?bool $elasticsearch = null,
Expand Down Expand Up @@ -424,7 +424,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* Note: when using `messenger=true` on a Doctrine entity, the Doctrine Processor is not called. If you want it
* to be called, you should [decorate a built-in state processor](/docs/guide/hook-a-persistence-layer-with-a-processor)
Expand Down Expand Up @@ -466,7 +466,7 @@ public function __construct(
* foo: ASC
* ```
*
* </CodeSelector>
* </div>
*
* This `order` attribute is used as an array: the key defines the order field, the values defines the direction.
* If you only specify the key, `ASC` direction will be used as default.
Expand Down Expand Up @@ -511,7 +511,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* The pagination can now be enabled (or disabled) by adding a query parameter named `pagination`:
* - `GET /books?pagination=false`: disabled
Expand Down Expand Up @@ -555,7 +555,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* The number of items can now be set by adding a query parameter named `itemsPerPage`:
* - `GET /books?itemsPerPage=50`
Expand Down Expand Up @@ -598,7 +598,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* The partial pagination can now be enabled (or disabled) by adding a query parameter named `partial`:
* - `GET /books?partial=false`: disabled
Expand Down Expand Up @@ -660,7 +660,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* To know more about cursor-based pagination take a look at [this blog post on medium (draft)](https://medium.com/@sroze/74fd1d324723).
*/
Expand Down Expand Up @@ -702,7 +702,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?bool $paginationEnabled = null,
/**
Expand Down Expand Up @@ -747,7 +747,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* For more information, please see the [Pagination](https://www.doctrine-project.org/projects/doctrine-orm/en/current/tutorials/pagination.html) entry in the Doctrine ORM documentation.
*/
Expand Down Expand Up @@ -793,7 +793,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*
* For more information, please see the [Pagination](https://www.doctrine-project.org/projects/doctrine-orm/en/current/tutorials/pagination.html) entry in the Doctrine ORM documentation.
*/
Expand Down Expand Up @@ -834,7 +834,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?int $paginationItemsPerPage = null,
/**
Expand Down Expand Up @@ -873,7 +873,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?int $paginationMaximumItemsPerPage = null,
/**
Expand Down Expand Up @@ -912,7 +912,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?bool $paginationPartial = null,
/**
Expand Down Expand Up @@ -951,7 +951,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?string $paginationType = null,
protected ?string $security = null,
Expand Down
2 changes: 1 addition & 1 deletion src/Metadata/HttpOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public function __construct(
* </resources>
* ```
*
* </CodeSelector>
* </div>
*/
protected ?string $sunset = null,
protected ?string $acceptPatch = null,
Expand Down

0 comments on commit c47b588

Please sign in to comment.