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

docs: update form support for BDCT #314

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ See [Keyword Support](/docs/bi-directional-contract-testing/contracts/oas/keywor
|--- |--- |--- |--- |
|JSON|Y|Full support|[Example](https://github.com/pactflow/bdct-oas-examples/)|
|XML|P|We don’t currently supported parsing and checking XML bodies, against defined schemas. Checks the content-type matches.|[Example](https://github.com/pactflow/bdct-oas-examples/tree/main/examples/xml)|
|`x-www-form-urlencoded` Request Bodies|N|We don’t currently supported parsing and checking URL encoded form bodies, against defined schemas. Checks the content-type matches.|[Example](https://github.com/pactflow/bdct-oas-examples/tree/main/examples/forms)|
|`x-www-form-urlencoded` Request Bodies|Y|Checks the body and request metadata matches the schema.|[Example](https://github.com/pactflow/bdct-oas-examples/tree/main/examples/forms)|

Choose a reason for hiding this comment

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

I'd change it to "Verifies if the body and request metadata match the schema." The subject is compound (it refers to two things: the body and the metadata). A compound subject is treated as plural, so the verb should agree in the plural form.

Copy link
Contributor

Choose a reason for hiding this comment

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

What "request metadata" are you referring to? Isn't "Checks the body matches the schema" sufficient?

Choose a reason for hiding this comment

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

If the "request" and "metadata" words are not specifically important in this context, then we can change the sentence to "Checks if the body matches the schema."

|`multipart/form-data`|N|We don’t currently supported parsing and checking multipart request bodies, against defined schemas. Checks the content-type matches.|[Example](https://github.com/pactflow/bdct-oas-examples/tree/main/examples/forms)|

#### [Security Schemes](https://spec.openapis.org/oas/v3.1.0#security-scheme-object)
Expand Down