Skip to content

Commit e872cea

Browse files
committed
api: update reference.php
1 parent 0c677e0 commit e872cea

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

api/config/reference.php

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@
474474
* max_host_connections?: int, // The maximum number of connections to a single host.
475475
* default_options?: array{
476476
* headers?: array<string, mixed>,
477-
* vars?: list<mixed>,
477+
* vars?: array<string, mixed>,
478478
* max_redirects?: int, // The maximum number of redirects to follow.
479479
* http_version?: scalar|null, // The default HTTP version, typically 1.1 or 2.0, leave to null for the best version.
480480
* resolve?: array<string, scalar|null>,
@@ -497,7 +497,7 @@
497497
* md5?: mixed,
498498
* },
499499
* crypto_method?: scalar|null, // The minimum version of TLS to accept; must be one of STREAM_CRYPTO_METHOD_TLSv*_CLIENT constants.
500-
* extra?: list<mixed>,
500+
* extra?: array<string, mixed>,
501501
* rate_limiter?: scalar|null, // Rate limiter name to use for throttling requests. // Default: null
502502
* caching?: bool|array{ // Caching configuration.
503503
* enabled?: bool, // Default: false
@@ -550,7 +550,7 @@
550550
* md5?: mixed,
551551
* },
552552
* crypto_method?: scalar|null, // The minimum version of TLS to accept; must be one of STREAM_CRYPTO_METHOD_TLSv*_CLIENT constants.
553-
* extra?: list<mixed>,
553+
* extra?: array<string, mixed>,
554554
* rate_limiter?: scalar|null, // Rate limiter name to use for throttling requests. // Default: null
555555
* caching?: bool|array{ // Caching configuration.
556556
* enabled?: bool, // Default: false
@@ -1241,7 +1241,7 @@
12411241
* inflector?: scalar|null, // Specify an inflector to use. // Default: "api_platform.metadata.inflector"
12421242
* validator?: array{
12431243
* serialize_payload_fields?: mixed, // Set to null to serialize all payload fields when a validation error is thrown, or set the fields you want to include explicitly. // Default: []
1244-
* query_parameter_validation?: bool, // Default: true
1244+
* query_parameter_validation?: bool, // Deprecated: Will be removed in API Platform 5.0. // Default: true
12451245
* },
12461246
* eager_loading?: bool|array{
12471247
* enabled?: bool, // Default: true
@@ -1251,11 +1251,13 @@
12511251
* },
12521252
* handle_symfony_errors?: bool, // Allows to handle symfony exceptions. // Default: false
12531253
* enable_swagger?: bool, // Enable the Swagger documentation and export. // Default: true
1254+
* enable_json_streamer?: bool, // Enable json streamer. // Default: false
12541255
* enable_swagger_ui?: bool, // Enable Swagger UI // Default: true
12551256
* enable_re_doc?: bool, // Enable ReDoc // Default: true
12561257
* enable_entrypoint?: bool, // Enable the entrypoint // Default: true
12571258
* enable_docs?: bool, // Enable the docs // Default: true
12581259
* enable_profiler?: bool, // Enable the data collector and the WebProfilerBundle integration. // Default: true
1260+
* enable_phpdoc_parser?: bool, // Enable resource metadata collector using PHPStan PhpDocParser. // Default: true
12591261
* enable_link_security?: bool, // Enable security for Links (sub resources) // Default: false
12601262
* collection?: array{
12611263
* exists_parameter_name?: scalar|null, // The name of the query parameter to filter on nullable field values. // Default: "exists"
@@ -1271,6 +1273,7 @@
12711273
* },
12721274
* },
12731275
* mapping?: array{
1276+
* imports?: list<scalar|null>,
12741277
* paths?: list<scalar|null>,
12751278
* },
12761279
* resource_class_directories?: list<scalar|null>,
@@ -1345,7 +1348,7 @@
13451348
* mercure?: bool|array{
13461349
* enabled?: bool, // Default: false
13471350
* hub_url?: scalar|null, // The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle's default hub. // Default: null
1348-
* include_type?: bool, // Always include @var in updates (including delete ones). // Default: false
1351+
* include_type?: bool, // Always include @type in updates (including delete ones). // Default: false
13491352
* },
13501353
* messenger?: bool|array{
13511354
* enabled?: bool, // Default: false
@@ -1368,9 +1371,12 @@
13681371
* license?: array{
13691372
* name?: scalar|null, // The license name used for the API. // Default: null
13701373
* url?: scalar|null, // URL to the license used for the API. MUST be in the format of a URL. // Default: null
1374+
* identifier?: scalar|null, // An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. // Default: null
13711375
* },
13721376
* swagger_ui_extra_configuration?: mixed, // To pass extra configuration to Swagger UI, like docExpansion or filter. // Default: []
13731377
* overrideResponses?: bool, // Whether API Platform adds automatic responses to the OpenAPI documentation. // Default: true
1378+
* error_resource_class?: scalar|null, // The class used to represent errors in the OpenAPI documentation. // Default: null
1379+
* validation_error_resource_class?: scalar|null, // The class used to represent validation errors in the OpenAPI documentation. // Default: null
13741380
* },
13751381
* maker?: bool|array{
13761382
* enabled?: bool, // Default: true
@@ -1461,7 +1467,9 @@
14611467
* parameters?: mixed,
14621468
* strict_query_parameter_validation?: mixed,
14631469
* hide_hydra_operation?: mixed,
1470+
* json_stream?: mixed,
14641471
* extra_properties?: mixed,
1472+
* map?: mixed,
14651473
* route_name?: mixed,
14661474
* errors?: mixed,
14671475
* read?: mixed,
@@ -1512,6 +1520,11 @@
15121520
* intercept_redirects?: bool, // Default: false
15131521
* excluded_ajax_paths?: scalar|null, // Default: "^/((index|app(_[\\w]+)?)\\.php/)?_wdt"
15141522
* }
1523+
* @psalm-type MakerConfig = array{
1524+
* root_namespace?: scalar|null, // Default: "App"
1525+
* generate_final_classes?: bool, // Default: true
1526+
* generate_final_entities?: bool, // Default: false
1527+
* }
15151528
* @psalm-type DoctrineMigrationsConfig = array{
15161529
* enable_service_migrations?: bool, // Whether to enable fetching migrations from the service container. // Default: false
15171530
* migrations_paths?: array<string, scalar|null>,
@@ -1750,6 +1763,9 @@
17501763
* uploadable?: scalar|null, // Default: "Gedmo\\Uploadable\\UploadableListener"
17511764
* reference_integrity?: scalar|null, // Default: "Gedmo\\ReferenceIntegrity\\ReferenceIntegrityListener"
17521765
* },
1766+
* softdeleteable?: array{
1767+
* handle_post_flush_event?: bool, // Default: false
1768+
* },
17531769
* uploadable?: array{
17541770
* default_file_path?: scalar|null, // Default: null
17551771
* mime_type_guesser_class?: scalar|null, // Default: "Stof\\DoctrineExtensionsBundle\\Uploadable\\MimeTypeGuesserAdapter"
@@ -1902,6 +1918,7 @@
19021918
* traces_sampler?: scalar|null,
19031919
* profiles_sample_rate?: float, // The sampling factor to apply to profiles. A value of 0 will deny sending any profiles, and a value of 1 will send all profiles. Profiles are sampled in relation to traces_sample_rate
19041920
* enable_logs?: bool,
1921+
* enable_metrics?: bool, // Default: true
19051922
* attach_stacktrace?: bool,
19061923
* attach_metric_code_locations?: bool,
19071924
* context_lines?: int,
@@ -1918,6 +1935,7 @@
19181935
* before_send_check_in?: scalar|null,
19191936
* before_send_metrics?: scalar|null,
19201937
* before_send_log?: scalar|null,
1938+
* before_send_metric?: scalar|null,
19211939
* trace_propagation_targets?: mixed,
19221940
* tags?: array<string, scalar|null>,
19231941
* error_types?: scalar|null,
@@ -1936,7 +1954,7 @@
19361954
* http_ssl_verify_peer?: bool,
19371955
* http_compression?: bool,
19381956
* capture_silenced_errors?: bool,
1939-
* max_request_body_size?: "none"|"small"|"medium"|"always",
1957+
* max_request_body_size?: "none"|"never"|"small"|"medium"|"always",
19401958
* class_serializers?: array<string, scalar|null>,
19411959
* },
19421960
* messenger?: bool|array{
@@ -2242,11 +2260,6 @@
22422260
* return_expiration?: scalar|null, // When true, the response will include the token expiration timestamp // Default: false
22432261
* return_expiration_parameter_name?: scalar|null, // The default response parameter name containing the refresh token expiration timestamp // Default: "refresh_token_expiration"
22442262
* }
2245-
* @psalm-type MakerConfig = array{
2246-
* root_namespace?: scalar|null, // Default: "App"
2247-
* generate_final_classes?: bool, // Default: true
2248-
* generate_final_entities?: bool, // Default: false
2249-
* }
22502263
* @psalm-type ConfigType = array{
22512264
* imports?: ImportsConfig,
22522265
* parameters?: ParametersConfig,
@@ -2349,13 +2362,15 @@
23492362
* }>
23502363
* }
23512364
*/
2352-
final class App {
2365+
final class App
2366+
{
23532367
/**
23542368
* @param ConfigType $config
23552369
*
23562370
* @psalm-return ConfigType
23572371
*/
2358-
public static function config(array $config): array {
2372+
public static function config(array $config): array
2373+
{
23592374
return AppReference::config($config);
23602375
}
23612376
}
@@ -2424,13 +2439,15 @@ public static function config(array $config): array {
24242439
* ...<string, RouteConfig|ImportConfig|AliasConfig>
24252440
* }
24262441
*/
2427-
final class Routes {
2442+
final class Routes
2443+
{
24282444
/**
24292445
* @param RoutesConfig $config
24302446
*
24312447
* @psalm-return RoutesConfig
24322448
*/
2433-
public static function config(array $config): array {
2449+
public static function config(array $config): array
2450+
{
24342451
return $config;
24352452
}
24362453
}

0 commit comments

Comments
 (0)