Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 27 additions & 1 deletion docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,30 @@ Here's an example of how you can run the CLI tool:
src/TemplateRefGenerator/bin/Debug/net10.0/TemplateRefGenerator --source-folder ../bicep-types-az/generated --output-folder ./generated
```

To get detailed logging, use the `--verbose` flag.
To get detailed logging, use the `--verbose` flag.

## Read-only resources

Read-only rendering is determined by the source resource type metadata. When
`ResourceType.WritableScopes` is `ScopeType.None`, the generated Bicep, ARM template,
and Terraform sections describe the resource as read-only, retain property reference
tables, and omit deployment syntax and usage examples. No provider-specific remarks
configuration is required. Incorrect writability metadata should be corrected
upstream in the API specifications or type generation.

## Versioning code samples

Reference pages are generated for every available API version of included providers.
To restrict a curated code sample to compatible API versions, set its optional
`ApiVersion` property in the provider's remarks configuration:

```json
"ApiVersion": {
"Minimum": "2026-10-01-preview"
}
```

`Minimum` and `Maximum` are inclusive, optional bounds. A minimum-only requirement
includes that version and later versions, not just the latest version. Omit
`ApiVersion` to show the sample on all versions. These filters apply to Bicep,
ARM template, and Terraform samples without removing older reference pages.
Loading
Loading