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

[Batch] Update documentation around app packages #7177

Merged
merged 1 commit into from
Sep 11, 2019
Merged

[Batch] Update documentation around app packages #7177

merged 1 commit into from
Sep 11, 2019

Conversation

bgklein
Copy link
Contributor

@bgklein bgklein commented Sep 10, 2019

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Sep 10, 2019 •
edited
Loading

In Testing, Please Ignore

[Logs] (Generated from 68ccfd9, Iteration 1)

In-Progress .NET: test-repo-billy/azure-sdk-for-net [Logs]
  • Package generation in progress.
In-Progress Python: test-repo-billy/azure-sdk-for-python [Logs]
  • Package generation in progress.
In-Progress Java: test-repo-billy/azure-sdk-for-java [Logs]
  • Package generation in progress.
In-Progress Go: test-repo-billy/azure-sdk-for-go [Logs]
  • Package generation in progress.
In-Progress JavaScript: test-repo-billy/azure-sdk-for-js [Logs]
  • Package generation in progress.
In-Progress Ruby: test-repo-billy/azure-sdk-for-ruby [Logs]
  • Package generation in progress.

@azuresdkci azuresdkci requested a review from lirenhe September 10, 2019 23:04
@AutorestCI AutorestCI mentioned this pull request Sep 10, 2019
Merged
@AutorestCI
Copy link

AutorestCI commented Sep 10, 2019 •
edited
Loading

Automation for azure-sdk-for-python

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

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@AutorestCI AutorestCI mentioned this pull request Sep 10, 2019
Merged
@AutorestCI
Copy link

AutorestCI commented Sep 10, 2019 •
edited
Loading

Automation for azure-sdk-for-go

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

@zikalino zikalino merged commit 31c56ab into Azure:master Sep 11, 2019
jafreck
jafreck reviewed Sep 11, 2019
View reviewed changes
specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json
@@ -481,7 +481,7 @@
"$ref": "./examples/ApplicationPackageActivate.json"
}
},
"description": "Activates the specified application package.",
"description": "Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks",
Copy link
Member

@jafreck jafreck Sep 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Missing period at the end of the last sentence (seems to be the pattern in the Swagger spec).

Copy link
Member

Choose a reason for hiding this comment

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

I dont think you want markdown syntax here (no `)

Copy link
Member

Choose a reason for hiding this comment

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

Can be "referenced" on pools or tasks, rather than used?

jafreck
jafreck reviewed Sep 11, 2019
View reviewed changes
specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json
@@ -730,7 +730,7 @@
"$ref": "./examples/ApplicationPackageCreate.json"
}
},
"description": "Creates an application package record.",
"description": "Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.",
Copy link
Member

Choose a reason for hiding this comment

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

The term record seems unnecessary to me and doesn't really have a meaning for customers.

Copy link
Member

Choose a reason for hiding this comment

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

Azure Storage Shared Access Signature

Copy link
Member

Choose a reason for hiding this comment

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

"This record refers to a location in Azure Storage where the package should be uploaded. This API returns an Azure Storage Blob URL with Shared Access Signature which can be used to perform the Application upload"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jafreck jafreck jafreck left review comments

@zikalino zikalino zikalino approved these changes

@matthchr matthchr Awaiting requested review from matthchr

@xingwu1 xingwu1 Awaiting requested review from xingwu1

@lirenhe lirenhe Awaiting requested review from lirenhe

Assignees

@lirenhe lirenhe

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@bgklein @AutorestCI @azuresdkci @matthchr @zikalino @jafreck @lirenhe