Skip to content

docs(car-sharing): refresh stale 1.1.0 forward-references (now released) #37

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
intech merged 1 commit into from
Jun 24, 2026
Merged

docs(car-sharing): refresh stale 1.1.0 forward-references (now released) #37

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
9 changes: 5 additions & 4 deletions car-sharing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,10 +443,11 @@ The committed `openapi/*.yaml` is the showcase output — regenerate with
`pnpm openapi` after changing the proto or its auth options.

> **Notes.** Streaming RPCs (`ListVehicles`) are omitted from the base spec
> unless the plugin's `with-streaming` opt is set. The overlay works on the
> published `@connectum/auth` 1.0.0; once 1.1.0 is out, methods marked
> `internal` in the proto also get `x-internal: true` (the resolver then
> exposes that marker).
> unless the plugin's `with-streaming` opt is set. The overlay targets the
> `@connectum/auth` 1.0.0 API this example pins. `@connectum/auth` 1.1.0 adds an
> `internal` method marker that the resolver exposes as `x-internal: true`;
> migrating this example onto that marker is tracked in
> [examples#36](https://github.com/Connectum-Framework/examples/issues/36).

## Build the image

Expand Down
8 changes: 5 additions & 3 deletions car-sharing/scripts/openapi-authz.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
// Run via `pnpm openapi` (generates the base from buf.gen.openapi.yaml, then this
// overlay). NOTE: streaming RPCs (e.g. ListVehicles) are omitted from the base
// unless the plugin's `with-streaming` opt is set, so they get no operation here.
// A method marked `internal` (1.1.0) would also add `x-internal: true` once the
// resolver exposes that field.
// `@connectum/auth` 1.1.0 adds an `internal` method marker; this example targets
// the 1.0.0 API (no `internal` field on the resolver), so only `public` is mapped.
// On 1.1.0 a method marked `internal` would also add `x-internal: true`.

import { readFileSync, rmSync, writeFileSync } from "node:fs";
import { fileURLToPath } from "node:url";
Expand Down Expand Up @@ -60,7 +61,8 @@ for (const { svc, file } of SPECS) {
op.security = [{ bearerAuth: [] }];
if (auth.requires && auth.requires.roles.length > 0) op["x-connectum-required-roles"] = [...auth.requires.roles];
if (auth.requires && auth.requires.scopes.length > 0) op["x-connectum-required-scopes"] = [...auth.requires.scopes];
// A method marked `internal` (1.1.0) would add `op["x-internal"] = true` here.
// On `@connectum/auth` 1.1.0, a method marked `internal` would add
// `op["x-internal"] = true` here (this example targets 1.0.0, so it does not).
securedCount += 1;
}

Expand Down