Skip to content

Identity, tenancy, proxy generation and OpenAPI guides - #38

Merged
woksin merged 9 commits into
mainfrom
docs/batch-b
Sep 25, 2026
Merged

woksin merged 9 commits into
mainfrom
docs/batch-b

Conversation

@woksin

@woksin woksin commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

Changed

  • New identity guides: how the identity provider flow works, using identity in a React frontend with the @cratis/arc.react hooks, deployment topologies, and a local-development principal.
  • Tenancy guides cover best practices, security considerations and how tenants map to MongoDB databases, SQL databases and Chronicle namespaces, with a checklist for verifying the boundary.
  • Proxy generation has its own getting started, a frontend usage guide and a description of the generated code; OpenAPI documents how concepts, enums, optional fields, derived types and results are rendered.
  • The authorization, configuration, introspection and OpenAPI pages are rewritten as guided tours, including CORS guidance and a table mapping the earlier flat option names to the grouped ArcOptions paths.

Fixed

  • Introspection documentation now shows enum fields as they are rendered (anyOf with one const per value) and that operation summaries come from JSDoc when generated artifact metadata is used.

…de pages

Move the CLI walkthrough from the overview into a setup guide built on the
Library sample, add a React usage tour with commands, live and paged
queries, and arguments, and a reference for generated classes and hook
signatures. The overview keeps compatibility and limits for users and
drops the test-evidence sentence, which the capability reference tracks.

Drafted with AI assistance.
…cal users

Turn the identity index into a tour, and add pages for how /.cratis/me is
served and cached, React integration and refresh with @cratis/arc.react,
identity across services, and simulating signed-in users locally with the
Microsoft identity header handler. Note that tenancy rules also apply to
the development discovery routes.

Drafted with AI assistance.
… docs

Add sections on reading claims per authentication source, deciding from
your own data with provide() and denied(), the status and result of each
authorization failure, and testing authorization with CommandScenario.
Drop the test-evidence sentence, which the capability reference already
tracks.

Drafted with AI assistance.
Rewrite the tenancy overview as a tour of selection, membership, and
storage isolation with best practices and security considerations. Add a
storage isolation page that maps the resolved tenant to MongoDB
databases, Drizzle connections, and Chronicle namespaces, including the
Default namespace fallback and reactor commands, and a checklist for
verifying the boundary.

Drafted with AI assistance.
… and v0.22

Open the configuration page with the problem it solves, show which entry
points read appsettings.json and environment variables, list the builder
methods integrations add, explain that CORS belongs in front of Arc, and
map the pre-v0.22 flat option names to the grouped ArcOptions paths. Add
the Development, Tenancy:Required, and Tenancy:MembershipClaim keys the
binder already accepts.

Drafted with AI assistance.
Open with the consumers the document serves, show a real Tasks sample
excerpt, and explain which parts need generated metadata. Add a page on
how concepts, dates, enums, optional, nullable, and defaulted fields,
derived types, and result types appear, including that enums list their
wire values and not member names.

Drafted with AI assistance.
Explain why to ask a running application what it serves, what the
anonymous endpoints expose, and how introspection relates to OpenAPI and
proxies. Correct the enumeration and nullable schema description, and
the documentationSummary value and meaning when generated metadata
supplies JSDoc summaries.

Drafted with AI assistance.
@woksin woksin added the no-release No consumer-facing artifact changes label Sep 25, 2026
@woksin
woksin merged commit d3abb8b into main Sep 25, 2026
3 checks passed
@woksin
woksin deleted the docs/batch-b branch September 25, 2026 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release No consumer-facing artifact changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant