Skip to content

Conversation

@v-sodsou
Copy link
Contributor

@v-sodsou v-sodsou commented Apr 4, 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

@AutorestCI
Copy link

AutorestCI commented Apr 4, 2018

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#1963

@AutorestCI
Copy link

AutorestCI commented Apr 4, 2018

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2694

@AutorestCI
Copy link

AutorestCI commented Apr 4, 2018

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#55

@AutorestCI
Copy link

AutorestCI commented Apr 4, 2018

Automation for azure-sdk-for-go

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-go#1516

@v-sodsou v-sodsou changed the title Add SSN parameter Add SSN parameter to Content Moderator Screen text API Apr 4, 2018
@v-sodsou
Copy link
Contributor Author

v-sodsou commented Apr 4, 2018

@jhendrixMSFT
I have added new parameter (SSN) to the Content Moderator screen text api response.
Could you please review it.

Thanks
Sonali Dsouza

"format": "binary",
"type": "string"
"type": "object",
"format": "file"
Copy link
Member

Choose a reason for hiding this comment

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

Just to be sure it's clear to you, that's a breaking change. Before, it was taking a string in memory, now it's taking a file descriptor.
If you expect this to be possibly massive file as input, it makes sense, but still breaking and samples will have to be updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will update the sample. I had to change this as autorest generated sdk files for string type text content serializes the string content . For example “profanity term” string gets serialized as ""profanity term""
Which causes the profanity term index(position) response from sdk to alter by +1 position(ex: index for this profanity text should be 0 but sdk returns 1).
So I was suggested this change to avoid manual change of sdk files.

Copy link
Member

@lmazuel lmazuel Apr 5, 2018

Choose a reason for hiding this comment

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

Note that you're talking about C# only :).
If you feel there is a bug in the C# SDK generator, please open an issue to fix that instead of changing the Swagger. If you feel that input as file descriptor is better anyway, that's fine as well. Please, it's important to separate a possible bug that impacts C# only, to a global design question about the input type.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I discussed this with sdk code generator team and apparently if the type is "string", the assumption is that it needs to be deserialized. And they don't have a way to say "not to deserialize that" . So its not a bug from their end. Regarding other languages, all languages support stream so shouldn't be a problem.I got this verified with their team.

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.

LGTM, but please confirm explicitly the breaking change is expected.

}

},
"SSN": {
Copy link
Member

Choose a reason for hiding this comment

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

I have no examples, so I can just trust you than the actual JSON received is as described :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will update the example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I confirm this change is expected.

@lmazuel
Copy link
Member

lmazuel commented Apr 5, 2018

@annatisch FYI

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