Updated documentation

jaredhendrickson13 · jaredhendrickson13 · commit 5c3e70946d94 · 2020-12-26T16:11:31.000-07:00
diff --git a/README.md b/README.md
@@ -886,14 +886,6 @@ URL: https://{{$hostname}}/api/v1/firewall/alias
 
 
 
-***Query params:***
-
-| Key | Value | Description |
-| --- | ------|-------------|
-| id | string | Name of alias to delete. This alias must NOT be in use elsewhere in configuration |
-
-
-
 ***Body:***
 
 ```js        
@@ -1741,8 +1733,8 @@ URL: https://{{$hostname}}/api/v1/firewall/rule
 | icmptype | string or array | Set the ICMP subtype of the firewall rule. Multiple values may be passed in as array, single values may be passed as string. _Only available when `protocol` is set to `icmp`. If `icmptype` is not specified all subtypes are assumed_ |
 | src | string | Set the source address of the firewall rule. This may be a single IP, network CIDR, alias name, or interface. When specifying an interface, you may use the physical interface ID, the descriptive interfance name, or the pfSense ID. To use only interface address, add `ip` to the end of the interface name otherwise the entire interface's subnet is implied. To negate the context of the source address, you may prepend the address with `!` |
 | dst | string | Set the destination address of the firewall rule. This may be a single IP, network CIDR, alias name, or interface. When specifying an interface, you may use the physical interface ID, the descriptive interface name, or the pfSense ID. To only use interface address, add `ip` to the end of the interface name otherwise the entire interface's subnet is implied. To negate the context of the source address, you may prepend the address with `!` |
-| srcport | string or integer | Set the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
-| dstport | string or integer | Set the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
+| srcport | string or integer | Set the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
+| dstport | string or integer | Set the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
 | gateway | string | Set the routing gateway traffic will take upon match (optional) |
 | disabled | boolean | Disable the rule upon creation (optional) |
 | descr | string | Set a description for the rule (optional) |
@@ -1868,9 +1860,9 @@ URL: https://{{$hostname}}/api/v1/firewall/rule
 | icmptype | string or array | Update the ICMP subtype of the firewall rule. Multiple values may be passed in as array, single values may be passed as string. _Only available when `protocol` is set to `icmp`. If `icmptype` is not specified all subtypes are assumed_ (optional) |
 | src | string | Update the source address of the firewall rule. This may be a single IP, network CIDR, alias name, or interface. When specifying an interface, you may use the physical interface ID, the descriptive interfance name, or the pfSense ID. To use only interface address, add `ip` to the end of the interface name otherwise the entire interface's subnet is implied. To negate the context of the source address, you may prepend the address with `!` (optional) |
 | dst | string | Update the destination address of the firewall rule. This may be a single IP, network CIDR, alias name, or interface. When specifying an interface, you may use the physical interface ID, the descriptive interface name, or the pfSense ID. To only use interface address, add `ip` to the end of the interface name otherwise the entire interface's subnet is implied. To negate the context of the source address, you may prepend the address with `!` (optional) |
-| srcport | string or integer | Update the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional) |
-| dstport | string or integer | Update the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
-| gateway | string | UPdate the routing gateway traffic will take upon match (optional) |
+| srcport | string or integer | Update the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional) |
+| dstport | string or integer | Update the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` |
+| gateway | string | Update the routing gateway traffic will take upon match (optional) |
 | disabled | boolean | Disable the rule upon modification (optional) |
 | descr | string | Update the description of the rule (optional) |
 | log | boolean | Enable rule matched logging (optional) |
diff --git a/docs/documentation.json b/docs/documentation.json
@@ -1980,7 +1980,7 @@
 										{
 											"key": "type",
 											"value": "string",
-											"description": "Change type of alias (optional)",
+											"description": "Change type of alias. Alias type can only be changed when the targetted alias is not in use (optional)",
 											"disabled": true
 										},
 										{
@@ -2022,7 +2022,7 @@
 									}
 								},
 								"url": {
-									"raw": "https://{{$hostname}}/api/v1/firewall/alias?id=string",
+									"raw": "https://{{$hostname}}/api/v1/firewall/alias",
 									"protocol": "https",
 									"host": [
 										"{{$hostname}}"
@@ -2037,7 +2037,8 @@
 										{
 											"key": "id",
 											"value": "string",
-											"description": "Name of alias to delete. This alias must NOT be in use elsewhere in configuration"
+											"description": "Name or ID of alias to delete. This alias cannot be in use elsewhere in configuration",
+											"disabled": true
 										}
 									]
 								},
@@ -2174,12 +2175,12 @@
 										{
 											"key": "srcport",
 											"value": "string or integer",
-											"description": "Set the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
+											"description": "Set the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
 										},
 										{
 											"key": "dstport",
 											"value": "string or integer",
-											"description": "Set the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
+											"description": "Set the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
 										},
 										{
 											"key": "gateway",
@@ -2287,17 +2288,17 @@
 										{
 											"key": "srcport",
 											"value": "string or integer",
-											"description": "Update the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional)"
+											"description": "Update the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional)"
 										},
 										{
 											"key": "dstport",
 											"value": "string or integer",
-											"description": "Update the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
+											"description": "Update the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
 										},
 										{
 											"key": "gateway",
 											"value": "string",
-											"description": "UPdate the routing gateway traffic will take upon match (optional)"
+											"description": "Update the routing gateway traffic will take upon match (optional)"
 										},
 										{
 											"key": "disabled",
diff --git a/pfSense-pkg-API/files/usr/local/www/api/documentation/index.php b/pfSense-pkg-API/files/usr/local/www/api/documentation/index.php

Original file line number	Diff line number	Diff line change
`@@ -1980,7 +1980,7 @@`
`1980`	`1980`	`{`
`1981`	`1981`	`"key": "type",`
`1982`	`1982`	`"value": "string",`
`1983`		`- "description": "Change type of alias (optional)",`
	`1983`	`+ "description": "Change type of alias. Alias type can only be changed when the targetted alias is not in use (optional)",`
`1984`	`1984`	`"disabled": true`
`1985`	`1985`	`},`
`1986`	`1986`	`{`
`@@ -2022,7 +2022,7 @@`
`2022`	`2022`	`}`
`2023`	`2023`	`},`
`2024`	`2024`	`"url": {`
`2025`		`- "raw": "https://{{$hostname}}/api/v1/firewall/alias?id=string",`
	`2025`	`+ "raw": "https://{{$hostname}}/api/v1/firewall/alias",`
`2026`	`2026`	`"protocol": "https",`
`2027`	`2027`	`"host": [`
`2028`	`2028`	`"{{$hostname}}"`
`@@ -2037,7 +2037,8 @@`
`2037`	`2037`	`{`
`2038`	`2038`	`"key": "id",`
`2039`	`2039`	`"value": "string",`
`2040`		`- "description": "Name of alias to delete. This alias must NOT be in use elsewhere in configuration"`
	`2040`	`+ "description": "Name or ID of alias to delete. This alias cannot be in use elsewhere in configuration",`
	`2041`	`+ "disabled": true`
`2041`	`2042`	`}`
`2042`	`2043`	`]`
`2043`	`2044`	`},`
`@@ -2174,12 +2175,12 @@`
`2174`	`2175`	`{`
`2175`	`2176`	`"key": "srcport",`
`2176`	`2177`	`"value": "string or integer",`
`2177`		- "description": "Set the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
	`2178`	+ "description": "Set the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
`2178`	`2179`	`},`
`2179`	`2180`	`{`
`2180`	`2181`	`"key": "dstport",`
`2181`	`2182`	`"value": "string or integer",`
`2182`		- "description": "Set the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
	`2183`	+ "description": "Set the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
`2183`	`2184`	`},`
`2184`	`2185`	`{`
`2185`	`2186`	`"key": "gateway",`
`@@ -2287,17 +2288,17 @@`
`2287`	`2288`	`{`
`2288`	`2289`	`"key": "srcport",`
`2289`	`2290`	`"value": "string or integer",`
`2290`		- "description": "Update the TCP and/or UDP source port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional)"
	`2291`	+ "description": "Update the TCP and/or UDP source port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp` (optional)"
`2291`	`2292`	`},`
`2292`	`2293`	`{`
`2293`	`2294`	`"key": "dstport",`
`2294`	`2295`	`"value": "string or integer",`
`2295`		- "description": "Update the TCP and/or UDP destination port of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
	`2296`	+ "description": "Update the TCP and/or UDP destination port or port alias of the firewall rule. This is only necessary if you have specified the `protocol` to `tcp`, `udp`, `tcp/udp`"
`2296`	`2297`	`},`
`2297`	`2298`	`{`
`2298`	`2299`	`"key": "gateway",`
`2299`	`2300`	`"value": "string",`
`2300`		`- "description": "UPdate the routing gateway traffic will take upon match (optional)"`
	`2301`	`+ "description": "Update the routing gateway traffic will take upon match (optional)"`
`2301`	`2302`	`},`
`2302`	`2303`	`{`
`2303`	`2304`	`"key": "disabled",`