Update spec.md #333
Update spec.md #333
Conversation
Some improvements in the event serialized as JSON.
Signed-off-by: Fabio José <fabiojose@gmail.com>
|
@fabiojose please sign your commits |
spec.md
Outdated
|
|
||
| ## Using relative URI in `source` element | ||
|
|
||
| As defined in [RFC 3986, Section 4.2](https://tools.ietf.org/html/rfc3986#section-4.2) it is possible to use relative paths to express URI, but this require the apply of resolution algorithm [RFC 3986, Section 5](https://tools.ietf.org/html/rfc3986#section-5). |
There was a problem hiding this comment.
can you please wrap this at 80 columns to align with our other docs?
spec.md
Outdated
| @@ -290,3 +294,43 @@ The following example shows a CloudEvent serialized as JSON: | |||
| "data" : "<much wow=\"xml\"/>" | |||
| } | |||
| ``` | |||
|
|
|||
| Regarding the resolution algorithm, lets consider: | |||
There was a problem hiding this comment.
This section confuses me. It sounds a bit like text that should be in the main part of the spec, not in an example section, because its trying to explain how to resolve relative URIs - which feels like normative language. But, it's also just reiterating what RFC3986 says - so why do we need to repeat it?
Also, where is "base URI" coming from? We don't have that defined as part of the spec.
Perhaps it would help me if you could explain what you're trying to fix, or clarify, in the spec with this PR.
There was a problem hiding this comment.
The PR is based on the issue 332 opened by. The example of serialized JSON is not valid against the JSON Schema, because of source element value, which is /mycontext.
There was a problem hiding this comment.
Yup - but I think an easier solution is to just change the example to use a real URI or to make the type of "source" into a URI-reference. Getting into URI resolution seems unnecessary to me.
There was a problem hiding this comment.
I totally agree with you @duglin!
I will refactor the PR!
Signed-off-by: Fabio José <fabiojose@gmail.com>
|
Closing this to open another one with properly changes. |
Some improvements in the event serialized as JSON.
The proposed updates are based in the issue #332.