Skip to content

chore: repin examples to the published 3.5.0 artifacts #193

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
bluejeans117 merged 1 commit into from
Sep 22, 2026
Merged

chore: repin examples to the published 3.5.0 artifacts #193

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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Notable FlexDoc product releases are recorded here. Detailed release notes remain under `docs/releases/` and are linked from each entry.

## Unreleased

## 3.5.0 — Node disagreement loop

`@prauga/flexdoc-client` and `@prauga/flexdoc-backend` **3.5.0**, with `@prauga/flexdoc-cli` **0.8.0**. Native adapter versions are unchanged.
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ node tools/flexdoc-cli/bin/flexdoc.js run ./pets.flexdoc.json --json

| Ecosystem | Package | Source version |
| --- | --- | ---: |
| npm | `@prauga/flexdoc-client` | `3.4.0` |
| npm | `@prauga/flexdoc-backend` | `3.4.0` |
| npm | `@prauga/flexdoc-client` | `3.5.0` |
| npm | `@prauga/flexdoc-backend` | `3.5.0` |
| npm | `@prauga/flexdoc-core` | `0.5.2` |
| npm | `@prauga/flexdoc-cli` | `0.7.0` |
| npm | `@prauga/flexdoc-cli` | `0.8.0` |
| NuGet | `Prauga.FlexDoc.AspNetCore` | `0.7.0` |
| Maven | `com.prauga.flexdoc:flexdoc-jvm` | `0.10.0` |
| Maven | `com.prauga.flexdoc:flexdoc-jaxrs` | `0.10.0` |
Expand Down
6 changes: 3 additions & 3 deletions docs/distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ FlexDoc uses one canonical browser renderer and thin ecosystem adapters. Every a

| Artifact | Version represented by source | Release tag | Compatibility |
| --- | --- | --- | --- |
| `@prauga/flexdoc-client` | `3.4.0` | `js/v3.4.0` | canonical renderer; renderer contract v1 |
| `@prauga/flexdoc-backend` | `3.4.0` | `js/v3.4.0` | matching renderer; contract v1 |
| `@prauga/flexdoc-client` | `3.5.0` | `js/v3.5.0` | canonical renderer; renderer contract v1 |
| `@prauga/flexdoc-backend` | `3.5.0` | `js/v3.5.0` | matching renderer; contract v1 |
| `@prauga/flexdoc-core` | `0.5.2` | `core/v0.5.2` | framework-neutral OpenAPI engine + host-execution target-policy contract |
| `@prauga/flexdoc-cli` | `0.7.0` | `cli/v0.7.0` | Contract Validation + headless Runner consumer; compatible Prauga renderer |
| `@prauga/flexdoc-cli` | `0.8.0` | `cli/v0.8.0` | Contract Validation + headless Runner consumer; compatible Prauga renderer |
| `Prauga.FlexDoc.AspNetCore` | `0.7.0` | `dotnet/v0.7.0` | ASP.NET Core 8+; renderer contract v1; HX-03 protection acknowledgement |
| `com.prauga.flexdoc:flexdoc-jvm` | `0.10.0` | `java/v0.10.0` | Java 17+ framework-neutral renderer host; HX-03 protection acknowledgement |
| `com.prauga.flexdoc:flexdoc-jaxrs` | `0.10.0` | `java/v0.10.0` | Jakarta REST/JAX-RS transport over `flexdoc-jvm` |
Expand Down
4 changes: 2 additions & 2 deletions docs/releases/3.5.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When runtime discovery is complete, an implemented route that OpenAPI does not d
- `@prauga/flexdoc-backend` — **3.5.0**
- `@prauga/flexdoc-cli` — **0.8.0**

`@prauga/flexdoc-core` and the native adapter lines are unchanged. This wave does not change their behavior. Examples and the install tables stay on the artifacts a user can install today, and move to these versions in the post-publish repin.
`@prauga/flexdoc-core` and the native adapter lines are unchanged. This wave does not change their behavior. Examples and the install tables are pinned to these versions.

## What the loop does

Expand All @@ -34,4 +34,4 @@ The `@prauga/flexdoc-backend` **3.5.0** host-execution contract is unchanged fro

## Release sequencing

This wave uses the version contract's in-flight window. Source versions for the client, backend, and CLI sit ahead of the registry. After those three artifacts exist, the follow-up repin updates examples, generated lock metadata, and the published baselines, then clears `pending`.
This wave used the version contract's in-flight window. Examples and install documentation stayed pinned to the previously published artifacts while source versions sat in `pending`. After the registry artifacts existed, the follow-up repin updated examples, generated lock metadata, and the published baselines, then cleared `pending`. That window is closed for 3.5.0.
16 changes: 8 additions & 8 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ The examples deliberately separate two kinds of capability:

| Example | FlexDoc package / integration | Current focus | Runtime Intelligence |
| --- | --- | --- | --- |
| [`basic-usage`](./basic-usage) | React + `@prauga/flexdoc-client` `3.4.0` | Minimal renderer integration | — client only |
| [`interactive-demo`](./interactive-demo) | React + `@prauga/flexdoc-client` `3.4.0` | **Complete framework-neutral renderer**: deep links, preferences, command palette, Try It → API Client, downloads, code samples, responsive/a11y chrome | — client only |
| [`api-client`](./api-client) | Full API Client + `@prauga/flexdoc-client` `3.4.0` | **Complete standalone API Client**: environments, variables, CodeMirror scripts, runner/history, response inspection, persistence, shortcuts | — client only |
| [`nestjs`](./nestjs) | NestJS + `@prauga/flexdoc-backend` `3.4.0` | Code-first OpenAPI + full renderer/API Client | **Yes — underlying Express/Fastify adapter** |
| [`javascript-express`](./javascript-express) | Express + `@prauga/flexdoc-backend` `3.4.0` | Primary backend-native showcase with intentional route drift | **Yes — live Express router** |
| [`javascript-fastify`](./javascript-fastify) | Fastify + `@prauga/flexdoc-backend` `3.4.0` | Shared OpenAPI showcase + intentional runtime-only route | **Yes — live Fastify route tree** |
| [`javascript-hono`](./javascript-hono) | Hono + `@prauga/flexdoc-backend` `3.4.0` | Small inline contract + intentional runtime-only route | **Yes — live Hono route inventory** |
| [`javascript-fleet`](./javascript-fleet) | Express fleet + `@prauga/flexdoc-backend` `3.4.0` | Multi-instance host execution: shared secret, Redis jar store, fleet admission, observation merge | **Yes — live Express router** |
| [`basic-usage`](./basic-usage) | React + `@prauga/flexdoc-client` `3.5.0` | Minimal renderer integration | — client only |
| [`interactive-demo`](./interactive-demo) | React + `@prauga/flexdoc-client` `3.5.0` | **Complete framework-neutral renderer**: deep links, preferences, command palette, Try It → API Client, downloads, code samples, responsive/a11y chrome | — client only |
| [`api-client`](./api-client) | Full API Client + `@prauga/flexdoc-client` `3.5.0` | **Complete standalone API Client**: environments, variables, CodeMirror scripts, runner/history, response inspection, persistence, shortcuts | — client only |
| [`nestjs`](./nestjs) | NestJS + `@prauga/flexdoc-backend` `3.5.0` | Code-first OpenAPI + full renderer/API Client | **Yes — underlying Express/Fastify adapter** |
| [`javascript-express`](./javascript-express) | Express + `@prauga/flexdoc-backend` `3.5.0` | Primary backend-native showcase with intentional route drift | **Yes — live Express router** |
| [`javascript-fastify`](./javascript-fastify) | Fastify + `@prauga/flexdoc-backend` `3.5.0` | Shared OpenAPI showcase + intentional runtime-only route | **Yes — live Fastify route tree** |
| [`javascript-hono`](./javascript-hono) | Hono + `@prauga/flexdoc-backend` `3.5.0` | Small inline contract + intentional runtime-only route | **Yes — live Hono route inventory** |
| [`javascript-fleet`](./javascript-fleet) | Express fleet + `@prauga/flexdoc-backend` `3.5.0` | Multi-instance host execution: shared secret, Redis jar store, fleet admission, observation merge | **Yes — live Express router** |
| [`dotnet-aspnetcore`](./dotnet-aspnetcore) | `Prauga.FlexDoc.AspNetCore` `0.7.0` | Exact server-side contract + runtime-only minimal API route | **Yes — `EndpointDataSource`** |
| [`java-spring`](./java-spring) | Spring Boot + `flexdoc-spring-boot-starter` `0.10.0` | Exact `FlexDocSpecProvider` contract + runtime-only MVC route | **Yes — `RequestMappingHandlerMapping`** |
| [`java-quarkus`](./java-quarkus) | Quarkus/Jakarta REST + `flexdoc-jaxrs` `0.10.0` | Canonical JVM renderer hosting | No in current slice |
Expand Down
2 changes: 1 addition & 1 deletion examples/api-client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"private": true,
"dependencies": {
"@prauga/flexdoc-client": "3.4.0",
"@prauga/flexdoc-client": "3.5.0",
"react": "^19.2.8",
"react-dom": "^19.2.8"
},
Expand Down
2 changes: 1 addition & 1 deletion examples/basic-usage/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"private": true,
"dependencies": {
"@prauga/flexdoc-client": "3.4.0",
"@prauga/flexdoc-client": "3.5.0",
"lucide-react": "^1.37.0",
"react": "^19.2.8",
"react-dom": "^19.2.8"
Expand Down
2 changes: 1 addition & 1 deletion examples/interactive-demo/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"private": true,
"dependencies": {
"@prauga/flexdoc-client": "3.4.0",
"@prauga/flexdoc-client": "3.5.0",
"lucide-react": "^1.37.0",
"react": "^19.2.8",
"react-dom": "^19.2.8"
Expand Down
10 changes: 5 additions & 5 deletions examples/javascript-express/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/javascript-express/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"start": "node index.js"
},
"dependencies": {
"@prauga/flexdoc-backend": "3.4.0",
"@prauga/flexdoc-backend": "3.5.0",
"express": "^5.1.0"
}
}
10 changes: 5 additions & 5 deletions examples/javascript-fastify/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/javascript-fastify/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"start": "node index.js"
},
"dependencies": {
"@prauga/flexdoc-backend": "3.4.0",
"@prauga/flexdoc-backend": "3.5.0",
"fastify": "^5.5.0"
}
}
2 changes: 1 addition & 1 deletion examples/javascript-fleet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Runnable proof that FlexDoc host-execution session jars, admission budgeting and

Three Express replicas share one `FLEXDOC_SESSION_SECRET` and a Redis cookie-jar store, sit behind nginx round-robin on `:8080`, and export per-instance observation documents that `mergeHostExecutionObservationDocuments` combines.

Pinned to `@prauga/flexdoc-backend` `3.4.0`.
Pinned to `@prauga/flexdoc-backend` `3.5.0`.

## What this demonstrates

Expand Down
10 changes: 5 additions & 5 deletions examples/javascript-fleet/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/javascript-fleet/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"merge-observations": "node merge-observations.js"
},
"dependencies": {
"@prauga/flexdoc-backend": "3.4.0",
"@prauga/flexdoc-backend": "3.5.0",
"express": "^5.1.0",
"redis": "^4.7.0"
}
Expand Down
10 changes: 5 additions & 5 deletions examples/javascript-hono/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/javascript-hono/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"type": "module",
"dependencies": {
"@prauga/flexdoc-backend": "3.4.0",
"@prauga/flexdoc-backend": "3.5.0",
"hono": "^4.13.5"
}
}
2 changes: 1 addition & 1 deletion examples/nestjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"directory": "examples/nestjs"
},
"dependencies": {
"@prauga/flexdoc-backend": "3.4.0",
"@prauga/flexdoc-backend": "3.5.0",
"@nestjs/common": "^12.0.1",
"@nestjs/core": "^12.0.1",
"@nestjs/platform-express": "^12.0.1",
Expand Down
Loading
Loading