Skip to content

Validate service reference features #10854

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
Closed
19 tasks done
dougbu opened this issue Jun 4, 2019 · 0 comments
Closed
19 tasks done

Validate service reference features #10854

dougbu opened this issue Jun 4, 2019 · 0 comments
Assignees
@dougbu
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates Done This issue has been fixed Validation This issue is used to track validation efforts
Milestone
3.0.0-preview6

Comments

@dougbu
Copy link
Member

dougbu commented Jun 4, 2019 •
edited
Loading

Client side

Items

  • @(OpenApiReference) with just %(Include) and with metadata below
    • %(ClassName)
    • %(CodeGenerator) e.g. NSwagTypeScript
    • %(Namespace)
    • %(Options) default $(OpenApiGenerateCodeOptions), extend generator's command line
    • %(OutputPath) path for this specific file
  • @(OpenApiProjectReference) with just %(Include) and with metadata below
    • all of the above metadata
    • do not recommend using %(ClassName) and %(OutputPath) because compilation will fail if a project provides multiple OpenAPI documents
    • all @(ProjectReference) metadata as long as $(OpenApiGenerateCodeOnBuild) is true (the default)

Properties

  • $(OpenApiGenerateCodeOptions) extend generator's command line
  • $(OpenApiGenerateCodeOnBuild) default true, set to false to disable feature or tie it in differently
  • $(OpenApiGenerateCodeAtDesignTime) default true, set to false and confirm VS background builds do less work
  • $(OpenApiBuildReferencedProjects) default true, set to false and manually build server projects first
  • $(OpenApiCodeDirectory) default obj/, set to somewhere else e.g. to check the code generated files in

Server side

Items

None

Properties

  • $(OpenApiGenerateDocumentsOptions) extend doc generator's command line e.g. --verbose
  • $(OpenApiGenerateDocuments) default true, set to false to completely disable the feature even the project capability
  • $(OpenApiGenerateDocumentsOnBuild) default true, set to false to disable some of the feature or tie it in differently
  • $(OpenApiDocumentsDirectory) default obj/, set to somewhere else e.g. to check the doc generated files
@dougbu dougbu added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates Validation This issue is used to track validation efforts labels Jun 4, 2019
@dougbu dougbu added this to the 3.0.0-preview6 milestone Jun 4, 2019
@dougbu dougbu self-assigned this Jun 4, 2019
@dougbu dougbu mentioned this issue Jun 5, 2019
Closed
@dougbu dougbu added feature-code-generation Done This issue has been fixed and removed Working labels Jun 5, 2019
@dougbu dougbu closed this as completed Jun 10, 2019
@dougbu dougbu mentioned this issue Jun 24, 2019
Closed
@ghost ghost locked as resolved and limited conversation to collaborators Dec 3, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@dougbu dougbu

Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates Done This issue has been fixed Validation This issue is used to track validation efforts
Projects
None yet
Milestone
3.0.0-preview6
Development

No branches or pull requests
1 participant
@dougbu