This repository has been archived by the owner on Oct 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
/
Copy pathcrds.yaml
1803 lines (1803 loc) · 78.9 KB
/
crds.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.3.0
creationTimestamp: null
name: apidefinitions.tyk.tyk.io
spec:
additionalPrinterColumns:
- JSONPath: .spec.domain
name: Domain
type: string
- JSONPath: .spec.proxy.listen_path
name: ListenPath
type: string
- JSONPath: .spec.proxy.target_url
name: Proxy.TargetURL
type: string
- JSONPath: .spec.active
name: Enabled
type: boolean
group: tyk.tyk.io
names:
kind: ApiDefinition
listKind: ApiDefinitionList
plural: apidefinitions
shortNames:
- tykapis
singular: apidefinition
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
description: ApiDefinition is the Schema for the apidefinitions API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: APIDefinition represents the configuration for a single proxied API and it's versions.
properties:
CORS:
description: CORS cors settings
properties:
allow_credentials:
description: AllowCredentials if true will allow cookies
type: boolean
allowed_headers:
description: AllowedHeaders are headers that are allowed within a request.
items:
type: string
type: array
allowed_methods:
description: AllowedMethods is a list of methods to allow access via.
items:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
type: array
allowed_origins:
description: AllowedOrigins is a list of origin domains to allow access from.
items:
type: string
type: array
debug:
description: Debug if true, this option produces log files for the CORS middleware
type: boolean
enable:
description: Enable when set to true it enables the cors middleware for the api
type: boolean
exposed_headers:
description: ExposedHeaders is a list of headers that are exposed back in the response.
items:
type: string
type: array
max_age:
description: MaxAge is the maximum age of credentials
type: integer
options_passthrough:
description: OptionsPassthrough allow CORS OPTIONS preflight request to be proxied directly to upstream, without authentication and rest of checks. This means that pre-flight requests generated by web-clients such as SwaggerUI or the Tyk Portal documentation system will be able to test the API using trial keys. If your service handles CORS natively, then enable this option.
type: boolean
type: object
active:
description: Active specifies if the api is enabled or not
type: boolean
allowed_ips:
description: AllowedIPs is a list of IP address that are whitelisted.When this is provided all IP address that is not on this list will be blocked and a 403 http status will be returned. The IP address can be IPv4 or IPv6.IP in CIDR notation is also supported.
items:
type: string
type: array
api_id:
description: Only set this field if you are referring To an existing API in def. The Operator will use this API ID to link the CRD with the API in Tyk Note the values in the CRD will become the new source of truth, overriding the existing API Definition
type: string
auth:
properties:
auth_header_name:
type: string
cookie_name:
type: string
param_name:
type: string
signature:
properties:
algorithm:
type: string
allowed_clock_skew:
format: int64
type: integer
error_code:
type: integer
error_message:
type: string
header:
type: string
secret:
type: string
required:
- algorithm
- allowed_clock_skew
- error_code
- error_message
- header
- secret
type: object
use_certificate:
type: boolean
use_cookie:
type: boolean
use_param:
type: boolean
validate_signature:
type: boolean
required:
- auth_header_name
type: object
auth_configs:
additionalProperties:
properties:
auth_header_name:
type: string
cookie_name:
type: string
param_name:
type: string
signature:
properties:
algorithm:
type: string
allowed_clock_skew:
format: int64
type: integer
error_code:
type: integer
error_message:
type: string
header:
type: string
secret:
type: string
required:
- algorithm
- allowed_clock_skew
- error_code
- error_message
- header
- secret
type: object
use_certificate:
type: boolean
use_cookie:
type: boolean
use_param:
type: boolean
validate_signature:
type: boolean
required:
- auth_header_name
type: object
type: object
blacklisted_ips:
description: BlacklistedIPs is a list of IP address that will be blacklisted.This means if origin IP matches any IP in this list a 403 http status code will be returned. The IP address can be IPv4 or IPv6. IP in CIDR notation is also supported.
items:
type: string
type: array
cache_options:
properties:
cache_all_safe_requests:
description: CacheAllSafeRequests caches responses to (GET, HEAD, OPTIONS) requests overrides per-path cache settings in versions, applies across versions
type: boolean
cache_by_headers:
description: CacheByHeaders allows header values to be used as part of the cache key
items:
type: string
type: array
cache_control_ttl_header:
description: CacheControlTTLHeader is the response header which tells Tyk how long it is safe to cache the response for
type: string
cache_response_codes:
description: CacheOnlyResponseCodes is an array of response codes which are safe to cache. e.g. 404
items:
type: integer
type: array
cache_timeout:
description: CacheTimeout is the TTL for a cached object in seconds
format: int64
type: integer
enable_cache:
description: EnableCache turns global cache middleware on or off. It is still possible to enable caching on a per-path basis by explicitly setting the endpoint cache middleware. see `spec.version_data.versions.{VERSION}.extended_paths.cache[]`
type: boolean
enable_upstream_cache_control:
description: EnableUpstreamCacheControl instructs Tyk Cache to respect upstream cache control headers
type: boolean
required:
- cache_timeout
type: object
certificate_secret_names:
description: CertificateSecretNames represents the names of the secrets that the controller should look for in the in the current namespace which contain the certificates.
items:
type: string
type: array
certificates:
description: Certificates is a list of Tyk Certificate IDs. e.g. orgid+fingerprint. Use CertificateSecretNames if using cert-manager
items:
type: string
type: array
custom_middleware:
properties:
auth_check:
properties:
name:
type: string
path:
type: string
raw_body_only:
type: boolean
require_session:
type: boolean
required:
- name
- path
type: object
driver:
type: string
id_extractor:
properties:
extract_from:
type: string
extract_with:
type: string
extractor_config:
properties:
header_name:
type: string
param_name:
type: string
regex_expression:
type: string
regex_match_index:
type: integer
type: object
required:
- extract_from
- extract_with
- extractor_config
type: object
post:
items:
properties:
name:
type: string
path:
type: string
raw_body_only:
type: boolean
require_session:
type: boolean
required:
- name
- path
type: object
type: array
post_key_auth:
items:
properties:
name:
type: string
path:
type: string
raw_body_only:
type: boolean
require_session:
type: boolean
required:
- name
- path
type: object
type: array
pre:
items:
properties:
name:
type: string
path:
type: string
raw_body_only:
type: boolean
require_session:
type: boolean
required:
- name
- path
type: object
type: array
response:
items:
properties:
name:
type: string
path:
type: string
raw_body_only:
type: boolean
require_session:
type: boolean
required:
- name
- path
type: object
type: array
required:
- driver
type: object
definition:
properties:
key:
type: string
location:
type: string
strip_path:
type: boolean
required:
- key
- location
- strip_path
type: object
do_not_track:
description: DoNotTrack disables endpoint tracking for this API. Default is true, you need to explicitly set it to false
type: boolean
domain:
description: Domain represents a custom host header that the gateway will listen on for this API
type: string
enable_context_vars:
description: EnableContextVars extracts request context variables from the start of the middleware chain. Set this to true to make them available to your transforms. Context Variables are available in the url rewriter, modify headers and body transforms.
type: boolean
enable_coprocess_auth:
type: boolean
enable_detailed_recording:
description: EnableDetailedRecording instructs Tyk store the inbound request and outbound response data in HTTP Wire format as part of the Analytics data
type: boolean
enable_ip_blacklisting:
description: EnableIPBlacklisting activates the ip blacklisting middleware.
type: boolean
enable_ip_whitelisting:
description: EnableIPWhiteListing activates the ip whitelisting middleware.
type: boolean
enable_jwt:
description: EnableJWT set JWT as the access method for this API.
type: boolean
graphql:
description: GraphQLConfig is the root config object for a GraphQL API.
properties:
enabled:
description: Enabled indicates if GraphQL proxy should be enabled.
type: boolean
execution_mode:
description: ExecutionMode is the mode to define how an api behaves.
enum:
- proxyOnly
- executionEngine
type: string
playground:
description: GraphQLPlayground is the Playground specific configuration.
properties:
enabled:
description: Enabled indicates if the playground should be enabled.
type: boolean
path:
description: Path sets the path on which the playground will be hosted if enabled.
type: string
required:
- enabled
- path
type: object
schema:
description: Schema is the GraphQL Schema exposed by the GraphQL API/Upstream/Engine.
type: string
type_field_configurations:
description: TypeFieldConfigurations is a rule set of data source and mapping of a schema field.
items:
properties:
data_source:
properties:
data_source_config:
description: Config is the DataSource specific configuration object Each Planner needs to make sure to parse their Config Object correctly
properties:
body:
type: string
default_type_name:
type: string
headers:
items:
type: string
type: array
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
status_code_type_name_mappings:
items:
properties:
status_code:
type: integer
type_name:
type: string
required:
- status_code
type: object
type: array
url:
type: string
required:
- method
- url
type: object
kind:
description: Kind defines the unique identifier of the DataSource Kind needs to match to the Planner "DataSourceName" name
enum:
- GraphQLDataSource
- HTTPJSONDataSource
type: string
required:
- kind
type: object
field_name:
type: string
mapping:
properties:
disabled:
type: boolean
path:
type: string
required:
- disabled
- path
type: object
type_name:
type: string
required:
- data_source
- field_name
- mapping
- type_name
type: object
type: array
required:
- enabled
- execution_mode
- schema
type: object
id:
description: For server use only, do not use
type: string
jwt_client_base_field:
description: JWTClientIDBaseField is the name of the field on JWT claim to use for client id. This field is mutually exclusive to jwt_identity_base_field, meaning you can only set/use one and jwt_identity_base_field takes precedence when both are set.
type: string
jwt_default_policies:
description: JWTDefaultPolicies is a list of policies that will be used when base policy can't be extracted from the JWT token. When this list is provided the first element will be used as the base policy while the rest of elements will be applied.
items:
type: string
type: array
jwt_expires_at_validation_skew:
description: "JWTExpiresAtValidationSkew adds validation for expired at JWT claim. Given \tnow = current unix time \tskew = jwt_expires_at_validation_skew \texp = expired at If exp > (now - skew) then validation will fail with \"token has expired\""
format: int64
type: integer
jwt_identity_base_field:
description: JWTIdentityBaseField Identifies the user or identity to be used in the Claims of the JWT. This will fallback to sub if not found. This field forms the basis of a new “virtual” token that gets used after validation. It means policy attributes are carried forward through Tyk for attribution purposes.
type: string
jwt_issued_at_validation_skew:
description: "JWTIssuedAtValidationSkew adds validation for issued at JWT claim. Given \tnow = current unix time \tskew = jwt_issued_at_validation_skew \tiat = the issued at jwt claim If iat > (now + skew) then validation will fail with \"token used before issued\""
format: int64
type: integer
jwt_not_before_validation_skew:
description: "JWTNotBeforeValidationSkew adds validation for not before JWT claim. Given \tnow = current unix time \tskew = jwt_not_before_validation_skew \tnbf = the not before jwt claim If nbf > (now + skew) then validation will fail with \"token is not valid yet\""
format: int64
type: integer
jwt_policy_field_name:
description: JWTPolicyFieldName The policy ID to apply to the virtual token generated for a JWT
type: string
jwt_scope_claim_name:
description: JWTScopeClaimName overides the key used for scope values in the JWT claims. By default the value is "scope"
type: string
jwt_scope_to_policy_mapping:
additionalProperties:
type: string
description: JWTScopeToPolicyMapping this is a mapping of scope value to policy id. If this is set then a scope value found in this map will make the mappend policy to be applied.
type: object
jwt_signing_method:
description: JWTSigningMethod algorithm used to sign jwt token
enum:
- rsa
- hmac
- ecdsa
type: string
jwt_skip_kid:
description: JWTSkipKid when true we ingore using kid as the identity for a JWT token and instead use jwt_identity_base_field if it was set or fallback to sub JWT claim.
type: boolean
jwt_source:
description: JWTSource Must either be a base64 encoded valid RSA/HMAC key or a url to a resource serving JWK, this key will then be used to validate inbound JWT and throttle them according to the centralised JWT options and fields set in the configuration.
type: string
listen_port:
type: integer
name:
type: string
org_id:
description: OrgID is overwritten - no point setting this
type: string
protocol:
enum:
- http
- https
- tcp
- tls
type: string
proxy:
description: Proxy
properties:
check_host_against_uptime_tests:
description: CheckHostAgainstUptimeTests will check the hostname of the outbound request against the downtime list generated by the uptime test host checker. If the host is found, then it is skipped or removed from the load balancer. This is only valid if uptime tests for the api are enabled.
type: boolean
disable_strip_slash:
description: DisableStripSlash disables the stripping of the slash suffix from a URL. when `true` a request to http://foo.bar/baz/ will be retained. when `false` a request to http://foo.bar/baz/ will be matched to http://foo.bar/baz
type: boolean
enable_load_balancing:
description: EnableLoadBalancing enables Tyk's round-robin loadbalancer. Tyk will ignore the TargetURL field, and rely on the hosts in the Targets list
type: boolean
listen_path:
description: ListenPath represents the path to listen on. e.g. `/api` or `/` or `/httpbin`. Any requests coming into the host, on the port that Tyk is configured to run on, that match this path will have the rules defined in the API Definition applied. Versioning assumes that different versions of an API will live on the same URL structure. If you are using URL-based versioning (e.g. /v1/function, /v2/function) then it is recommended to set up a separate non-versioned definition for each version as they are essentially separate APIs.
type: string
preserve_host_header:
description: If PreserveHostHeader is set to true then the host header in the outbound request is retained to be the inbound hostname of the proxy.
type: boolean
service_discovery:
description: 'TODO: Untested. Is there a use-case for SD inside a K8s environment?'
properties:
cache_timeout:
format: int64
type: integer
data_path:
type: string
endpoint_returns_list:
type: boolean
parent_data_path:
type: string
port_data_path:
type: string
query_endpoint:
type: string
target_path:
type: string
use_discovery_service:
type: boolean
use_nested_query:
type: boolean
use_target_list:
type: boolean
required:
- cache_timeout
- data_path
- endpoint_returns_list
- parent_data_path
- port_data_path
- query_endpoint
- target_path
- use_discovery_service
- use_nested_query
- use_target_list
type: object
strip_listen_path:
description: StripListenPath removes the inbound listen path in the outgoing request. e.g. http://acme.com/httpbin/get where `httpbin` is the listen path. The `httpbin` listen path which is used to identify the API loaded in Tyk is removed, and the outbound request would be http://httpbin.org/get
type: boolean
target_list:
description: Targets defines a list of upstream host targets. Tyk will then round-robin load balance between these targets. EnableLoadBalancing must be set to true in order to take advantage of this feature.
items:
type: string
type: array
target_url:
description: TargetURL defines the target URL that the request should be proxied to.
type: string
transport:
description: Transport section exposes advanced transport level configurations such as minimum TLS version.
properties:
proxy_url:
description: ProxyURL specifies custom forward proxy & port. e.g. `http(s)://proxy.url:1234`
type: string
ssl_ciphers:
description: SSLCipherSuites is an array of acceptable cipher suites. A list of allowed cipher suites can be found in the Go Crypto TLS package constants documentation https://golang.org/pkg/crypto/tls/#pkg-constants
items:
type: string
type: array
ssl_force_common_name_check:
description: SSLForceCommonNameCheck forces hostname validation against the certificate Common Name
type: boolean
ssl_insecure_skip_verify:
description: SSLInsecureSkipVerify controls whether it is possible to use self-signed certificates when connecting to the upstream. This is applied to `TykMakeHttpRequest` & `TykMakeBatchRequest` in virtual endpoint middleware.
type: boolean
ssl_min_version:
description: 'SSLMinVersion defines the minimum TLS version the gateway will use to establish a connection to the upstream. 1.0: 769; 1.1: 770; 1.2: 771; 1.3: 772.'
enum:
- 769
- 770
- 771
- 772
type: integer
type: object
required:
- target_url
type: object
response_processors:
items:
properties:
name:
type: string
required:
- name
type: object
type: array
session_lifetime:
description: "SessionLifetime this is duration in seconds before the session key expires in redis. \n Example: If you want the session keys to be alive only 24 hours you can set this value to 86400 that we can break down to \t60 * 60 * 24 = Total seconds in a day"
format: int64
type: integer
strip_auth_data:
description: StripAuthData ensures that any security tokens used for accessing APIs are stripped and not leaked to the upstream
type: boolean
tags:
description: Tags are named gateway nodes which tell gateway clusters whether to load an API or not. for example, to load the API in an ARA gateway, you might want to include an `edge` tag.
items:
type: string
type: array
use_keyless:
description: UseKeylessAccess will switch off all key checking. Some analytics will still be recorded, but rate-limiting, quotas and security policies will not be possible (there is no session to attach requests to).
type: boolean
use_standard_auth:
description: UseStandardAuth enables simple bearer token authentication
type: boolean
version_data:
properties:
default_version:
type: string
not_versioned:
type: boolean
versions:
additionalProperties:
properties:
expires:
type: string
extended_paths:
properties:
advance_cache_config:
items:
properties:
cache_key_regex:
type: string
cache_response_codes:
items:
type: integer
type: array
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
required:
- cache_key_regex
- cache_response_codes
- method
- path
type: object
type: array
black_list:
items:
properties:
ignore_case:
type: boolean
method_actions:
additionalProperties:
properties:
action:
type: string
code:
type: integer
data:
type: string
headers:
additionalProperties:
type: string
type: object
required:
- action
- code
- data
- headers
type: object
type: object
path:
type: string
required:
- ignore_case
- method_actions
- path
type: object
type: array
cache:
description: List of paths which cache middleware should be enabled on
items:
type: string
type: array
circuit_breakers:
items:
properties:
disable_half_open_state:
type: boolean
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
return_to_service_after:
description: ReturnToServiceAfter represents the time in seconds to return back to the service
type: integer
samples:
description: Samples defines the number of requests to base the ThresholdPercent on
format: int64
type: integer
threshold_percent:
description: ThresholdPercent is the percentage of requests that fail before breaker is tripped
pattern: ^0\.\d+|1\.0$
type: string
required:
- method
- path
- return_to_service_after
- samples
- threshold_percent
type: object
type: array
do_not_track_endpoints:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
required:
- method
- path
type: object
type: array
hard_timeouts:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
timeout:
type: integer
required:
- method
- path
- timeout
type: object
type: array
ignored:
items:
properties:
ignore_case:
type: boolean
method_actions:
additionalProperties:
properties:
action:
type: string
code:
type: integer
data:
type: string
headers:
additionalProperties:
type: string
type: object
required:
- action
- code
- data
- headers
type: object
type: object
path:
type: string
required:
- ignore_case
- method_actions
- path
type: object
type: array
internal:
description: ValidateJSON []ValidatePathMeta `json:"validate_json,omitempty"` // Breaking integration test?
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
required:
- method
- path
type: object
type: array
method_transforms:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
to_method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
required:
- method
- path
- to_method
type: object
type: array
size_limits:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
size_limit:
format: int64
type: integer
required:
- method
- path
- size_limit
type: object
type: array
track_endpoints:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
- CONNECT
- TRACE
type: string
path:
type: string
required:
- method
- path
type: object
type: array
transform:
items:
properties:
method:
description: Method represents HTTP request method
enum:
- GET
- POST