10000 Modify profile example to promote definining a single object instead … · roy-coder/json-api@cd908cc · GitHub
[go: up one dir, main page]

Skip to content

Commit cd908cc

Browse files
committed
Modify profile example to promote definining a single object instead of many members as attributes.
1 parent c96505e commit cd908cc

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

_format/1.1/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,10 @@ possible for profiles to conflict with other profiles. Therefore, it is the
162162
responsibility of implementors to ensure that they do not support conflicting
163163
profiles.
164164

165-
In the following example, a profile has specified that all timestamps use the
166-
[RFC 3339](https://tools.ietf.org/html/rfc3339) format and that all resource
167-
objects contain `created` and `modified` attributes. With such a profile
168-
applied, a response might appear as follows:
165+
In the following example, a profile has defined a `timestamps`
166+
[attribute][attributes] as an object that must contain both a `created` and
167+
`modified` member and that they must use the [RFC 3339](https://tools.ietf.org/html/rfc3339)
168+
format. With such a profile applied, a response might appear as follows:
169169

170170
```json
171171
HTTP/1.1 200 OK
@@ -177,8 +177,10 @@ Content-Type: application/vnd.api+json; profile="https://example.com/resource-ti
177177
"id": "1",
178178
"attributes": {
179179
"title": "Rails is Omakase",
180-
"created": "2020-07-21T12:09:00Z",
181-
"modified": "2020-07-30T10:19:01Z"
180+
"timestamps": {
181+
"created": "2020-07-21T12:09:00Z",
182+
"modified": "2020-07-30T10:19:01Z"
183+
}
182184
}
183185
}
184186
// ...

0 commit comments

Comments
 (0)
0