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

[Storage][Queue] re-export models used in public api surface ex… #5534

Merged
merged 1 commit into from
Oct 20, 2019

Conversation

jeremymeng
Copy link
Member

This PR replaces import * as Model with explicitly importing types that we used in public api surface. A geneartedModels.ts is added to import those types aliased with Model suffix to indicate that they are from generated models.

This change brings several benefits, among them

  • api-extractor now works fine to generate the api review markdown file under review folder. It is used to audit the public api changes.
  • we now selectively export types from generated code instead of exporting everything.

Some re-exported types are not aliased because they are used in the definition of the Models in generated code thus cannot be renamed.

@jeremymeng
Copy link
Member Author

/azp run js - storage-queue - tests

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Member

@XiaoningLiu XiaoningLiu left a comment

Choose a reason for hiding this comment

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

Does generated API doc look good for these reexported models?

@jeremymeng
Copy link
Member Author

Does generated API doc look good for these reexported models?

Before this change we don't even have links to the generated models due to a typedoc issue. https://azure.github.io/azure-sdk-for-js/storage-blob/classes/containerclient.html#listblobsflat

image

After this change, the links are generated.
image

@jeremymeng jeremymeng changed the base branch from feature/storage to master October 16, 2019 23:16
@jeremymeng jeremymeng force-pushed the queue-model-import branch 2 times, most recently from f817c6a to a4a38fc Compare October 17, 2019 20:57
@jeremymeng jeremymeng added Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files) labels Oct 17, 2019
@jeremymeng jeremymeng changed the title [Storage][Queue] re-export models used in public api surface explictly [Storage][Queue] re-export models used in public api surface ex… Oct 20, 2019
@jeremymeng jeremymeng merged commit 592b32e into Azure:master Oct 20, 2019
@jeremymeng jeremymeng deleted the queue-model-import branch October 20, 2019 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants