Merge pull request json-api#1724 from json-api/avoid-using-kebab-case-in-example

jelhan · web-flow · commit c849103694b3 · 2023-12-07T07:46:58.000+08:00
avoid kebab-case case usage in example
diff --git a/recommendations/index.md b/recommendations/index.md
@@ -211,17 +211,17 @@ The request **SHOULD** return a status `202 Accepted` with a link in the `Conten
 ```http
 HTTP/1.1 202 Accepted
 Content-Type: application/vnd.api+json
-Content-Location: https://example.com/photos/queue-jobs/5234
+Content-Location: https://example.com/photos/jobs/5234
 
 {
   "data": {
-    "type": "queue-jobs",
+    "type": "jobs",
     "id": "5234",
     "attributes": {
       "status": "Pending request, waiting other process"
     },
     "links": {
-      "self": "/photos/queue-jobs/5234"
+      "self": "/photos/jobs/5234"
     }
   }
 }
@@ -230,7 +230,7 @@ Content-Location: https://example.com/photos/queue-jobs/5234
 To check the status of the job process, a client can send a request to the location given earlier.
 
 ```http
-GET /photos/queue-jobs/5234 HTTP/1.1
+GET /photos/jobs/5234 HTTP/1.1
 Accept: application/vnd.api+json
 ```
 
@@ -243,13 +243,13 @@ Retry-After: 10
 
 {
   "data": {
-    "type": "queue-jobs",
+    "type": "jobs",
     "id": "5234",
     "attributes": {
       "status": "Pending request, waiting other process"
     },
     "links": {
-      "self": "/photos/queue-jobs/5234"
+      "self": "/photos/jobs/5234"
     }
   }
 }

Original file line number	Diff line number	Diff line change
@@ -211,17 +211,17 @@ The request SHOULD return a status `202 Accepted` with a link in the `Conten
`211`	`211`	```http
`212`	`212`	`HTTP/1.1 202 Accepted`
`213`	`213`	`Content-Type: application/vnd.api+json`
`214`		`-Content-Location: https://example.com/photos/queue-jobs/5234`
	`214`	`+Content-Location: https://example.com/photos/jobs/5234`
`215`	`215`
`216`	`216`	`{`
`217`	`217`	`"data": {`
`218`		`- "type": "queue-jobs",`
	`218`	`+ "type": "jobs",`
`219`	`219`	`"id": "5234",`
`220`	`220`	`"attributes": {`
`221`	`221`	`"status": "Pending request, waiting other process"`
`222`	`222`	`},`
`223`	`223`	`"links": {`
`224`		`- "self": "/photos/queue-jobs/5234"`
	`224`	`+ "self": "/photos/jobs/5234"`
`225`	`225`	`}`
`226`	`226`	`}`
`227`	`227`	`}`
`@@ -230,7 +230,7 @@ Content-Location: https://example.com/photos/queue-jobs/5234`
`230`	`230`	`To check the status of the job process, a client can send a request to the location given earlier.`
`231`	`231`
`232`	`232`	```http
`233`		`-GET /photos/queue-jobs/5234 HTTP/1.1`
	`233`	`+GET /photos/jobs/5234 HTTP/1.1`
`234`	`234`	`Accept: application/vnd.api+json`
`235`	`235`	```
`236`	`236`
`@@ -243,13 +243,13 @@ Retry-After: 10`
`243`	`243`
`244`	`244`	`{`
`245`	`245`	`"data": {`
`246`		`- "type": "queue-jobs",`
	`246`	`+ "type": "jobs",`
`247`	`247`	`"id": "5234",`
`248`	`248`	`"attributes": {`
`249`	`249`	`"status": "Pending request, waiting other process"`
`250`	`250`	`},`
`251`	`251`	`"links": {`
`252`		`- "self": "/photos/queue-jobs/5234"`
	`252`	`+ "self": "/photos/jobs/5234"`
`253`	`253`	`}`
`254`	`254`	`}`
`255`	`255`	`}`