Skip to content

Conversation

@dougbu
Copy link
Contributor

@dougbu dougbu commented Aug 16, 2019

  • Refine warnings and errors in service ref feature #12792
  • client:
    • add error if OpenAPI file does not exist
    • separate unsupported TFM case from targets being called when disabled
  • server:
    • generalize multi-targeting handling in Microsoft.Extensions.ApiDescription.Server
      • add $(_OpenApiGenerateDocumentsTFM), the TFM used when invoking inner build
      • default $(OpenApiGenerateDocuments) to 'true' only when a supported TFM exists
    • add separate error for non-existent cache file in OpenApiGetDocuments target
    • add error in GetDocumentInsider if no documents are found
      • make <Warning /> in the targets file an <Error />
      • add more text to existing ServiceNotFound error
  • both:
    • write errors to stderr
    • clean up top-level output for Exceptions
      • stop writing the Message twice
  • Correct "Open API" mentions; should be "OpenAPI"

    • change package tags and comments
  • Add service reference projects to MvcNoDeps.slnf

nits:

  • add "service reference" tag in Microsoft.Extensions.ApiDescription.* packages
  • add "document generation" tag in Microsoft.Extensions.ApiDescription.Server package
  • .Trim() TFM properties because <TargetFrameworks>;netcoreapp3.0;;</TargetFrameworks> is allowed
  • don't use bold black for verbose messages
  • reorder MSBuild property settings for readability

- #12792
- client:
  - add error if OpenAPI file does not exist
  - separate unsupported TFM case from targets being called when disabled
- server:
  - generalize multi-targeting handling in Microsoft.Extensions.ApiDescription.Server
    - add `$(_OpenApiGenerateDocumentsTFM)`, the TFM used when invoking inner build
    - default `$(OpenApiGenerateDocuments)` to 'true' only when a supported TFM exists
  - add separate error for non-existent cache file in `OpenApiGetDocuments` target
  - add error in `GetDocumentInsider` if no documents are found
    - make `<Warning />` in the targets file an `<Error />`
    - add more text to existing `ServiceNotFound` error
- both:
  - write errors to `stderr`
  - clean up top-level output for `Exception`s
    - stop writing the `Message` twice

* Correct "Open API" mentions; should be "OpenAPI"
  - change package tags and comments

* Add service reference projects to MvcNoDeps.slnf

nits:
- add "service reference" tag in Microsoft.Extensions.ApiDescription.* packages
- add "document generation" tag in Microsoft.Extensions.ApiDescription.Server package
- `.Trim()` TFM properties because `<TargetFrameworks>;netcoreapp3.0;;</TargetFrameworks>` is allowed
- don't use bold black for verbose messages
- reorder MSBuild property settings for readability
@dougbu
Copy link
Contributor Author

dougbu commented Aug 16, 2019

/bump reviewers. All checks passed.

@dougbu
Copy link
Contributor Author

dougbu commented Aug 16, 2019

@pranavkm @rynowak please have a look

@dougbu dougbu merged commit c0d5248 into release/3.0 Aug 16, 2019
@ghost ghost deleted the dougbu/service.ref.warnings.12792 branch August 16, 2019 23:56
@dougbu dougbu added the tell-mode Indicates a PR which is being merged during tell-mode label Aug 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tell-mode Indicates a PR which is being merged during tell-mode

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants