Skip to content

Commit cfe9fd4

Browse files
authored
Adding Swagger link
1 parent 86bed3f commit cfe9fd4

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

articles/virtual-machines/image-builder-api-update-release-notes.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,13 @@ If you send an API request to Azure Image Builder's API version 2024-02-01 and b
3535

3636
`Unmarshalling entity encountered error: unmarshalling type *v2024_02_01.ImageTemplate: struct field Properties: unmarshalling type *v2024_02_01.ImageTemplateProperties: struct field Optimize: unmarshalling type *v2024_02_01.ImageTemplatePropertiesOptimize: unmarshalling type *v2024_02_01.ImageTemplatePropertiesOptimize, unknown field \"vmboot\". There is an issue with the syntax with the JSON template you are submitting. Please check the JSON template for syntax and grammar. For more information on the syntax and grammar of the JSON template, visit http://aka.ms/azvmimagebuildertmplref.`
3737

38-
The error message will mention an "unknown field" and direct you to the official documentation: [Create an Azure Image Builder Bicep or ARM template JSON template](./linux/image-builder-json.md). This documentation will guide you on the proper syntax and grammar for constructing valid API calls to the Azure Image Builder service.
38+
The error message will mention an "unknown field" and direct you to the official documentation: [Create an Azure Image Builder Bicep or ARM template JSON template](./linux/image-builder-json.md).
3939

40-
The documentation has been updated to include the proper capitalization and field names ahead of the API release. Below is a list of the documentation changes that were made to match the field names in API version 2024-02-01:
40+
> **Reference Azure Image Builder's Swagger for API Calls**
41+
>
42+
> When making calls to the Azure Image Builder service, always reference the [Swagger documentation](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable), which serves as the definitive source of truth for Azure Image Builder's API specifications. While the public documentation has been updated to include the proper capitalization and field names ahead of the API release, the Swagger definition contains precise details about each AIB API to ensure you are making calls to the service correctly.
43+
44+
Below is a list of the documentation changes that were made to match the field names in API version 2024-02-01:
4145

4246
In the [Create an Azure Image Builder Bicep or ARM template JSON template](./linux/image-builder-json.md) documentation:
4347

0 commit comments

Comments
 (0)