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.

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

ContainerInstance: Adding April Swagger For GA #2778

Merged
merged 5 commits into from
Mar 30, 2018

Conversation

samkreter
Copy link
Contributor

@samkreter samkreter commented Mar 29, 2018

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

@AutorestCI
Copy link

AutorestCI commented Mar 29, 2018

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#37

@AutorestCI
Copy link

AutorestCI commented Mar 29, 2018

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2618

@AutorestCI
Copy link

AutorestCI commented Mar 29, 2018

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2320

@hovsepm hovsepm changed the title Adding April Swagger For GA ContainerInstance: Adding April Swagger For GA Mar 29, 2018
@AutorestCI
Copy link

AutorestCI commented Mar 29, 2018

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

Copy link
Contributor

@hovsepm hovsepm left a comment

Choose a reason for hiding this comment

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

please add a new tag to specification/containerinstance/resource-manager/readme.md with the new version

}
}
},
"Logs": {
Copy link
Contributor

Choose a reason for hiding this comment

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

"Logs": { [](start = 1, length = 12)

This type is used only as return value from the server. It is not supposed to be sent back to server thus all the properties should be marked as read-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

}
},
"ContainerExecResponse": {
"description": "The information for the container exec command.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment here - the type is used only as server response. Please mark all the properties as read-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

}
},
"Operation": {
"description": "An operation for Azure Container Instance service.",
Copy link
Contributor

Choose a reason for hiding this comment

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

same comment - this is used only as server return value. please mark all the properties as read-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

"required": [
"name",
"display"
]
Copy link
Contributor

Choose a reason for hiding this comment

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

does not make sense to put required fields in the type that is used only as a server response.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

}
},
"ContainerState": {
"description": "The container instance state.",
Copy link
Contributor

Choose a reason for hiding this comment

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

the name of this type suggest that it is populated only by server - please mark all the properties as read-only

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

}
}
},
"Event": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Event [](start = 5, length = 5)

same here - user should not modify the events received from server. Please mark properties as read-only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@sergey-shandar sergey-shandar added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 29, 2018
@sergey-shandar
Copy link
Contributor

@ravbhatnagar Could you check if it was approved before?

@hovsepm
Copy link
Contributor

hovsepm commented Mar 30, 2018

@samkreter according to swagger spec specifications https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields-13 readOnly attribute can be applied only to properties i.e. you should mark each field under properties as readOnly and not the type itself. Could you revise your pr?

@samkreter
Copy link
Contributor Author

samkreter commented Mar 30, 2018

@hovsepm Just finished the changes you requested.

@hovsepm
Copy link
Contributor

hovsepm commented Mar 30, 2018

@samkreter once ARM team will sing off on the new stable version we will be able to merge.

@ravbhatnagar
Copy link
Contributor

Signing off from ARM side.

@ravbhatnagar ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 30, 2018
@hovsepm hovsepm merged commit aa241a6 into Azure:master Mar 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants