Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2ab1c21

Browse files
committedNov 27, 2017
Better wording in draft-04 to 07 hyper-schema
migration notes wording improvement.
1 parent 84d3ce2 commit 2ab1c21

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed
 

‎draft-07/json-hyper-schema-release-notes.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,19 @@ for information related to draft-05.
4343

4444
### Migrating from draft-04
4545

46-
For an overview of why the way `method` and `targetSchema` were typically used
47-
in draft-04 poses a challenge for migrating to more recent drafts, see
48-
the [draft-06 release notes](../draft-06/json-hyper-schema-migration-faq.html).
46+
In the ideal draft-07 world, links and
47+
[operations](http://json-schema.org/draft-07/json-schema-hypermedia.html#rfc.section.3.1)
48+
are not the same concept. Using terminology borrowed from
49+
[OpenAPI's Operation Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject), HTTP methods are operations, and each
50+
link (as described by a single LDO) can support multiple operations.
51+
52+
Therefore, unlike draft-04, draft-07 hyper-schemas
53+
[do not have separate links for each operation](json-schema-hypermedia.html#rfc.section.8.1). This makes the migration guidelines below approximate at best.
54+
55+
For a more detailed explanation of how draft-04's `method` and `targetSchema`
56+
were typically used to create single-operation links, and how that poses
57+
a challenge for migrating to multi-operation links, see the
58+
[draft-06 release notes](../draft-06/json-hyper-schema-migration-faq.html).
4959
Those release notes also explain what happened to the link relations defined
5060
in draft-04 and subsequently removed, and the changes in how the instance
5161
base URI is determined.
@@ -55,6 +65,7 @@ following lines, although the
5565
[intentional lack of explicit response descriptions](json-schema-hypermedia.html#rfc.appendix.A.2)
5666
(except when the response happens to be a representation of the target resource)
5767
means that some uses of draft-04 do not have direct analogues in draft-07.
68+
5869
Any keyword not mentioned in a list below is unchanged for that link operation.
5970

6071
#### GET

0 commit comments

Comments
 (0)
This repository has been archived.