Skip to content
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

Jump to bottom

Add 'artifactTags' and 'disclaimer' field for shared gallery and community gallery. #24665

Closed
wants to merge 2 commits into from
Closed

Add 'artifactTags' and 'disclaimer' field for shared gallery and community gallery. #24665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76e9801
swagger and examples
Sandido Jun 30, 2023
fb52afc
update disclaimer pr according to ARM reviewer (#25318)
kangsun-ctrl Aug 16, 2023
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
89 changes: 84 additions & 5 deletions ...pute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,24 @@
},
"description": "Base information about the community gallery resource in pir."
},
"CommunityGalleryArtifactTags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The artifact tags of a community gallery resource."
},
"CommunityGalleryDisclaimer": {
"type": "string",
"properties": {
"disclaimer": {
"readOnly": true,
"type": "string",
"description": "Community gallery disclaimer"
}
},
"description": "The disclaimer for a community gallery resource."
},
"CommunityGalleryIdentifier": {
"properties": {
"uniqueId": {
Expand All @@ -297,15 +315,64 @@
},
"description": "The identifier information of community gallery."
},
"CommunityGalleryMetadata": {
"type": "object",
"properties": {
"publisherUri": {
"type": "string",
"description": "The publisher URI of this community gallery."
},
"publisherContact": {
"type": "string",
"description": "The publisher contact of this community gallery."
},
"eula": {
"type": "string",
"description": "The end-user license agreement for this community gallery."
},
"publicNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of public names the gallery has."
},
"privacyStatementUri": {
"type": "string",
"description": "The link for the privacy statement of this community gallery from the gallery publisher."
}
},
"description": "The metadata of community gallery."
},
"CommunityGallery": {
"properties": {},
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/CommunityGalleryProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/PirCommunityGalleryResource"
}
],
"description": "Specifies information about the Community Gallery that you want to create or update."
},
"CommunityGalleryProperties": {
"type": "object",
"properties": {
"disclaimer": {
"$ref": "#/definitions/CommunityGalleryDisclaimer"
},
"artifactTags": {
"$ref": "#/definitions/CommunityGalleryArtifactTags"
},
"communityMetadata": {
"$ref": "#/definitions/CommunityGalleryMetadata"
}
},
"description": "Describes the properties of a community gallery."
},
"CommunityGalleryImageList": {
"type": "object",
"description": "The List Community Gallery Images operation response.",
Expand All @@ -320,7 +387,7 @@
},
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images."
"description": "The URI to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images."
}
},
"required": [
Expand Down Expand Up @@ -411,11 +478,17 @@
},
"privacyStatementUri": {
"type": "string",
"description": "Privacy statement uri for the current community gallery image."
"description": "Privacy statement URI for the current community gallery image."
},
"eula": {
"type": "string",
"description": "End-user license agreement for the current community gallery image."
"description": "The end-user license agreement for the current community gallery image."
},
"disclaimer": {
"$ref": "#/definitions/CommunityGalleryDisclaimer"
},
"artifactTags": {
"$ref": "#/definitions/CommunityGalleryArtifactTags"
}
},
"required": [
Expand All @@ -439,7 +512,7 @@
},
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions."
"description": "The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions."
}
},
"required": [
Expand Down Expand Up @@ -479,6 +552,12 @@
"storageProfile": {
"$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile",
"description": "Describes the storage profile of the image version."
},
"disclaimer": {
"$ref": "#/definitions/CommunityGalleryDisclaimer"
},
"artifactTags": {
"$ref": "#/definitions/CommunityGalleryArtifactTags"
}
},
"description": "Describes the properties of a gallery image version."
Expand Down
6 changes: 5 additions & 1 deletion ...stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@
"diskSizeGB": 29,
"hostCaching": "None"
}
}
},
"artifactTags": {
"ShareTag-CommunityGallery": "CommunityGallery"
},
"disclaimer": "https://test-uri.com"
},
"location": "myLocation",
"name": "myGalleryImageVersionName",
Expand Down
6 changes: 5 additions & 1 deletion ...table/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@
"diskSizeGB": 29,
"hostCaching": "None"
}
}
},
"artifactTags": {
"ShareTag-CommunityGallery": "CommunityGallery"
},
"disclaimer": "https://test-uri.com"
},
"location": "myLocation",
"name": "myGalleryImageVersionName",
Expand Down
8 changes: 6 additions & 2 deletions ...leryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@
"offer": "myOfferName",
"sku": "mySkuName"
},
"privacyStatementUri": "https://www.microsoft.com/en-us/",
"eula": "https://www.microsoft.com/en-us/"
"privacyStatementUri": "https://test-uri.com",
"eula": "https://test-uri.com",
"artifactTags": {
"ShareTag-CommunityGallery": "CommunityGallery"
},
"disclaimer": "https://test-uri.com"
},
"location": "myLocation",
"name": "myGalleryImageName",
Expand Down
6 changes: 5 additions & 1 deletion ...eryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@
"publisher": "myPublisherName",
"offer": "myOfferName",
"sku": "mySkuName"
}
},
"artifactTags": {
"ShareTag-CommunityGallery": "CommunityGallery"
},
"disclaimer": "https://test-uri.com"
},
"location": "myLocation",
"name": "myGalleryImageName",
Expand Down
15 changes: 15 additions & 0 deletions ...e/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGallery_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@
"type": "Microsoft.Compute/Locations/CommunityGallery",
"identifier": {
"uniqueId": "/CommunityGalleries/publicGalleryName"
},
"properties": {
"artifactTags": {
"ShareTag-CommunityGallery": "CommunityGallery"
},
"disclaimer": "https://test-uri.com",
"communityMetadata": {
"publisherUri": "https://test-uri.com",
"publisherContact": "sameple@email.com",
"eula": "https://test-uri.com",
"publicNames": [
"prefix-xxxxx"
],
"privacyStatementUri": "https://test-uri.com"
}
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions ...eryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
"diskSizeGB": 29,
"hostCaching": "None"
}
},
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
},
"location": "myLocation",
Expand Down
3 changes: 3 additions & 0 deletions ...yRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
"diskSizeGB": 29,
"hostCaching": "None"
}
},
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
},
"location": "myLocation",
Expand Down
5 changes: 4 additions & 1 deletion ...te/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@
"sku": "mySkuName"
},
"privacyStatementUri": "https://www.microsoft.com/en-us/",
"eula": "https://www.microsoft.com/en-us/"
"eula": "https://www.microsoft.com/en-us/",
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
},
"location": "myLocation",
"name": "myGalleryImageName",
Expand Down
3 changes: 3 additions & 0 deletions .../GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
"publisher": "myPublisherName",
"offer": "myOfferName",
"sku": "mySkuName"
},
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
},
"location": "myLocation",
Expand Down
5 changes: 5 additions & 0 deletions ...Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
"name": "myGalleryName",
"identifier": {
"uniqueId": "/SharedGalleries/galleryUniqueName"
},
"properties": {
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
}
}
}
Expand Down
5 changes: 5 additions & 0 deletions ...ompute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@
"name": "galleryUniqueName",
"identifier": {
"uniqueId": "/SharedGalleries/galleryUniqueName"
},
"properties": {
"artifactTags": {
"ShareTag-Official1PGallery": "Official1PGallery"
}
}
}
],
Expand Down
30 changes: 29 additions & 1 deletion ...compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,13 @@
],
"description": "Base information about the shared gallery resource in pir."
},
"SharedGalleryArtifactTags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The artifact tags of a shared gallery resource."
},
"SharedGalleryIdentifier": {
"properties": {
"uniqueId": {
Expand Down Expand Up @@ -445,14 +452,29 @@
]
},
"SharedGallery": {
"properties": {},
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SharedGalleryProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/PirSharedGalleryResource"
}
],
"description": "Specifies information about the Shared Gallery that you want to create or update."
},
"SharedGalleryProperties": {
"type": "object",
"properties": {
"artifactTags": {
"readOnly": true,
"$ref": "#/definitions/SharedGalleryArtifactTags"
}
},
"description": "Specifies the properties of a shared gallery"
},
"SharedGalleryImageList": {
"description": "The List Shared Gallery Images operation response.",
"properties": {
Expand Down Expand Up @@ -562,6 +584,9 @@
"eula": {
"type": "string",
"description": "End-user license agreement for the current community gallery image."
},
"artifactTags": {
"$ref": "#/definitions/SharedGalleryArtifactTags"
}
},
"required": [
Expand Down Expand Up @@ -624,6 +649,9 @@
"storageProfile": {
"$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile",
"description": "Describes the storage profile of the image version."
},
"artifactTags": {
"$ref": "#/definitions/SharedGalleryArtifactTags"
}
},
"description": "Describes the properties of a gallery image version."
Expand Down