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

Update and add readme.nodejs.md files with latest generator arguments #2788

Merged
3 commits merged into from
Mar 30, 2018

Conversation

ghost
Copy link

@ghost ghost commented Mar 30, 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

@ghost ghost self-assigned this Mar 30, 2018
@ghost ghost requested review from lmazuel, amarzavery and RikkiGibson March 30, 2018 19:51
```

``` yaml $(nodejs) && $(tag) == 'package-catalog'
Copy link
Member

Choose a reason for hiding this comment

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

Beyond the output-folder changing to source-code-folder-path, is this a style change or a correctness change to add the additional yaml blocks?

Copy link
Author

Choose a reason for hiding this comment

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

@lmazuel showed me to do it this way when I configured the Java Swagger To SDK readme files and I feel like it's a little easier to read (style change). I'm not sure if one way is more correct than the other.

Copy link
Member

@lmazuel lmazuel Mar 30, 2018

Choose a reason for hiding this comment

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

In this particular scenario, I feel both are fine.
However, for multi-api versionning, we want to have ONE "batch" at the beginning of the file to explain what ApiVersions are shipped by all SDKs. Then, this batch will have to be a list of tags.

@AutorestCI
Copy link

AutorestCI commented Mar 30, 2018

Automation for azure-sdk-for-python

This PR contains more than 3 context, SDK generation is not enabled. Contexts found:

  • eventgrid/data-plane
  • servicebus/resource-manager
  • cognitiveservices/data-plane/ComputerVision
  • datamigration/resource-manager
  • domainservices/resource-manager
  • resourcehealth/resource-manager
  • containerinstance/resource-manager
  • intune/resource-manager
  • notificationhubs/resource-manager
  • datafactory/resource-manager
  • datalake-analytics/resource-manager
  • cognitiveservices/data-plane/SpellCheck
  • compute/resource-manager
  • managementgroups/resource-manager
  • iotspaces/resource-manager
  • recoveryservices/resource-manager
  • locationbasedservices/resource-manager
  • automation/resource-manager
  • apimanagement/resource-manager
  • scheduler/resource-manager
  • cognitiveservices/data-plane/EntitySearch
  • cognitiveservices/data-plane/TextAnalytics
  • cognitiveservices/resource-manager
  • cognitiveservices/data-plane/VideoSearch
  • machinelearningcompute/resource-manager
  • datalake-store/resource-manager
  • commerce/resource-manager
  • policyinsights/resource-manager
  • billing/resource-manager
  • datalake-store/data-plane
  • migrate/resource-manager
  • hanaonazure/resource-manager
  • relay/resource-manager
  • recoveryservicesbackup/resource-manager
  • databricks/resource-manager
  • azurestack
  • eventhub/resource-manager
  • consumption/resource-manager
  • iothub/resource-manager
  • service-map/resource-manager
  • cdn/resource-manager
  • advisor/resource-manager
  • reservations/resource-manager
  • mysql/resource-manager
  • network/resource-manager
  • servermanagement/resource-manager
  • cognitiveservices/data-plane/NewsSearch
  • resources/resource-manager
  • powerbiembedded/resource-manager
  • deviceprovisioningservices/resource-manager
  • servicefabric/data-plane
  • search/resource-manager
  • batchai/resource-manager
  • mobileengagement/resource-manager
  • customer-insights/resource-manager
  • web/resource-manager
  • machinelearningexperimentation/resource-manager
  • applicationinsights/resource-manager
  • containerregistry/resource-manager
  • datacatalog/resource-manager
  • keyvault/resource-manager
  • cognitiveservices/data-plane/ContentModerator
  • hdinsight/resource-manager
  • dns/resource-manager
  • cognitiveservices/data-plane/Face
  • datalake-analytics/data-plane
  • keyvault/data-plane
  • servicefabric/resource-manager
  • storage/resource-manager
  • powerbidedicated/resource-manager
  • analysisservices/resource-manager
  • monitor/resource-manager
  • msi/resource-manager
  • cosmos-db/resource-manager
  • logic/resource-manager
  • trafficmanager/resource-manager
  • operationalinsights/resource-manager
  • storageimportexport/resource-manager
  • postgresql/resource-manager
  • eventgrid/resource-manager
  • storsimple8000series/resource-manager
  • machinelearning/resource-manager
  • batch/resource-manager
  • timeseriesinsights/resource-manager
  • subscription/resource-manager
  • containerservices/resource-manager
  • cognitiveservices/data-plane/WebSearch
  • marketplaceordering/resource-manager
  • mediaservices/resource-manager
  • graphrbac/data-plane
  • visualstudio/resource-manager
  • operationsmanagement/resource-manager
  • redis/resource-manager
  • batch/data-plane
  • authorization/resource-manager
  • recoveryservicessiterecovery/resource-manager
  • sql/resource-manager
  • devtestlabs/resource-manager
  • managementpartner/resource-manager
  • streamanalytics/resource-manager
  • cognitiveservices/data-plane/CustomSearch
  • cognitiveservices/data-plane/ImageSearch

@@ -6,6 +6,11 @@ Please also specify `--node-sdks-folder=<path to root folder of your azure-sdk-f
``` yaml $(nodejs)
nodejs:
package-name: azure-cognitiveservices-entitysearch
output-folder: $(node-sdks-folder)/lib/services/entitySearch/lib
package-version: 1.0.0-preview
output-folder: $(node-sdks-folder)/lib/services/entitySearch
Copy link
Contributor

@amarzavery amarzavery Mar 30, 2018

Choose a reason for hiding this comment

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

@daschult - FYI, We have rollup packages for different cognitive services category (search, vision, language). Somehow we will have to make sure that the rollup packages also get updated and published when we generate a package for an individual congnitive service.

@AutorestCI
Copy link

AutorestCI commented Mar 30, 2018

Automation for azure-libraries-for-java

This PR contains more than 3 context, SDK generation is not enabled. Contexts found:

  • relay/resource-manager
  • visualstudio/resource-manager
  • servicefabric/resource-manager
  • advisor/resource-manager
  • devtestlabs/resource-manager
  • domainservices/resource-manager
  • datafactory/resource-manager
  • cognitiveservices/data-plane/ImageSearch
  • managementpartner/resource-manager
  • consumption/resource-manager
  • machinelearningcompute/resource-manager
  • cognitiveservices/data-plane/SpellCheck
  • cognitiveservices/data-plane/VideoSearch
  • storageimportexport/resource-manager
  • commerce/resource-manager
  • authorization/resource-manager
  • deviceprovisioningservices/resource-manager
  • datamigration/resource-manager
  • service-map/resource-manager
  • cognitiveservices/data-plane/Face
  • storage/resource-manager
  • cognitiveservices/data-plane/EntitySearch
  • eventhub/resource-manager
  • keyvault/resource-manager
  • streamanalytics/resource-manager
  • compute/resource-manager
  • msi/resource-manager
  • apimanagement/resource-manager
  • containerinstance/resource-manager
  • datalake-store/data-plane
  • sql/resource-manager
  • managementgroups/resource-manager
  • graphrbac/data-plane
  • databricks/resource-manager
  • operationalinsights/resource-manager
  • customer-insights/resource-manager
  • reservations/resource-manager
  • marketplaceordering/resource-manager
  • datalake-analytics/resource-manager
  • machinelearning/resource-manager
  • machinelearningexperimentation/resource-manager
  • locationbasedservices/resource-manager
  • timeseriesinsights/resource-manager
  • azurestack
  • trafficmanager/resource-manager
  • cdn/resource-manager
  • hanaonazure/resource-manager
  • web/resource-manager
  • datalake-analytics/data-plane
  • notificationhubs/resource-manager
  • cognitiveservices/resource-manager
  • migrate/resource-manager
  • analysisservices/resource-manager
  • mediaservices/resource-manager
  • servermanagement/resource-manager
  • eventgrid/resource-manager
  • containerregistry/resource-manager
  • automation/resource-manager
  • cognitiveservices/data-plane/CustomSearch
  • recoveryservicessiterecovery/resource-manager
  • intune/resource-manager
  • mysql/resource-manager
  • dns/resource-manager
  • iotspaces/resource-manager
  • policyinsights/resource-manager
  • powerbiembedded/resource-manager
  • monitor/resource-manager
  • billing/resource-manager
  • scheduler/resource-manager
  • cosmos-db/resource-manager
  • keyvault/data-plane
  • iothub/resource-manager
  • redis/resource-manager
  • cognitiveservices/data-plane/NewsSearch
  • recoveryservices/resource-manager
  • cognitiveservices/data-plane/WebSearch
  • batchai/resource-manager
  • eventgrid/data-plane
  • cognitiveservices/data-plane/ComputerVision
  • operationsmanagement/resource-manager
  • recoveryservicesbackup/resource-manager
  • resourcehealth/resource-manager
  • logic/resource-manager
  • postgresql/resource-manager
  • storsimple8000series/resource-manager
  • cognitiveservices/data-plane/ContentModerator
  • servicefabric/data-plane
  • datacatalog/resource-manager
  • cognitiveservices/data-plane/TextAnalytics
  • hdinsight/resource-manager
  • servicebus/resource-manager
  • containerservices/resource-manager
  • mobileengagement/resource-manager
  • applicationinsights/resource-manager
  • subscription/resource-manager
  • batch/data-plane
  • search/resource-manager
  • resources/resource-manager
  • network/resource-manager
  • datalake-store/resource-manager
  • powerbidedicated/resource-manager
  • batch/resource-manager

@AutorestCI
Copy link

AutorestCI commented Mar 30, 2018

Automation for azure-sdk-for-node

This PR contains more than 3 context, SDK generation is not enabled. Contexts found:

  • datacatalog/resource-manager
  • cognitiveservices/data-plane/WebSearch
  • batchai/resource-manager
  • commerce/resource-manager
  • domainservices/resource-manager
  • cognitiveservices/data-plane/VideoSearch
  • iotspaces/resource-manager
  • cdn/resource-manager
  • machinelearning/resource-manager
  • machinelearningexperimentation/resource-manager
  • streamanalytics/resource-manager
  • subscription/resource-manager
  • timeseriesinsights/resource-manager
  • hdinsight/resource-manager
  • batch/data-plane
  • compute/resource-manager
  • mobileengagement/resource-manager
  • datalake-store/data-plane
  • cognitiveservices/data-plane/SpellCheck
  • datalake-analytics/resource-manager
  • cognitiveservices/data-plane/NewsSearch
  • search/resource-manager
  • containerregistry/resource-manager
  • keyvault/data-plane
  • datafactory/resource-manager
  • web/resource-manager
  • deviceprovisioningservices/resource-manager
  • machinelearningcompute/resource-manager
  • servicefabric/resource-manager
  • mysql/resource-manager
  • iothub/resource-manager
  • containerinstance/resource-manager
  • reservations/resource-manager
  • intune/resource-manager
  • applicationinsights/resource-manager
  • monitor/resource-manager
  • analysisservices/resource-manager
  • operationsmanagement/resource-manager
  • policyinsights/resource-manager
  • datalake-analytics/data-plane
  • hanaonazure/resource-manager
  • eventhub/resource-manager
  • postgresql/resource-manager
  • servermanagement/resource-manager
  • cognitiveservices/data-plane/CustomSearch
  • locationbasedservices/resource-manager
  • trafficmanager/resource-manager
  • devtestlabs/resource-manager
  • managementgroups/resource-manager
  • marketplaceordering/resource-manager
  • recoveryservicessiterecovery/resource-manager
  • azurestack
  • dns/resource-manager
  • databricks/resource-manager
  • authorization/resource-manager
  • servicefabric/data-plane
  • recoveryservices/resource-manager
  • containerservices/resource-manager
  • cognitiveservices/data-plane/ContentModerator
  • storsimple8000series/resource-manager
  • storageimportexport/resource-manager
  • cosmos-db/resource-manager
  • powerbiembedded/resource-manager
  • graphrbac/data-plane
  • customer-insights/resource-manager
  • scheduler/resource-manager
  • visualstudio/resource-manager
  • recoveryservicesbackup/resource-manager
  • redis/resource-manager
  • datalake-store/resource-manager
  • relay/resource-manager
  • billing/resource-manager
  • migrate/resource-manager
  • msi/resource-manager
  • operationalinsights/resource-manager
  • storage/resource-manager
  • automation/resource-manager
  • advisor/resource-manager
  • cognitiveservices/resource-manager
  • notificationhubs/resource-manager
  • powerbidedicated/resource-manager
  • cognitiveservices/data-plane/EntitySearch
  • servicebus/resource-manager
  • mediaservices/resource-manager
  • cognitiveservices/data-plane/ComputerVision
  • logic/resource-manager
  • consumption/resource-manager
  • cognitiveservices/data-plane/TextAnalytics
  • batch/resource-manager
  • eventgrid/resource-manager
  • datamigration/resource-manager
  • sql/resource-manager
  • resources/resource-manager
  • apimanagement/resource-manager
  • keyvault/resource-manager
  • cognitiveservices/data-plane/ImageSearch
  • managementpartner/resource-manager
  • network/resource-manager
  • resourcehealth/resource-manager
  • service-map/resource-manager
  • eventgrid/data-plane
  • cognitiveservices/data-plane/Face

Copy link
Member

@lmazuel lmazuel left a comment

Choose a reason for hiding this comment

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

I don't get the NodeJS specific details, but in terms of configuration looks good.

@ghost
Copy link
Author

ghost commented Mar 30, 2018

I think this looks good. I'm going to merge it.

@ghost ghost merged commit 27805a1 into master Mar 30, 2018
@ghost ghost deleted the daschult/FixAllNodeJsReadmes branch March 30, 2018 22:31
@AutorestCI
Copy link

AutorestCI commented Mar 31, 2018

Automation for azure-sdk-for-go

This PR contains more than 3 context, SDK generation is not enabled. Contexts found:

  • customer-insights/resource-manager
  • devtestlabs/resource-manager
  • consumption/resource-manager
  • datalake-analytics/data-plane
  • batchai/resource-manager
  • commerce/resource-manager
  • reservations/resource-manager
  • servicebus/resource-manager
  • azurestack
  • recoveryservicessiterecovery/resource-manager
  • storageimportexport/resource-manager
  • containerservices/resource-manager
  • deviceprovisioningservices/resource-manager
  • machinelearningexperimentation/resource-manager
  • msi/resource-manager
  • datalake-store/data-plane
  • network/resource-manager
  • containerinstance/resource-manager
  • search/resource-manager
  • recoveryservicesbackup/resource-manager
  • marketplaceordering/resource-manager
  • cosmos-db/resource-manager
  • managementpartner/resource-manager
  • cognitiveservices/resource-manager
  • storage/resource-manager
  • apimanagement/resource-manager
  • batch/data-plane
  • subscription/resource-manager
  • automation/resource-manager
  • cognitiveservices/data-plane/CustomSearch
  • hdinsight/resource-manager
  • cognitiveservices/data-plane/ImageSearch
  • cognitiveservices/data-plane/NewsSearch
  • mysql/resource-manager
  • cognitiveservices/data-plane/WebSearch
  • eventhub/resource-manager
  • migrate/resource-manager
  • cognitiveservices/data-plane/VideoSearch
  • timeseriesinsights/resource-manager
  • sql/resource-manager
  • relay/resource-manager
  • resources/resource-manager
  • service-map/resource-manager
  • servermanagement/resource-manager
  • databricks/resource-manager
  • analysisservices/resource-manager
  • keyvault/resource-manager
  • cognitiveservices/data-plane/SpellCheck
  • cognitiveservices/data-plane/Face
  • servicefabric/resource-manager
  • visualstudio/resource-manager
  • advisor/resource-manager
  • operationalinsights/resource-manager
  • servicefabric/data-plane
  • containerregistry/resource-manager
  • notificationhubs/resource-manager
  • eventgrid/resource-manager
  • recoveryservices/resource-manager
  • logic/resource-manager
  • datalake-store/resource-manager
  • machinelearningcompute/resource-manager
  • dns/resource-manager
  • datacatalog/resource-manager
  • hanaonazure/resource-manager
  • web/resource-manager
  • mobileengagement/resource-manager
  • graphrbac/data-plane
  • batch/resource-manager
  • locationbasedservices/resource-manager
  • storsimple8000series/resource-manager
  • keyvault/data-plane
  • machinelearning/resource-manager
  • domainservices/resource-manager
  • billing/resource-manager
  • resourcehealth/resource-manager
  • eventgrid/data-plane
  • iotspaces/resource-manager
  • datamigration/resource-manager
  • authorization/resource-manager
  • trafficmanager/resource-manager
  • cdn/resource-manager
  • managementgroups/resource-manager
  • cognitiveservices/data-plane/EntitySearch
  • policyinsights/resource-manager
  • datafactory/resource-manager
  • operationsmanagement/resource-manager
  • cognitiveservices/data-plane/TextAnalytics
  • redis/resource-manager
  • scheduler/resource-manager
  • monitor/resource-manager
  • mediaservices/resource-manager
  • powerbiembedded/resource-manager
  • compute/resource-manager
  • cognitiveservices/data-plane/ContentModerator
  • powerbidedicated/resource-manager
  • datalake-analytics/resource-manager
  • iothub/resource-manager
  • cognitiveservices/data-plane/ComputerVision
  • postgresql/resource-manager
  • applicationinsights/resource-manager
  • intune/resource-manager
  • streamanalytics/resource-manager

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants