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 Face README.python.md #13403

Merged
merged 2 commits into from
Mar 15, 2021
Merged

Update Face README.python.md #13403

merged 2 commits into from
Mar 15, 2021

Conversation

tjprescott
Copy link
Member

Updated so that you can actually generate the SDK simply with
autorest readme.md --python

@openapi-workflow-bot
Copy link

Hi, @tjprescott Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 12, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 12, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dc508cb. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-03-15 19:46:13 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc508cb. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️cognitiveservices/v1.0/face [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `Client.DetectWithStreamPreparer` parameter(s) have been changed from `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
      info	[Changelog] - Function `Client.DetectWithURL` parameter(s) have been changed from `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
      info	[Changelog] - Function `Client.DetectWithURLPreparer` parameter(s) have been changed from `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
      info	[Changelog] - Function `Client.DetectWithStream` parameter(s) have been changed from `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
      info	[Changelog] - Const `Glasses` has been removed
      info	[Changelog] - Const `HeadWear` has been removed
      info	[Changelog] - Const `Mask` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `FaceMask`
      info	[Changelog] - New const `NoMask`
      info	[Changelog] - New const `Recognition04`
      info	[Changelog] - New const `AccessoryTypeGlasses`
      info	[Changelog] - New const `AccessoryTypeHeadWear`
      info	[Changelog] - New const `AccessoryTypeMask`
      info	[Changelog] - New const `Detection03`
      info	[Changelog] - New const `OtherMaskOrOcclusion`
      info	[Changelog] - New const `AttributeTypeMask`
      info	[Changelog] - New const `Uncertain`
      info	[Changelog] - New function `PossibleMaskTypeValues() []MaskType`
      info	[Changelog] - New struct `Mask`
      info	[Changelog] - New field `Mask` in struct `Attributes`
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 14 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dc508cb. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-cognitiveservices-vision-face [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model FaceAttributes has a new parameter mask
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation FaceOperations.detect_with_stream has a new signature
      info	[Changelog]   - Operation FaceOperations.detect_with_url has a new signature
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc508cb. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/Face/readme.md
    • ️✔️@azure/cognitiveservices-face [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/faceClient.js → ./dist/cognitiveservices-face.js...
      cmderr	[npmPack] created ./dist/cognitiveservices-face.js in 473ms
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @tjprescott
    Copy link
    Member Author

    tjprescott commented Mar 12, 2021

    @jhendrixMSFT @yangyuan removing the labels added by the bot as false positives. This doesn't affect Go at all, and it does not break the Python SDK (but using this readme in its current state certainly would).

    Comment on lines +15 to +18
    use: "@microsoft.azure/autorest.python@~4.0.71"
    version: V2
    multiapi: true
    no-async: true
    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    Autorest will generate the completely wrong set of files without these settings.

    @tjprescott tjprescott changed the title Update Face REAMDE.python.md Update Face README.python.md Mar 15, 2021
    Copy link
    Contributor

    @iscai-msft iscai-msft left a comment

    Choose a reason for hiding this comment

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

    looks good. for documentations sake: this is to only generate a track 1 sdk, hence the differences in use, and version

    @jhendrixMSFT jhendrixMSFT merged commit dc508cb into master Mar 15, 2021
    @jhendrixMSFT jhendrixMSFT deleted the UpdateFacePythonReadme branch March 15, 2021 19:41
    MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
    * Update Python readme
    
    * Fix setting.
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Update Python readme
    
    * Fix setting.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants