Individual skill
orchardcore-openapi
Skill for the Orchard Core 4.0 OpenAPI module. Covers OpenAPI and Swagger schema generation, the Swagger UI, ReDoc and Scalar documentation sub-features, silent authorization-code plus PKCE sign-in for Try it out requests, the OpenApiPkce and OpenApiGeneration recipes, the AllowAnonymousSchemaAccess setting, the ViewOpenApiContent and ManageOpenApi permissions, NSwag client generation, and documenting custom API endpoints. Use this skill when requests mention Orchard Core OpenAPI, Swagger, swagger.json, ReDoc, Scalar, NSwag, API documentation, API client generation, OpenApiSettings, or closely related Orchard Core implementation, setup, extension, or troubleshooting work. Strong matches include work with OrchardCore.OpenApi, OrchardCore.OpenApi.SwaggerUI, OrchardCore.OpenApi.ReDocUI, OrchardCore.OpenApi.ScalarUI, OpenApiPermissions, OpenApiSettings, ProducesResponseType, ApiExecuteQueryGet, and ApiExecuteQueryPost.
plugins/orchardcore/skills/orchardcore-openapi/SKILL.md
Source commit d86d04f234b1b2bd8145368a2544490f9d557596
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Instructions only
- Last checked
- Nov 6, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 13
- Repository last updated
- Oct 21, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- agent-skills Repository topic
- ai Repository topic
- ai-agents-framework Repository topic
- dotnet Repository topic
- mcp Repository topic
- mcp-server Repository topic
- orchardcore Repository topic
- design Derived category
- docs Derived category
- design-interface Derived category
- docs-api Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Read excerpt
# Orchard Core OpenAPI - Prompt Templates
## Document and Explore Orchard Core APIs
You are an Orchard Core expert. Generate configuration, recipes, and code for the `OrchardCore.OpenApi` module, which ships with Orchard Core 4.0.
### Guidelines
- `OrchardCore.OpenApi` generates the OpenAPI document (Swashbuckle at `/swagger/v1/swagger.json`, plus the ASP.NET Core `/openapi/*.json` document) for every enabled API endpoint.
- The documentation UIs are separate sub-features that each depend on `OrchardCore.OpenApi`. A disabled UI returns `404`.
- Every documentation URL (`/swagger`, `/redoc`, `/scalar`, `/openapi`) requires an authenticated user with `ViewOpenApiContent`. Anonymous users are redirected to the admin login; authenticated users without the permission get `403`.
- The JSON schema endpoints also require `ViewOpenApiContent` (cookie or `Api` bearer token) unless **Allow anonymous access to the API schema** (`AllowAnonymousSchemaAccess`) is enabled. Unauthenticated schema requests get a `401` with a `WWW-Authenticate` header and a Problem Details body.
- `ManageOpenApi` implies `ViewOpenApiContent`. Grant only `ViewOpenApiContent` to roles that should read the docs without changing settings. Both are granted to Administrator by default.
- Orchard Core APIs authenticate with the `Api` scheme, which accepts bearer tokens only. Swagger UI and Scalar acquire a token silently (authorization code + PKCE, `prompt=none` in a hidden iframe) from the tenant's own OpenID server, using the admin cookie session. ReDoc is read-only and needs no token.