Skip to content

Commit

Permalink
Merge branch 'develop' into service
Browse files Browse the repository at this point in the history
  • Loading branch information
mdaneri authored Nov 6, 2024
2 parents 6cc2da7 + 5a0bee1 commit 756853e
Show file tree
Hide file tree
Showing 12 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci-pwsh7_2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:

env:
INVOKE_BUILD_VERSION: '5.11.1'
POWERSHELL_VERSION: '7.2.19'
POWERSHELL_VERSION: '7.2.24'

jobs:
build:
Expand Down
2 changes: 1 addition & 1 deletion docs/Getting-Started/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ docker pull docker.pkg.github.com/badgerati/pode/pode:2.2.2

```powershell
# for latest
docker pull docker.pkg.github.com/badgerati/pode/pode:latest-apline
docker pull docker.pkg.github.com/badgerati/pode/pode:latest-alpine
# or the following for a specific version:
docker pull docker.pkg.github.com/badgerati/pode/pode:2.2.2-alpine
Expand Down
2 changes: 1 addition & 1 deletion docs/Hosting/IIS.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ The server will get a URL path of `/api/etc`, but you can keep your route paths

Although Pode does have support for HTTPS/WSS, when running via IIS it takes control of HTTPS/WSS for us - this is why the endpoints are forced to HTTP/WS.

You can setup a binding in IIS for HTTPS (still HTPPS for WSS) with a Certificate, and IIS will deal with SSL for you:
You can setup a binding in IIS for HTTPS (still HTTPS for WSS) with a Certificate, and IIS will deal with SSL for you:

1. Open IIS, and expand the Sites folder
2. Right click your Site, and select "Edit Bindings..."
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Authentication/Methods/Basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Start-PodeServer {
}
```

The credentials supplied to [`Add-PodeAuth`](../../../../Functions/Authentication/Add-PodeAuth)'s scriptblock are, by default, the username and password. This can be changed to a pscredential object instead by suppling `-AsCredential` on [`New-PodeAuthScheme`](../../../../Functions/Authentication/New-PodeAuthScheme):
The credentials supplied to [`Add-PodeAuth`](../../../../Functions/Authentication/Add-PodeAuth)'s scriptblock are, by default, the username and password. This can be changed to a pscredential object instead by supplying `-AsCredential` on [`New-PodeAuthScheme`](../../../../Functions/Authentication/New-PodeAuthScheme):

```powershell
Start-PodeServer {
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Authentication/Methods/Form.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Start-PodeServer {
}
```

The credentials supplied to [`Add-PodeAuth`](../../../../Functions/Authentication/Add-PodeAuth)'s scriptblock are, by default, the username and password. This can be changed to a pscredential object instead by suppling `-AsCredential` on [`New-PodeAuthScheme`](../../../../Functions/Authentication/New-PodeAuthScheme):
The credentials supplied to [`Add-PodeAuth`](../../../../Functions/Authentication/Add-PodeAuth)'s scriptblock are, by default, the username and password. This can be changed to a pscredential object instead by supplying `-AsCredential` on [`New-PodeAuthScheme`](../../../../Functions/Authentication/New-PodeAuthScheme):

```powershell
Start-PodeServer {
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Logging/Types/Requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The raw Request hashtable that will be supplied to any Custom logging methods wi
}
Response = @{
StatusCode = '200'
StautsDescription = 'OK'
StatusDescription = 'OK'
Size = '9001'
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Middleware/Types/CSRF.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Pode has inbuilt support for CSRF validation using tokens on web requests. The s

## Usage

In Pode you can either validate CSRF using global middleware, or you can assign local Route middleware for specifc routes instead. The tokens needed for validation can be generated in a route and returned in the response as a hidden input element, or other payload options.
In Pode you can either validate CSRF using global middleware, or you can assign local Route middleware for specific routes instead. The tokens needed for validation can be generated in a route and returned in the response as a hidden input element, or other payload options.

By default Pode's CSRF middleware will validate on every route, except for GET, HEAD, OPTIONS, and TRACE routes. The random secret used to generate tokens can be stored using either sessions or cookies.

Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Middleware/Types/RateLimiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Add-PodeLimitRule -Type Route -Values '/downloads' -Limit 5 -Seconds 1

### Endpoints

To assign rate limiting to a specific endpoint, you can pass an enpoint's name to [`Add-PodeLimitRule`](../../../../Functions/Middleware/Add-PodeLimitRule). The following with limit the `User` endpoint to 5 requests every second:
To assign rate limiting to a specific endpoint, you can pass an endpoint's name to [`Add-PodeLimitRule`](../../../../Functions/Middleware/Add-PodeLimitRule). The following with limit the `User` endpoint to 5 requests every second:

```powershell
Add-PodeEndpoint -Address 127.0.0.2 -Port 8090 -Protocol Http -Name 'Admin'
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Middleware/Types/Sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ For example, the following is a mock up of a Storage for Redis. Note that the fu
# create the object
$store = [psobject]::new()
# add a Get property for retreiving a session's data by SessionId
# add a Get property for retrieving a session's data by SessionId
$store | Add-Member -MemberType NoteProperty -Name Get -Value {
param($sessionId)
$data = Get-RedisKey -Key $sessionId
Expand Down
4 changes: 2 additions & 2 deletions docs/Tutorials/Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Add-PodeTask -Name 'Example' -ArgumentList @{ Name = 'Rick'; Environment = 'Mult
}
```

Tasks parameters **must** be bound in the param block in order to be used, but the values for the paramters can be set through the `-ArgumentList` hashtable parameter in either the Add-PodeTask definition or when invoking the task. The following snippet would populate the parameters to the task with the same values as the above example but the `-ArgumentList` parameter is populated during invocation. Note that Keys in the `-ArgumentList` hashtable parameter set during invocation override the same Keys set during task creation:
Tasks parameters **must** be bound in the param block in order to be used, but the values for the parameters can be set through the `-ArgumentList` hashtable parameter in either the Add-PodeTask definition or when invoking the task. The following snippet would populate the parameters to the task with the same values as the above example but the `-ArgumentList` parameter is populated during invocation. Note that Keys in the `-ArgumentList` hashtable parameter set during invocation override the same Keys set during task creation:

```powershell
Add-PodeTask -Name 'Example' -ScriptBlock {
Expand All @@ -72,7 +72,7 @@ You can invoke a task to run from anywhere, be it a route, schedule, middleware,

### Asynchronously

When you use [`Invoke-PodeTask`](../../Functions/Tasks/Invoke-PodeTask) with just the name of the task, this will trigger a task to run asynchrounsly by default:
When you use [`Invoke-PodeTask`](../../Functions/Tasks/Invoke-PodeTask) with just the name of the task, this will trigger a task to run asynchronously by default:

```powershell
$task = Invoke-PodeTask -Name 'Example'
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/WebSockets/Endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ $('#form').submit(function(e) {
})
```

If you just want the server to on respond directlt back to the sending client, and not broadcast to all clients, then set `direct` to true:
If you just want the server to on respond directly back to the sending client, and not broadcast to all clients, then set `direct` to true:

```javascript
$('#form').submit(function(e) {
Expand Down
8 changes: 4 additions & 4 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Date: 22nd June 2022
* #982: Add * level for errors to enable everything
### Bugs
* #956: Fix for importing functionss with inline parameters
* #956: Fix for importing functions with inline parameters
* #957: Fix for some OpenAPI properties being dropped
* #958: Some SMTP attachment boundaries can include double quotes
* #965: Fix for importing ps1 files
Expand Down Expand Up @@ -581,7 +581,7 @@ Date: 19th February 2021
```plain
### Enhancements
* #693: Add OperationId OpenAPI support on routes (thanks @glatzert)
* #698: Add support for Certificate Store Name and Location on `Add-PodeEndoint`
* #698: Add support for Certificate Store Name and Location on `Add-PodeEndpoint`
### Bugs
* #686: Add EndpointName support on `Set-PodeResponseAttachment`
Expand All @@ -603,7 +603,7 @@ Date: 3rd February 2021
* #667: Set the WinIdentity from IIS auth, and add documentation for Kerberos Constrained Delegation (thanks @RobinBeismann!)
### Bugs
* #648: Fixes for using global authentcation in OpenAPI and Swagger
* #648: Fixes for using global authentication in OpenAPI and Swagger
* #650: Fix for redirecting HTTP to HTTPS on default 80/443 ports
* #652: Fix for sessions not extending from AJAX requests, or when session data wasn't updated
* #654: Fix for `-Title` and `-Version` in `Get-PodeOpenApiDefinition` being mandatory
Expand Down Expand Up @@ -1015,7 +1015,7 @@ Date: 28th June 2019
* #271: Fix in `Convert-PodePathPatternsToRegex` when converting file names - thanks @Fraham!
### Documentation
* #284: Notes in documention about referencing JSON payload data in PowerShell 4/5
* #284: Notes in documentation about referencing JSON payload data in PowerShell 4/5
```

## v0.31.0
Expand Down

0 comments on commit 756853e

Please sign in to comment.