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

Add News Search API Swagger Spec #2026

Merged
merged 3 commits into from
Dec 11, 2017
Merged

Add News Search API Swagger Spec #2026

merged 3 commits into from
Dec 11, 2017

Conversation

xiaojinghe
Copy link
Contributor

@xiaojinghe xiaojinghe commented Nov 17, 2017

  • Add News Search API Swagger Spec

  • Add NewsArticle into Spec

  • Add miss comma before x-ms-examples

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

* Add News Search API Swagger Spec

* Add NewsArticle into Spec

* Add miss comma before x-ms-examples
@olydis
Copy link
Contributor

olydis commented Nov 21, 2017

@fearthecowboy FYI, data plane

Copy link

@alvadb alvadb left a comment

Choose a reason for hiding this comment

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

``` yaml $(tag) == 'release_1_0'
input-file: v1.0/NewsSearch.json
```

Copy link
Member

@fearthecowboy fearthecowboy Nov 27, 2017

Choose a reason for hiding this comment

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

Add a section in the readme.md that looks like this:

## Suppressions 

Suppressing errors due to API design: 
``` yaml 
directive:
  - suppress: R3016
    reason: _type is a polymorphic discriminator that can't be changed. 
```

…#2)

Suppress _type error, fix 'OBJECT_ADDITIONAL_PROPERTIES'  error, add required parameters
@azuresdkciprbot
Copy link

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/cognitiveservices/data-plane/NewsSearch/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

@fearthecowboy fearthecowboy removed their assignment Dec 8, 2017
Update description and Remove some internal properties
@azuresdkciprbot
Copy link

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/cognitiveservices/data-plane/NewsSearch/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

"allOf": [
{
"$ref": "#/definitions/SearchResultsAnswer"
}
Copy link

Choose a reason for hiding this comment

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

Should this be readonly?

"allOf": [
{
"$ref": "#/definitions/SearchResultsAnswer"
}
Copy link

Choose a reason for hiding this comment

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

Please add descriptions to the individual properties.

"allOf": [
{
"$ref": "#/definitions/SearchResultsAnswer"
}
Copy link

Choose a reason for hiding this comment

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

Missing description.

"allOf": [
{
"$ref": "#/definitions/SearchResultsAnswer"
}
Copy link

Choose a reason for hiding this comment

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

Add readonly.

@alvadb alvadb merged commit 4794347 into Azure:current Dec 11, 2017
@AutorestCI
Copy link

No modification for AutorestCI/azure-sdk-for-ruby

@AutorestCI
Copy link

No modification for AutorestCI/azure-sdk-for-python

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.

6 participants