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

Introducing Swagger in Dredd #529

Merged
merged 5 commits into from
Jun 15, 2016
Merged

Introducing Swagger in Dredd #529

merged 5 commits into from
Jun 15, 2016

Conversation

honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Jun 14, 2016


#### Swagger

1. [`response.schema`](http://swagger.io/specification/#responseSchema) - provided JSON Schema will be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think response.examples is given preference.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

when checking validity of response? I think it shouldn't

Also addressing:

- a bit of #353
- closes #496
- closes #389
@@ -20,6 +19,11 @@ Dredd reads your API description and step by step validates whether your API
implementation replies with responses as they are described in the
documentation.

## API Description Formats Support
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "Supported API Description formats" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 5e5c81b.

@@ -2,7 +2,7 @@

This is an example how to create a simple [Express.js][] API backend application tested with Dredd

## Create API Description File
## Create an API Description Document
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the article correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 5e5c81b.

### Response Headers Expectations

- All headers specified in the API description must be present in the response.
- Names of headers are validated in case-insensitive way.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "validated >the< case-insensitive way" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 5e5c81b.

@honzajavorek
Copy link
Contributor Author

@netmilk All comments addressed. Good to merge?

@netmilk netmilk merged commit fec1c0e into master Jun 15, 2016
@honzajavorek honzajavorek deleted the honzajavorek/swagger-docs branch June 15, 2016 14:55
@honzajavorek
Copy link
Contributor Author

❤️

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.

Document how request bodies and response body expectations are evaluated Swagger 2.0 / OAI support
3 participants