Skip to content

Commit ec56f09

Browse files
bastelfreakbastelfreak
authored
Merge pull request #1636 from voxpupuli/lint
fix: lint issues in types and update REFERENCE.md
2 parents e407777 + df1223c commit ec56f09

File tree

6 files changed

+167
-124
lines changed

6 files changed

+167
-124
lines changed

‎REFERENCE.md‎

Lines changed: 106 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1960,6 +1960,10 @@ The following parameters are available in the `nginx::resource::location` define
19601960
* [`add_header`](#-nginx--resource--location--add_header)
19611961
* [`gzip_static`](#-nginx--resource--location--gzip_static)
19621962
* [`reset_timedout_connection`](#-nginx--resource--location--reset_timedout_connection)
1963+
* [`format_log`](#-nginx--resource--location--format_log)
1964+
* [`access_log`](#-nginx--resource--location--access_log)
1965+
* [`error_log`](#-nginx--resource--location--error_log)
1966+
* [`log_not_found`](#-nginx--resource--location--log_not_found)
19631967
* [`fastcgi_index`](#-nginx--resource--location--fastcgi_index)
19641968
* [`rewrite_rules`](#-nginx--resource--location--rewrite_rules)
19651969

@@ -1983,7 +1987,7 @@ Default value: `false`
19831987

19841988
##### <a name="-nginx--resource--location--server"></a>`server`
19851989

1986-
Data type: `Variant[String[1],Array[String[1],1]]`
1990+
Data type: `Variant[String[1], Array[String[1], 1]]`
19871991

19881992
Defines a server or list of servers that include this location
19891993

@@ -2523,7 +2527,7 @@ Default value: `undef`
25232527

25242528
##### <a name="-nginx--resource--location--priority"></a>`priority`
25252529

2526-
Data type: `Integer[401,599]`
2530+
Data type: `Integer[401, 599]`
25272531

25282532
Location priority. User priority 401-499, 501-599. If the priority is
25292533
higher than the default priority (500), the location will be defined after
@@ -2583,6 +2587,45 @@ with the non-standard code 444.
25832587

25842588
Default value: `undef`
25852589

2590+
##### <a name="-nginx--resource--location--format_log"></a>`format_log`
2591+
2592+
Data type: `Optional[String[1]]`
2593+
2594+
Log_format to use with the defined access_log
2595+
2596+
Default value: `$nginx::http_format_log`
2597+
2598+
##### <a name="-nginx--resource--location--access_log"></a>`access_log`
2599+
2600+
Data type: `Optional[Variant[Array[String[1], 1], String[1]]]`
2601+
2602+
Where to write access log (log format can be set with $format_log). This
2603+
can be either a string or an array; in the latter case, multiple lines will
2604+
be created. Additionally, unlike the earlier behavior, setting it to
2605+
'absent' in the server context will remove this directive entirely from the
2606+
server stanza, rather than setting a default. Can also be disabled for this
2607+
server with the string 'off'.
2608+
2609+
Default value: `undef`
2610+
2611+
##### <a name="-nginx--resource--location--error_log"></a>`error_log`
2612+
2613+
Data type: `Optional[Variant[Array[String[1], 1], String[1]]]`
2614+
2615+
Where to write error log. May add additional options like error level to
2616+
the end. May set to 'absent', in which case it will be omitted in this
2617+
server stanza (and default to nginx.conf setting)
2618+
2619+
Default value: `undef`
2620+
2621+
##### <a name="-nginx--resource--location--log_not_found"></a>`log_not_found`
2622+
2623+
Data type: `Optional[Enum['on', 'off']]`
2624+
2625+
Enables or disables the logging of not found errors in error_log
2626+
2627+
Default value: `undef`
2628+
25862629
##### <a name="-nginx--resource--location--fastcgi_index"></a>`fastcgi_index`
25872630

25882631
Data type: `Optional[String]`
@@ -5202,8 +5245,8 @@ Alias of
52025245

52035246
```puppet
52045247
Variant[String[1], Struct[{
5205-
Optional[escape] => Enum['default', 'json', 'none'],
5206-
format => String[1],
5248+
Optional[escape] => Enum['default', 'json', 'none'],
5249+
format => String[1],
52075250
}]]
52085251
```
52095252

@@ -5284,24 +5327,24 @@ Alias of
52845327

52855328
```puppet
52865329
Struct[{
5287-
context => Optional[Enum['http', 'stream']],
5288-
member_defaults => Optional[Nginx::UpstreamMemberDefaults],
5289-
hash => Optional[String],
5290-
ip_hash => Optional[Boolean],
5291-
keepalive => Optional[Integer[1]],
5292-
kepalive_requests => Optional[Integer[1]],
5293-
keepalive_timeout => Optional[Nginx::Time],
5294-
least_conn => Optional[Boolean],
5295-
least_time => Optional[Nginx::UpstreamLeastTime],
5296-
ntlm => Optional[Boolean],
5297-
queue_max => Optional[Integer],
5298-
queue_timeout => Optional[Nginx::Time],
5299-
random => Optional[String],
5300-
statefile => Optional[Stdlib::Unixpath],
5301-
sticky => Optional[Nginx::UpstreamSticky],
5302-
zone => Optional[Nginx::UpstreamZone],
5303-
cfg_append => Optional[Hash],
5304-
cfg_prepend => Optional[Hash],
5330+
context => Optional[Enum['http', 'stream']],
5331+
member_defaults => Optional[Nginx::UpstreamMemberDefaults],
5332+
hash => Optional[String],
5333+
ip_hash => Optional[Boolean],
5334+
keepalive => Optional[Integer[1]],
5335+
kepalive_requests => Optional[Integer[1]],
5336+
keepalive_timeout => Optional[Nginx::Time],
5337+
least_conn => Optional[Boolean],
5338+
least_time => Optional[Nginx::UpstreamLeastTime],
5339+
ntlm => Optional[Boolean],
5340+
queue_max => Optional[Integer],
5341+
queue_timeout => Optional[Nginx::Time],
5342+
random => Optional[String],
5343+
statefile => Optional[Stdlib::Unixpath],
5344+
sticky => Optional[Nginx::UpstreamSticky],
5345+
zone => Optional[Nginx::UpstreamZone],
5346+
cfg_append => Optional[Hash],
5347+
cfg_prepend => Optional[Hash],
53055348
}]
53065349
```
53075350

@@ -5331,21 +5374,21 @@ Alias of
53315374

53325375
```puppet
53335376
Struct[{
5334-
server => Optional[Nginx::UpstreamMemberServer],
5335-
port => Optional[Stdlib::Port],
5336-
weight => Optional[Integer[1]],
5337-
max_conns => Optional[Integer[1]],
5338-
max_fails => Optional[Integer[0]],
5339-
fail_timeout => Optional[Nginx::Time],
5340-
backup => Optional[Boolean],
5341-
resolve => Optional[Boolean],
5342-
route => Optional[String],
5343-
service => Optional[String],
5344-
slow_start => Optional[Nginx::Time],
5345-
state => Optional[Enum['drain','down']],
5346-
params_prepend => Optional[String],
5347-
params_append => Optional[String],
5348-
comment => Optional[String],
5377+
server => Optional[Nginx::UpstreamMemberServer],
5378+
port => Optional[Stdlib::Port],
5379+
weight => Optional[Integer[1]],
5380+
max_conns => Optional[Integer[1]],
5381+
max_fails => Optional[Integer[0]],
5382+
fail_timeout => Optional[Nginx::Time],
5383+
backup => Optional[Boolean],
5384+
resolve => Optional[Boolean],
5385+
route => Optional[String],
5386+
service => Optional[String],
5387+
slow_start => Optional[Nginx::Time],
5388+
state => Optional[Enum['drain','down']],
5389+
params_prepend => Optional[String],
5390+
params_append => Optional[String],
5391+
comment => Optional[String],
53495392
}]
53505393
```
53515394

@@ -5357,20 +5400,20 @@ Alias of
53575400

53585401
```puppet
53595402
Struct[{
5360-
server => Optional[Nginx::UpstreamMemberServer],
5361-
port => Optional[Stdlib::Port],
5362-
weight => Optional[Integer[1]],
5363-
max_conns => Optional[Integer[1]],
5364-
max_fails => Optional[Integer[0]],
5365-
fail_timeout => Optional[Nginx::Time],
5366-
backup => Optional[Boolean],
5367-
resolve => Optional[Boolean],
5368-
route => Optional[String],
5369-
service => Optional[String],
5370-
slow_start => Optional[Nginx::Time],
5371-
state => Optional[Enum['drain','down']],
5372-
params_prepend => Optional[String],
5373-
params_append => Optional[String],
5403+
server => Optional[Nginx::UpstreamMemberServer],
5404+
port => Optional[Stdlib::Port],
5405+
weight => Optional[Integer[1]],
5406+
max_conns => Optional[Integer[1]],
5407+
max_fails => Optional[Integer[0]],
5408+
fail_timeout => Optional[Nginx::Time],
5409+
backup => Optional[Boolean],
5410+
resolve => Optional[Boolean],
5411+
route => Optional[String],
5412+
service => Optional[String],
5413+
slow_start => Optional[Nginx::Time],
5414+
state => Optional[Enum['drain','down']],
5415+
params_prepend => Optional[String],
5416+
params_append => Optional[String],
53745417
}]
53755418
```
53765419

@@ -5396,25 +5439,25 @@ Alias of
53965439
Variant[Hash[
53975440
Enum['cookie'],
53985441
Struct[{
5399-
name => String,
5400-
expires => Optional[Variant[Nginx::Time,Enum['max']]],
5401-
domain => Optional[String],
5402-
httponly => Optional[Boolean],
5403-
secure => Optional[Boolean],
5404-
path => Optional[String],
5442+
name => String,
5443+
expires => Optional[Variant[Nginx::Time,Enum['max']]],
5444+
domain => Optional[String],
5445+
httponly => Optional[Boolean],
5446+
secure => Optional[Boolean],
5447+
path => Optional[String],
54055448
}]
54065449
], Hash[
54075450
Enum['route'],
54085451
String
54095452
], Hash[
54105453
Enum['learn'],
54115454
Struct[{
5412-
create => String,
5413-
lookup => String,
5414-
zone => Nginx::UpstreamStickyZone,
5415-
timeout => Optional[Nginx::Time],
5416-
header => Optional[Boolean],
5417-
sync => Optional[Boolean],
5455+
create => String,
5456+
lookup => String,
5457+
zone => Nginx::UpstreamStickyZone,
5458+
timeout => Optional[Nginx::Time],
5459+
header => Optional[Boolean],
5460+
sync => Optional[Boolean],
54185461
}]
54195462
]]
54205463
```

‎types/logformat.pp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
type Nginx::LogFormat = Variant[
33
String[1],
44
Struct[{
5-
Optional[escape] => Enum['default', 'json', 'none'],
6-
format => String[1],
5+
Optional[escape] => Enum['default', 'json', 'none'],
6+
format => String[1],
77
}],
88
]

‎types/upstreamdefaults.pp‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# @summary Type Alias for Nginx::UpstreamDefaults
22
type Nginx::UpstreamDefaults = Struct[{
3-
context => Optional[Enum['http', 'stream']],
4-
member_defaults => Optional[Nginx::UpstreamMemberDefaults],
5-
hash => Optional[String],
6-
ip_hash => Optional[Boolean],
7-
keepalive => Optional[Integer[1]],
8-
kepalive_requests => Optional[Integer[1]],
9-
keepalive_timeout => Optional[Nginx::Time],
10-
least_conn => Optional[Boolean],
11-
least_time => Optional[Nginx::UpstreamLeastTime],
12-
ntlm => Optional[Boolean],
13-
queue_max => Optional[Integer],
14-
queue_timeout => Optional[Nginx::Time],
15-
random => Optional[String],
16-
statefile => Optional[Stdlib::Unixpath],
17-
sticky => Optional[Nginx::UpstreamSticky],
18-
zone => Optional[Nginx::UpstreamZone],
19-
cfg_append => Optional[Hash],
20-
cfg_prepend => Optional[Hash],
3+
context => Optional[Enum['http', 'stream']],
4+
member_defaults => Optional[Nginx::UpstreamMemberDefaults],
5+
hash => Optional[String],
6+
ip_hash => Optional[Boolean],
7+
keepalive => Optional[Integer[1]],
8+
kepalive_requests => Optional[Integer[1]],
9+
keepalive_timeout => Optional[Nginx::Time],
10+
least_conn => Optional[Boolean],
11+
least_time => Optional[Nginx::UpstreamLeastTime],
12+
ntlm => Optional[Boolean],
13+
queue_max => Optional[Integer],
14+
queue_timeout => Optional[Nginx::Time],
15+
random => Optional[String],
16+
statefile => Optional[Stdlib::Unixpath],
17+
sticky => Optional[Nginx::UpstreamSticky],
18+
zone => Optional[Nginx::UpstreamZone],
19+
cfg_append => Optional[Hash],
20+
cfg_prepend => Optional[Hash],
2121
}]

‎types/upstreammember.pp‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# @summary Type Alias for Nginx::UpstreamMember
22
type Nginx::UpstreamMember = Struct[{
3-
server => Optional[Nginx::UpstreamMemberServer],
4-
port => Optional[Stdlib::Port],
5-
weight => Optional[Integer[1]],
6-
max_conns => Optional[Integer[1]],
7-
max_fails => Optional[Integer[0]],
8-
fail_timeout => Optional[Nginx::Time],
9-
backup => Optional[Boolean],
10-
resolve => Optional[Boolean],
11-
route => Optional[String],
12-
service => Optional[String],
13-
slow_start => Optional[Nginx::Time],
14-
state => Optional[Enum['drain','down']],
15-
params_prepend => Optional[String],
16-
params_append => Optional[String],
17-
comment => Optional[String],
3+
server => Optional[Nginx::UpstreamMemberServer],
4+
port => Optional[Stdlib::Port],
5+
weight => Optional[Integer[1]],
6+
max_conns => Optional[Integer[1]],
7+
max_fails => Optional[Integer[0]],
8+
fail_timeout => Optional[Nginx::Time],
9+
backup => Optional[Boolean],
10+
resolve => Optional[Boolean],
11+
route => Optional[String],
12+
service => Optional[String],
13+
slow_start => Optional[Nginx::Time],
14+
state => Optional[Enum['drain','down']],
15+
params_prepend => Optional[String],
16+
params_append => Optional[String],
17+
comment => Optional[String],
1818
}]

‎types/upstreammemberdefaults.pp‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# @summary Type Alias for Nginx::UpstreamMemberDefaults
22
type Nginx::UpstreamMemberDefaults = Struct[{
3-
server => Optional[Nginx::UpstreamMemberServer],
4-
port => Optional[Stdlib::Port],
5-
weight => Optional[Integer[1]],
6-
max_conns => Optional[Integer[1]],
7-
max_fails => Optional[Integer[0]],
8-
fail_timeout => Optional[Nginx::Time],
9-
backup => Optional[Boolean],
10-
resolve => Optional[Boolean],
11-
route => Optional[String],
12-
service => Optional[String],
13-
slow_start => Optional[Nginx::Time],
14-
state => Optional[Enum['drain','down']],
15-
params_prepend => Optional[String],
16-
params_append => Optional[String],
3+
server => Optional[Nginx::UpstreamMemberServer],
4+
port => Optional[Stdlib::Port],
5+
weight => Optional[Integer[1]],
6+
max_conns => Optional[Integer[1]],
7+
max_fails => Optional[Integer[0]],
8+
fail_timeout => Optional[Nginx::Time],
9+
backup => Optional[Boolean],
10+
resolve => Optional[Boolean],
11+
route => Optional[String],
12+
service => Optional[String],
13+
slow_start => Optional[Nginx::Time],
14+
state => Optional[Enum['drain','down']],
15+
params_prepend => Optional[String],
16+
params_append => Optional[String],
1717
}]

‎types/upstreamsticky.pp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Hash[
44
Enum['cookie'],
55
Struct[{
6-
name => String,
7-
expires => Optional[Variant[Nginx::Time,Enum['max']]],
8-
domain => Optional[String],
9-
httponly => Optional[Boolean],
10-
secure => Optional[Boolean],
11-
path => Optional[String],
6+
name => String,
7+
expires => Optional[Variant[Nginx::Time,Enum['max']]],
8+
domain => Optional[String],
9+
httponly => Optional[Boolean],
10+
secure => Optional[Boolean],
11+
path => Optional[String],
1212
}]
1313
],
1414
Hash[
@@ -18,12 +18,12 @@
1818
Hash[
1919
Enum['learn'],
2020
Struct[{
21-
create => String,
22-
lookup => String,
23-
zone => Nginx::UpstreamStickyZone,
24-
timeout => Optional[Nginx::Time],
25-
header => Optional[Boolean],
26-
sync => Optional[Boolean],
21+
create => String,
22+
lookup => String,
23+
zone => Nginx::UpstreamStickyZone,
24+
timeout => Optional[Nginx::Time],
25+
header => Optional[Boolean],
26+
sync => Optional[Boolean],
2727
}]
2828
]
2929
]

0 commit comments

Comments
 (0)