Skip to content

Added the swagger file for the new service Gallery. #3080

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

Merged
lmazuel merged 33 commits into from
May 23, 2018
Merged

Added the swagger file for the new service Gallery. #3080

Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b488625
Added the swagger file for the new service Gallery.
vanbasten2323 May 15, 2018
0ae8ade
Fixed minor issues. Added an example.
vanbasten2323 May 16, 2018
47016ed
Added the example for creating a gallery.
vanbasten2323 May 16, 2018
d2537a5
Gallery Python conf
lmazuel May 16, 2018
4c694fe
Make the tag name plural.
vanbasten2323 May 16, 2018
958b583
Merge branch 'dev/xiowei/addSwaggerForGallery' of https://github.com/…
vanbasten2323 May 16, 2018
29d0c57
Fixed description for 202 response.
vanbasten2323 May 16, 2018
b74f3ee
Changed the operationId to conform to naming convention.
vanbasten2323 May 16, 2018
664c041
Fixed some typos.
vanbasten2323 May 16, 2018
e7ab964
Add default error response. Make provisioningInfo a enum type.
vanbasten2323 May 18, 2018
c26feda
Fixed comments according to CR.
vanbasten2323 May 21, 2018
b757a4e
Resolved merge conflicts.
vanbasten2323 May 21, 2018
fa546f9
Updated the readme.md
vanbasten2323 May 21, 2018
cdaa5b4
Updated the example.
vanbasten2323 May 21, 2018
5a18325
do some experiments.
vanbasten2323 May 22, 2018
e7bb836
Cleaned up unused files.
vanbasten2323 May 22, 2018
604b39f
added empty example file.
vanbasten2323 May 23, 2018
e8b5fbd
Added example for GetGallery api.
vanbasten2323 May 23, 2018
7477feb
Added example for DeleteGallery api. Passed the local validation.
vanbasten2323 May 23, 2018
bbde0de
Added example for PutGalleryImage api. Passed the local validation.
vanbasten2323 May 23, 2018
14e0a17
Added example for GetGalleryImage api. Passed the local validation.
vanbasten2323 May 23, 2018
f5bd197
Added example for DeleteGalleryImage api. Passed the local validation.
vanbasten2323 May 23, 2018
0329884
Added example for PutGalleryImageVersion api. Passed the local valida…
vanbasten2323 May 23, 2018
7c9b26b
Added example for GetGalleryImageVersion api. Passed the local valida…
vanbasten2323 May 23, 2018
6f4661c
Added example for DeleteGalleryImageVersion api. Passed the local val…
vanbasten2323 May 23, 2018
8e46ef9
Added example for ListGalleriesInAResourceGroup api. Passed the local…
vanbasten2323 May 23, 2018
ee7a6de
Added example for ListGalleriesInASubscription api. Passed the local …
vanbasten2323 May 23, 2018
3619af8
Added example for ListGalleryImagesInGallery api. Passed the local va…
vanbasten2323 May 23, 2018
e5ef375
Added example for ListGalleryImageVersionsInGalleryImage api. Passed …
vanbasten2323 May 23, 2018
ce1cfe9
Fixed typos in the example provided.
vanbasten2323 May 23, 2018
98063fc
Fixed typos in the example provided.
vanbasten2323 May 23, 2018
70f7a27
Added the supression for gallery, gallery image, and gallery image ve…
vanbasten2323 May 23, 2018
4c60939
Correct the suppression.
vanbasten2323 May 23, 2018
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
Prev Previous commit
Next Next commit
Add default error response. Make provisioningInfo a enum type.
  • Loading branch information
@vanbasten2323
vanbasten2323 committed May 18, 2018
commit e7ab96432e0bfc7c49839ca5d1194ec1be0c23a9
145 changes: 142 additions & 3 deletions specification/compute/resource-manager/Microsoft.Compute/preview/2018-06-01/gallery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@
"schema": {
"$ref": "#/definitions/Gallery"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true,
Expand Down Expand Up @@ -122,6 +128,12 @@
"schema": {
"$ref": "#/definitions/Gallery"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
Expand Down Expand Up @@ -155,6 +167,12 @@
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
Expand Down Expand Up @@ -213,6 +231,12 @@
"schema": {
"$ref": "#/definitions/GalleryImage"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
Expand Down Expand Up @@ -254,6 +278,12 @@
"schema": {
"$ref": "#/definitions/GalleryImage"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
Expand Down Expand Up @@ -294,6 +324,12 @@
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
Expand Down Expand Up @@ -359,6 +395,12 @@
"schema": {
"$ref": "#/definitions/GalleryImageVersion"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
Expand Down Expand Up @@ -414,6 +456,12 @@
"schema": {
"$ref": "#/definitions/GalleryImageVersion"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
Expand Down Expand Up @@ -461,6 +509,12 @@
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
Expand Down Expand Up @@ -490,6 +544,12 @@
"schema": {
"$ref": "#/definitions/GalleryList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
Expand All @@ -515,6 +575,12 @@
"schema": {
"$ref": "#/definitions/GalleryList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
Expand Down Expand Up @@ -550,6 +616,12 @@
"schema": {
"$ref": "#/definitions/GalleryImageList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
Expand Down Expand Up @@ -592,6 +664,12 @@
"schema": {
"$ref": "#/definitions/GalleryImageVersionList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
Expand Down Expand Up @@ -624,7 +702,16 @@
"provisioningState": {
Copy link
Contributor

@ravbhatnagar ravbhatnagar May 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make enum with all the possible values described.

Copy link
Contributor

@vanbasten23 vanbasten23 May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made it enum. But I didn't use the the "x-ms-enum" because, as the documentation (https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) suggested, our provisioningState may still be subject to change, since it is a new service.

"readOnly": true,
"type": "string",
"description": "The provisioning state, which only appears in the response."
"title": "The current state of the gallery.",
"description": "The provisioning state, which only appears in the response.",
"enum": [
"Creating",
"Updating",
"Failed",
"Succeeded",
"Deleting",
"Migrating"
]
}
},
"description": "Describes the properties of a gallery."
Expand Down Expand Up @@ -714,7 +801,16 @@
"provisioningState": {
Copy link
Contributor

@ravbhatnagar ravbhatnagar May 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enum

Copy link
Contributor

@vanbasten23 vanbasten23 May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fixed.

"readOnly": true,
"type": "string",
"description": "The provisioning state, which only appears in the response."
"title": "The current state of the gallery image.",
"description": "The provisioning state, which only appears in the response.",
"enum": [
"Creating",
"Updating",
"Failed",
"Succeeded",
"Deleting",
"Migrating"
]
}
},
"description": "Describes the properties of a gallery image."
Expand Down Expand Up @@ -813,7 +909,16 @@
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "The provisioning state, which only appears in the response."
"title": "The current state of the gallery image version.",
"description": "The provisioning state, which only appears in the response.",
"enum": [
"Creating",
"Updating",
"Failed",
"Succeeded",
"Deleting",
"Migrating"
]
},
"storageProfile": {
"$ref": "#/definitions/GalleryImageVersionStorageProfile"
Expand Down Expand Up @@ -1057,6 +1162,40 @@
],
"description": "The List Gallery Image version operation response."
},
"CloudError": {
"x-ms-external": true,
"properties": {
"error": {
"$ref": "#/definitions/CloudErrorBody"
}
},
"description": "An error response from the Gallery service."
},
"CloudErrorBody": {
"x-ms-external": true,
"properties": {
"code": {
"type": "string",
"description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
},
"message": {
"type": "string",
"description": "A message describing the error, intended to be suitable for display in a user interface."
},
"target": {
"type": "string",
"description": "The target of the particular error. For example, the name of the property in error."
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/CloudErrorBody"
},
"description": "A list of additional details about the error."
}
},
"description": "An error response from the Batch service."
},
"Resource": {
"description": "The Resource model definition.",
"properties": {
Expand Down