Skip to content

docs: bump version references to 1.2.0 #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luksow merged 1 commit into from
May 1, 2026
Merged

docs: bump version references to 1.2.0 #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Baklava is a Scala library that turns your HTTP routing tests into API documenta
**1. Add the SBT plugin** to `project/plugins.sbt`:

```scala
addSbtPlugin("pl.iterators" % "baklava-sbt-plugin" % "1.1.1")
addSbtPlugin("pl.iterators" % "baklava-sbt-plugin" % "1.2.0")
```

**2. Enable the plugin** in `build.sbt`:
Expand All @@ -37,18 +37,21 @@ enablePlugins(BaklavaSbtPlugin)
```scala
libraryDependencies ++= Seq(
// HTTP server — choose one
"pl.iterators" %% "baklava-pekko-http" % "1.1.1" % Test,
// "pl.iterators" %% "baklava-http4s" % "1.1.1" % Test,
"pl.iterators" %% "baklava-pekko-http" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-http4s" % "1.2.0" % Test,

// Test framework — choose one
"pl.iterators" %% "baklava-scalatest" % "1.1.1" % Test,
// "pl.iterators" %% "baklava-specs2" % "1.1.1" % Test,
// "pl.iterators" %% "baklava-munit" % "1.1.1" % Test,
"pl.iterators" %% "baklava-scalatest" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-specs2" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-munit" % "1.2.0" % Test,

// Output format — one or more
"pl.iterators" %% "baklava-openapi" % "1.1.1" % Test,
"pl.iterators" %% "baklava-simple" % "1.1.1" % Test,
// "pl.iterators" %% "baklava-tsrest" % "1.1.1" % Test,
"pl.iterators" %% "baklava-openapi" % "1.2.0" % Test,
"pl.iterators" %% "baklava-simple" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-tsrest" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-tsfetch" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-postman" % "1.2.0" % Test,
// "pl.iterators" %% "baklava-sttpclient" % "1.2.0" % Test,
)
```

Expand Down
46 changes: 23 additions & 23 deletions docs/dsl-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ path(

## Root Element: `path`

The [`path()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L21) function is the root element of the DSL tree. It defines an API endpoint path and contains one or more HTTP method definitions.
The [`path()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L21) function is the root element of the DSL tree. It defines an API endpoint path and contains one or more HTTP method definitions.

### Signature

Expand All @@ -129,7 +129,7 @@ def path(
| `path` | `String` | Yes | The URL path pattern, supporting path parameters in `{paramName}` format (e.g., `/users/{userId}`) |
| `description` | `String` | No | Detailed description of the path and its purpose |
| `summary` | `String` | No | Brief summary of the path |
| `steps` | `BaklavaMethodDefinition*` | Yes | One or more [`supports()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L63) definitions for HTTP methods |
| `steps` | `BaklavaMethodDefinition*` | Yes | One or more [`supports()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L63) definitions for HTTP methods |

### Example

Expand All @@ -147,7 +147,7 @@ path(

## HTTP Method Element: `supports`

The [`supports()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L63) function defines an HTTP method operation on a path. It specifies the method, parameters, security, and contains test cases.
The [`supports()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L63) function defines an HTTP method operation on a path. It specifies the method, parameters, security, and contains test cases.

### Signature

Expand Down Expand Up @@ -207,7 +207,7 @@ supports(

## Test Case Element: `onRequest`

The [`onRequest()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L377) function defines a specific test case for an HTTP operation. It specifies the request parameters and must be followed by [`respondsWith()`](#response-definition-respondswith) and [`assert()`](#assertion-block-assert).
The [`onRequest()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L377) function defines a specific test case for an HTTP operation. It specifies the request parameters and must be followed by [`respondsWith()`](#response-definition-respondswith) and [`assert()`](#assertion-block-assert).

### Signature

Expand Down Expand Up @@ -245,7 +245,7 @@ onRequest(

## Response Definition: `respondsWith`

The [`respondsWith()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L152) method defines the expected HTTP response for a test case.
The [`respondsWith()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L152) method defines the expected HTTP response for a test case.

### Signature

Expand Down Expand Up @@ -287,7 +287,7 @@ def respondsWith[ResponseBody](

## Assertion Block: `assert`

The [`assert()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L123) method contains the test framework-specific assertions. It receives a context object that provides access to the request/response.
The [`assert()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaTestFrameworkDsl.scala#L123) method contains the test framework-specific assertions. It receives a context object that provides access to the request/response.

### Signature

Expand All @@ -299,7 +299,7 @@ def assert[R](

### Context Object

The assertion block receives a [`BaklavaCaseContext`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaHttpDsl.scala#L110) with:
The assertion block receives a [`BaklavaCaseContext`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaHttpDsl.scala#L110) with:

- `ctx`: The request context containing all request parameters
- `performRequest(route)`: Method to execute the HTTP request against your routes
Expand Down Expand Up @@ -403,7 +403,7 @@ withSetup {

### Path Parameters

Path parameters are defined using the [`p[T]()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaPathParams.scala#L27) function and represent dynamic segments in the URL path.
Path parameters are defined using the [`p[T]()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaPathParams.scala#L27) function and represent dynamic segments in the URL path.

#### Signature

Expand Down Expand Up @@ -439,7 +439,7 @@ onRequest(pathParameters = ("org-123", 456L))

### Query Parameters

Query parameters are defined using the [`q[T]()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaQueryParams.scala#L24) function and represent URL query string parameters.
Query parameters are defined using the [`q[T]()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaQueryParams.scala#L24) function and represent URL query string parameters.

#### Signature

Expand Down Expand Up @@ -480,7 +480,7 @@ onRequest(queryParameters = (Seq("scala", "api")))

### Headers

Headers are defined using the [`h[T]()`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaHeaders.scala#L26) function and represent HTTP headers.
Headers are defined using the [`h[T]()`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaHeaders.scala#L26) function and represent HTTP headers.

#### Signature

Expand Down Expand Up @@ -530,7 +530,7 @@ onRequest(

### Form Data

Use [`FormOf[T]`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/BaklavaHttpDsl.scala#L17) for `application/x-www-form-urlencoded` data:
Use [`FormOf[T]`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/BaklavaHttpDsl.scala#L17) for `application/x-www-form-urlencoded` data:

```scala
case class LoginForm(username: String, password: String)
Expand Down Expand Up @@ -618,18 +618,18 @@ onRequest(

### Available Security Types

All security types are defined in [`Security.scala`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L1):
All security types are defined in [`Security.scala`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L1):

- [`HttpBearer`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L20): Bearer token authentication
- [`HttpBasic`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L27): Basic authentication
- [`ApiKeyInHeader`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L36): API key in header
- [`ApiKeyInQuery`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L42): API key in query parameter
- [`ApiKeyInCookie`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L48): API key in cookie
- [`MutualTls`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L54): Mutual TLS authentication
- [`OpenIdConnectInBearer`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L60): OpenID Connect in bearer token
- [`OpenIdConnectInCookie`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L66): OpenID Connect in cookie
- [`OAuth2InBearer`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L72): OAuth2 in bearer token
- [`OAuth2InCookie`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L78): OAuth2 in cookie
- [`HttpBearer`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L20): Bearer token authentication
- [`HttpBasic`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L27): Basic authentication
- [`ApiKeyInHeader`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L36): API key in header
- [`ApiKeyInQuery`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L42): API key in query parameter
- [`ApiKeyInCookie`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L48): API key in cookie
- [`MutualTls`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L54): Mutual TLS authentication
- [`OpenIdConnectInBearer`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L60): OpenID Connect in bearer token
- [`OpenIdConnectInCookie`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L66): OpenID Connect in cookie
- [`OAuth2InBearer`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L72): OAuth2 in bearer token
- [`OAuth2InCookie`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Security.scala#L78): OAuth2 in cookie

#### OAuth2 Flows

Expand Down Expand Up @@ -687,7 +687,7 @@ Common status codes available:

## Schema System

Baklava uses a [`Schema[T]`](https://github.com/theiterators/baklava/blob/v1.1.0/core/src/main/scala/pl/iterators/baklava/Schema.scala#L20) type class to describe data types for documentation generation. Schemas are automatically derived via [Magnolia](https://github.com/softwaremill/magnolia) for:
Baklava uses a [`Schema[T]`](https://github.com/theiterators/baklava/blob/v1.2.0/core/src/main/scala/pl/iterators/baklava/Schema.scala#L20) type class to describe data types for documentation generation. Schemas are automatically derived via [Magnolia](https://github.com/softwaremill/magnolia) for:

- Primitive types (`String`, `Int`, `Long`, `Double`, `Boolean`, `UUID`, `BigDecimal`, etc.)
- Collections (`Seq`, `List`, `Set`, `Map`)
Expand Down
Loading