Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit 3ae4682

Browse files
committed
Correct some spelling/grammar mistakes
1 parent 6a81804 commit 3ae4682

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

draft-06/json-hyper-schema-migration-faq.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ While `"targetSchema"` did not change its meaning in either recent draft, it has
4444

4545
Due to draft-04 emphasizing individual HTTP methods as `"method"` values, many users interpreted `"targetSchema"` as a hint of the response to the method in `"method"`. This was never correct; all drafts define this keyword as describing the representation of the target resource, which appears as a response to HTTP GET, but may or may not appear in other responses.
4646

47-
Draft-06 clarfies this usage and provides guidance on its use with different HTTP methods. This includes using `"targetSchema"` as a request description for PUT and PATCH. With draft-04, many users used `"schema"` to describe PUT and PATCH requests which is not needed.
47+
Draft-06 clarifies this usage and provides guidance on its use with different HTTP methods. This includes using `"targetSchema"` as a request description for PUT and PATCH. With draft-04, many users used `"schema"` to describe PUT and PATCH requests which is not needed.
4848

4949
However, see also [#296](https://github.com/json-schema-org/json-schema-spec/issues/296) for a proposal for hinting at "Accept-Patch", which is needed to properly use `"targetSchema"` with HTTP PATCH.
5050

51-
### Q: What are key issues under consideraton for draft-07?
51+
### Q: What are key issues under consideration for draft-07?
5252

5353
There are a number of relatively concrete proposals, although it is unlikely that all will be resolved in draft-07
5454

@@ -112,6 +112,6 @@ A: Pick a proposal such as [`"allow"`](https://github.com/json-schema-org/json-s
112112

113113
### Q: If `"targetSchema"` is not the response, how do I describe responses?
114114

115-
A: You should have hyper-schemas for your various success and error responses, but connecting them to links is is more of a documentation question than a usage question: each response will indicate its own schema, so you don't need to know it in advance at runtime.
115+
A: You should have hyper-schemas for your various success and error responses, but connecting them to links is more of a documentation question than a usage question: each response will indicate its own schema, so you don't need to know it in advance at runtime.
116116

117-
There has never been a Hyper-Schema keyword to explicitly associate responses with operations such as HTTP methods. The use cases for this seem to be about generating API documentation, so this is most likely a candidate for a [JSON Schema API Documentation vocabluary](https://github.com/json-schema-org/json-schema-spec/issues/136).
117+
There has never been a Hyper-Schema keyword to explicitly associate responses with operations such as HTTP methods. The use cases for this seem to be about generating API documentation, so this is most likely a candidate for a [JSON Schema API Documentation vocabulary](https://github.com/json-schema-org/json-schema-spec/issues/136).

draft-06/json-schema-migration-faq.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ While not technically a change, the behavior of the `"uri"` format was not clear
4242

4343
When a relative path, fragment, or any other style of URI Reference (per RFC 3986) is allowable, use `"uri-reference"`.
4444

45-
Implementations offering a translation from draft-04 to draft-06 may want to offer an option to convert `"uri"` formats to `"uri-reference"`, although any such option should be disable by default for strict conformance.
45+
Implementations offering a translation from draft-04 to draft-06 may want to offer an option to convert `"uri"` formats to `"uri-reference"`, although any such option should be disabled by default for strict conformance.
4646

4747
### Q: What happened to draft-05?
4848

49-
The draft-05 core and validation specifications were intended to be more clear and readible rewrites of draft-04, to give us a strong base for draft-06 changes. Implementors should **not** implement or advertise support for "draft-05".
49+
The draft-05 core and validation specifications were intended to be more clear and readable rewrites of draft-04, to give us a strong base for draft-06 changes. Implementors should **not** implement or advertise support for "draft-05".
5050

5151
Implementations that supported "draft-05" by implementing proposals from right after the publication of draft-04 should either remove that support or give it a different name to avoid confusion.
5252

53-
### Q: What happened to all of the discussions around re-using schemas with `"additionalProperties"`?
53+
### Q: What happened to all the discussions around re-using schemas with `"additionalProperties"`?
5454

5555
There are several competing proposals for making the re-use of schemas that set `"additionalProperties"` to something other than `true`. Most people specifically care about the case where it is `false`, but the same behavior occurs with any non-`true` value.
5656

@@ -80,7 +80,7 @@ The difficulty is that if you attempt to do this:
8080
}
8181
```
8282

83-
validation will always fail for any non-empty object instance. `"additionalProperties"` only knows about immediately adjacent `"properties"` and `"patternProperties"`, in order to ensure that each subschema means the same thing whether it is being used with another subschema or on its own.
83+
Validation will always fail for any non-empty object instance. `"additionalProperties"` only knows about immediately adjacent `"properties"` and `"patternProperties"`, in order to ensure that each subschema means the same thing whether it is being used with another subschema or on its own.
8484

8585
So in this example, if the instance has a "bar" property, it will fail the first subschema because "bar" is not "foo". If it has a "foo" property, it will fail the second subschema because "foo" is not "bar". And any other property will fail both schemas.
8686

@@ -122,9 +122,9 @@ This will allow an object with either "foo" or "bar" or both, but will fail vali
122122

123123
It does require duplicating the names, and the awkward use of both an `"allOf"` and `"anyOf"`, but it is less repetition than other options, and can be re-used fairly robustly even if the "foo" and "bar" schemas are in separate files managed by a different person or organization.
124124

125-
_*TODO:* Link to all of the discussions about other use cases and proposed solutions._
125+
_*TODO:* Link to all the discussions about other use cases and proposed solutions._
126126

127-
### Q: What are key issues under consideraton for draft-07?
127+
### Q: What are key issues under consideration for draft-07?
128128

129129
We are just starting to consider what to prioritize for the next draft.
130130

0 commit comments

Comments
 (0)