-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathrfc9264-AUTH48-response.xml
1736 lines (1545 loc) · 92.4 KB
/
rfc9264-AUTH48-response.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rfc [
<!ENTITY nbsp " ">
<!ENTITY zwsp "​">
<!ENTITY nbhy "‑">
<!ENTITY wj "⁠">
]>
<rfc ipr="trust200902" docName="draft-ietf-httpapi-linkset-10" number="9264" submissionType="IETF" category="std" consensus="true" tocInclude="true" symRefs="true" sortRefs="true" updates="" obsoletes="" xml:lang="en" version="3" xmlns:xi="http://www.w3.org/2001/XInclude">
<front>
<title abbrev="Linkset">Linkset: Media Types and a Link Relation Type for Link Sets</title>
<seriesInfo name="RFC" value="9264"/>
<author initials="E." surname="Wilde" fullname="Erik Wilde">
<organization>Axway</organization>
<address>
<email>erik.wilde@dret.net</email>
</address>
</author>
<author initials="H." surname="Van de Sompel" fullname="Herbert Van de Sompel">
<organization>Data Archiving and Networked Services</organization>
<address>
<email>herbert.van.de.sompel@dans.knaw.nl</email>
<uri>https://orcid.org/0000-0002-0715-6126</uri>
</address>
</author>
<!-- [rfced] Authors' Addresses: We try to avoid using "http://"
in RFCs unless they are used as specific examples of non-secure HTTP.
Changing "http://dret.net/netdret/" to "https://dret.net/netdret/"
yields "Warning: Potential Security Risk Ahead" (Firefox) or "This
Connection Is Not Private" (Safari). It appears that the requested
domain name does not match the server's certificate. Should this URL
be updated to use "https://"?
Original:
URI: http://dret.net/netdret/
Response:
Removed the URI from the author address. -->
<date month="July" year="2022"/>
<area>art</area>
<workgroup>httpapi</workgroup>
<!-- [rfced] Please provide any keywords (beyond those that appear in the
title) for use on <https://www.rfc-editor.org/search>.
Response:
Web linking, Typed links, JSON, HTTP -->
<abstract>
<t>This specification defines two formats and associated media types for representing sets of links as standalone documents. One format is based on JSON, and the other is aligned with the format for representing links in the HTTP "Link" header field. This specification also introduces a link relation type to support the discovery of sets of links.</t>
</abstract>
</front>
<middle>
<section anchor="introduction" numbered="true" toc="default">
<name>Introduction</name>
<t>Resources on the Web often use typed Web Links <xref target="RFC8288"/>, either (1) embedded in resource representations -- for example, using the <link> element for HTML documents or (2) conveyed in the HTTP "Link" header field for documents of any media type. In some cases, however, providing links in this manner is impractical or impossible, and delivering a set of links as a standalone document is preferable.</t>
<t>Therefore, this specification defines two formats for representing sets of Web Links and their attributes as standalone documents. One serializes links in the same format as the format used in the HTTP "Link" header field, and the other serializes links in JSON. It also defines associated media types to represent sets of links, and the "linkset" relation type to support the discovery of any resource that conveys a set of links as a standalone document.</t>
<!-- [rfced] Sections 1 and subsequent: There are eight instances of
'"linkset" relation type' in running text in this document, but only
the last instance (in Appendix A) uses the "<tt>" element to set it
off with a different font in the .html and .pdf outputs. For
consistency of style, would you like to use "<tt>" around the other
seven instances?
Response:
We removed <tt> from the one instance in Appendix A and now it's
consistent throughout the text. -->
</section>
<section anchor="terminology" numbered="true" toc="default">
<name>Terminology</name>
<t>The key words "<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>",
"<bcp14>REQUIRED</bcp14>", "<bcp14>SHALL</bcp14>",
"<bcp14>SHALL NOT</bcp14>", "<bcp14>SHOULD</bcp14>",
"<bcp14>SHOULD NOT</bcp14>",
"<bcp14>RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>",
"<bcp14>MAY</bcp14>", and "<bcp14>OPTIONAL</bcp14>" in this document
are to be interpreted as described in BCP 14
<xref target="RFC2119"/> <xref target="RFC8174"/> when, and only
when, they appear in all capitals, as shown here.</t>
<t>This specification uses the terms "link context" and "link target" in the same manner that
<xref target="RFC8288">"Web Linking"</xref> uses them.</t>
<t>In the examples provided in this document, links in the HTTP "Link" header field are shown on separate lines in order to improve readability.
Note, however, that as per
<xref target="RFC9110" section="5.5">"HTTP Semantics"</xref>, line breaks are deprecated in values for HTTP fields; only whitespaces and
tabs are supported as separators.</t>
</section>
<section anchor="use-cases" numbered="true" toc="default">
<name>Use Cases and Motivation</name>
<t>The following sections describe use cases in which providing links by means of a standalone document instead of in an HTTP "Link" header field or as links embedded in the resource representation is advantageous or necessary.</t>
<t>For all scenarios, links could be provided by means of a standalone document that is formatted according to the JSON-based serialization, the serialization aligned with the HTTP "Link" field format, or both. The former serialization is motivated by the widespread use of JSON and related tools, which suggests that handling sets of links expressed as JSON documents should be attractive to developers. The latter serialization is provided for compatibility with the existing serialization used in the HTTP "Link" field and to allow the reuse of tools created to handle it.</t>
<t>It is important to keep in mind that when providing links by means of a standalone representation, other links can still be provided using other approaches, i.e., it is possible to combine various mechanisms to convey links.</t>
<section anchor="third-party" numbered="true" toc="default">
<name>Third-Party Links</name>
<t>In some cases, it is useful that links pertaining to a resource are provided
by a server other than the one that hosts the resource. For example, this allows:</t>
<ul>
<li>Providing links in which the resource is involved not just as a link context but
also as a link target, with a different resource being the link context.</li>
<li>Providing links pertaining to the resource that the server hosting that
resource is not aware of.</li>
<li>External management of links pertaining to the resource in a special-purpose link
management service.</li>
</ul>
<t>In such cases, links pertaining to a resource can be provided by another, specific resource.
That specific resource may be managed, by the same custodian or by another custodian, as the resource to which the links pertain.
For clients intent on consuming links provided in that manner, it would be beneficial if the following conditions were met:</t>
<ul>
<li>Links are provided in a document that uses a well-defined media type.</li>
<li>The resource to which the provided links pertain is able to link to the resource that provides these links using a well-known
link relation type.</li>
</ul>
<t>These requirements are addressed in this specification through the definition of two media types and a link relation type, respectively.</t>
</section>
<section anchor="header-writing" numbered="true" toc="default">
<name>Challenges Writing to the HTTP "Link" Header Field</name>
<t>In some cases, it is not straightforward to write links to the HTTP "Link" header field
from an application. This can, for example, be the case because not all
required link information is available to the application or because the
application does not have the capability to directly write HTTP fields.
In such cases, providing links by means of a standalone document can be a solution.
Making the resource that provides these links discoverable can be achieved by means of a
typed link.</t>
</section>
<section anchor="link-volume" numbered="true" toc="default">
<name>Large Number of Links</name>
<t>When conveying links in an HTTP "Link" header field, it is possible for the size of the HTTP
response fields to become unpredictable. This can be the case when links are determined
dynamically in a manner dependent on a range of contextual factors. It is possible to statically configure
a web server to correctly handle large HTTP response fields by specifying an upper bound
for their size. But when the number of links is
unpredictable, estimating a reliable upper bound is challenging.</t>
<t><xref target="RFC9110" section="15">"HTTP Semantics"</xref> defines error codes related to excess communication
by the user agent ("413 Content Too Large" and "414 URI Too Long"), but no specific
error codes are defined to indicate that response field content exceeds the upper bound that can
be handled by the server and thus has been truncated.
As a result, applications take countermeasures aimed at controlling
the size of the HTTP "Link" header field -- for example, by limiting the links they provide to those
with select relation types, thereby limiting the value of the HTTP "Link" header field to clients.
Providing links by means of a standalone document overcomes challenges related to the unpredictable
(to the web server implementation) nature of the size of HTTP "Link" header fields.</t>
<!-- [rfced] Section 3.3: Section 15 of RFC 9110 (the published
version of draft-ietf-httpbis-semantics) uses different wording for
error codes 413 and 414 - "413 (Content Too Large)" and "414 (URI
Too Long)", respectively. We have updated the following to match.
Original:
Section 15 of HTTP [I-D.ietf-httpbis-semantics] defines error codes
related to excess communication by the user agent ("413 Request
Entity Too Large" and "414 Request-URI Too Long"), but no specific
error codes are defined to indicate that response field content
exceeds the upper bound that can be handled by the server and thus
has been truncated.
Current:
Section 15 of "HTTP Semantics" [RFC9110] defines error codes related
to excess communication by the user agent ("413 Content Too Large"
and "414 URI Too Long"), but no specific error codes are defined to
indicate that response field content exceeds the upper bound that can
be handled by the server and thus has been truncated.
Response:
We accept this change. Thanks.
-->
</section>
</section>
<section anchor="linkset-formats" numbered="true" toc="default">
<name>Document Formats for Sets of Links</name>
<t>This section specifies two document formats to convey a set of links. Both are based on the abstract model specified in
<xref target="RFC8288" section="2">"Web Linking"</xref>,
which defines a link as consisting of a "link context", a "link relation type", a "link target",
and optional "target attributes":</t>
<ul>
<li>The format defined in <xref target="linkset-native"/> is nearly identical to the field value
of the HTTP "Link" header field as specified in <xref target="RFC8288" section="3"/>.</li>
<li>The format defined in <xref target="linkset-json"/> is expressed in <xref target="RFC8259">JSON</xref>.</li>
</ul>
<t>Links provided in the HTTP "Link" header field are intended to be used in the context of an HTTP interaction, and contextual information
that is available during an interaction is used to correctly interpret them.
Links provided in link sets, however, can be reused outside of an HTTP interaction, when no such contextual information is available.
As a result, implementers of link sets should strive to make them self-contained by adhering to the following recommendations.</t>
<t>For links provided in the HTTP "Link" header field that have no anchor or that use relative references,
the URI of the resource that delivers the links provides the contextual information that is needed for their
correct interpretation. In order to support use cases where link set documents are reused outside the context
of an HTTP interaction, it is <bcp14>RECOMMENDED</bcp14> to make them self-contained by adhering to the following guidelines:</t>
<ul>
<li>For every link provided in the set of links, explicitly provide the link context
using the "anchor" attribute.</li>
<li>For the link context ("anchor" attribute) and link target ("href" attribute), use URI references that are not relative references (as defined in <xref target="RFC3986" section="4.1"/>).
</li>
</ul>
<t>If these recommendations are not followed, the interpretation of links in link set documents will depend on which URI is used as the context.</t>
<t>For a "title" attribute provided on a link in the HTTP "Link" header field, the language in which the title is expressed is provided by
the "Content-Language" header field of the HTTP interaction with the resource that delivers the links.
This does not apply to "title" attributes provided for links in link set documents because that would constrain
all links in a link set to having a single title language and would not support determining title languages when
a link set is used outside of an HTTP interaction. In order to support use cases where link set documents are
reused outside the context of an HTTP interaction, it is <bcp14>RECOMMENDED</bcp14> to make them self-contained by using the
"title*" attribute instead of the "title" attribute because "title*" allows expressing the title language as part of its value by means of a language tag.
Note that, in this regard, language tags are matched case insensitively (see <xref target="RFC5646" section="2.1.1"/>).
If this recommendation is not followed, accurately determining the language of titles provided on links in link set documents will not be possible.</t>
<t>Note also that <xref target="RFC8288" section="3.3"/> deprecates the "rev" construct that was provided by <xref target="RFC5988"/> as a means to express links with a directionality that is the inverse of direct links that use the "rel" construct. In both serializations for link sets defined here, inverse links may be represented as direct links using the "rel" construct and by switching the roles of the resources involved in the link.</t>
<section anchor="linkset-native" numbered="true" toc="default">
<name>HTTP Link Document Format: application/linkset</name>
<t>This document format is nearly identical to the field value of the
HTTP "Link" header field as defined in
<xref target="RFC8288" section="3"/>, more specifically by
its ABNF <xref target="RFC5234"/> production rule for "Link" and subsequent ones. It differs from the format for field values of the
HTTP "Link" header field only in that not only spaces and horizontal tabs are allowed as separators but also newline
characters as a means to improve readability for humans.
The use of non-ASCII characters in the field value of the HTTP "Link" header field is not allowed
and as such is also not allowed in "application/linkset" link sets.</t>
<!-- [rfced] Section 4.1: In the following, does "ones" refer to subsequent ABNF rules?
Original:
This document format is nearly identical to the field value of the
HTTP "Link" header field as defined in Section 3 of [RFC8288], more
specifically by its ABNF [RFC5234] production rule for "Link" and
subsequent ones.
Perhaps:
This document format is nearly identical to the field value of the
HTTP "Link" header field as defined in Section 3 of [RFC8288], more
specifically by its ABNF [RFC5234] production rule for "Link" and
its subsequent rules.
Response:
We accept this change. Thanks.
-->
<t>The assigned media type for this format is "application/linkset".</t>
<t>When converting an "application/linkset" document to a field value for the
HTTP "Link" header field, newline characters <bcp14>MUST</bcp14> be removed or <bcp14>MUST</bcp14> be replaced by whitespace (SP) in order to comply with
<xref target="RFC9110" section="5.5"/>.</t>
<t>Implementers of "application/linkset" link sets should strive to make them self-contained
by following the recommendations provided in <xref target="linkset-formats"/> regarding their use outside the context of an HTTP interaction.</t>
<t>It should be noted that the "application/linkset" format specified here is different from the "application/link-format"
format specified in <xref target="RFC6690"/> in that the former fully matches the
field value of the HTTP "Link" header field as defined in <xref target="RFC8288" section="3"/>, whereas
the latter introduces constraints on that definition to meet requirements for Constrained RESTful Environments (CoRE).</t>
</section>
<section anchor="linkset-json" numbered="true" toc="default">
<name>JSON Document Format: application/linkset+json</name>
<t>This document format uses JSON <xref target="RFC8259"/> as the syntax to represent
a set of links. The set of links follows the abstract model defined by <xref target="RFC8288" section="2"/>.</t>
<t>The assigned media type for this format is "application/linkset+json".</t>
<t>In the interests of interoperability, "application/linkset+json" link sets <bcp14>MUST</bcp14> be encoded using UTF-8 as per
<xref target="RFC8259" section="8.1"/>.</t>
<t>Implementers of "application/linkset+json" link sets should strive to make them self-contained
by following the recommendations provided in <xref target="linkset-formats"/> regarding their use outside the context of an HTTP interaction.</t>
<t>The "application/linkset+json" serialization allows for <bcp14>OPTIONAL</bcp14> support of a JSON-LD serialization.
This can be achieved by adding an appropriate context to the "application/linkset+json" serialization using the approach described in
<xref target="W3C.REC-json-ld" section="6.1" relative="#interpreting-json-as-json-ld"/>.
Communities of practice can decide which context best meets their application needs.
<xref target="appendix-1"/> shows an example of a possible context that, when added to a JSON serialization,
allows it to be interpreted as Resource Description Framework (RDF) data <xref target="W3C.REC-rdf11-concepts"/>.</t>
<section anchor="linkset-in-json" numbered="true" toc="default">
<name>Set of Links</name>
<t>In the JSON representation of a set of links:</t>
<ul>
<li>A set of links is represented in JSON as an object that <bcp14>MUST</bcp14> contain "linkset" as its sole member.</li>
<li>The value of the "linkset" member is an array in which a distinct JSON object --
the "link context object" (see <xref target="linkset-json-link-context-object"/>) --
is used to represent links that have the same link context.</li>
<li>Even if there is only one link context object, it <bcp14>MUST</bcp14> be wrapped in an array.</li>
</ul>
</section>
<section anchor="linkset-json-link-context-object" numbered="true" toc="default">
<name>Link Context Object</name>
<t>In the JSON representation, one or more links that have the same link context
are represented by a JSON object -- the link context object. A link context object
adheres to the following rules:</t>
<ul>
<li>Each link context object <bcp14>MAY</bcp14> contain an "anchor" member with a value that represents
the link context. If present, this value <bcp14>MUST</bcp14> be a URI reference
and <bcp14>SHOULD NOT</bcp14> be a relative reference as defined in <xref target="RFC3986" section="4.1"/>.</li>
<li><t>
For each distinct relation type that the link context has with link targets,
a link context object <bcp14>MUST</bcp14> contain an additional member.
The value of this member is an array in which a distinct JSON object
-- the "link target object" (see <xref target="linkset-json-link-target-object"/>) --
<bcp14>MUST</bcp14> be used for each link target for which the relationship with
the link context (value of the encompassing "anchor" member) applies. The name
of this member expresses the relation type of the link as follows:</t>
<ul>
<li>For registered relation types (<xref target="RFC8288" section="2.1.1"/>),
the name of this member is the registered name of the relation type.</li>
<li>For extension relation types (<xref target="RFC8288" section="2.1.2"/>),
the name of this member is the URI that uniquely represents the relation type.</li>
</ul></li>
<li>Even if there is only one link target object, it <bcp14>MUST</bcp14> be wrapped in an array.</li>
</ul>
</section>
<section anchor="linkset-json-link-target-object" numbered="true" toc="default">
<name>Link Target Object</name>
<t>In the JSON representation, a link target is represented by a JSON object -- the link target object.
A link target object adheres to the following rules:</t>
<ul>
<li>Each link target object <bcp14>MUST</bcp14> contain an "href" member with a value that represents
the link target. This value <bcp14>MUST</bcp14> be a URI reference and <bcp14>SHOULD NOT</bcp14> be a relative reference
as defined in <xref target="RFC3986" section="4.1"/>. Cases where the "href" member is present but no value is provided
for it (i.e., the resource providing the set of links is the target of the link
in the link target object) <bcp14>MUST</bcp14> be handled by providing an "href" member with an empty string as its value ("href": "").</li>
<li>In many cases, a link target is further qualified by target attributes.
Various types of attributes exist, and they are conveyed as additional members of the link target object
as detailed in <xref target="json-target-attributes"/>.</li>
</ul>
<t>The following example of a JSON-serialized set of links represents one
link with its core components: link context, link relation
type, and link target.</t>
<figure>
<name>Simple linkset example</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"next": [
{"href": "https://example.com/foo"}
]
}
]
}]]>
</sourcecode>
</figure>
<!-- [rfced] As Figures 7 through 21 have titles, would you like to
provide titles for Figures 1 through 6? If yes, please specify.
Original:
Figure 1
Figure 2
Figure 3
Figure 4
Figure 5
Figure 6
Figure 7: Client HTTP GET request
Figure 8: Response to HTTP GET includes a set of links
etc.
Response:
We added titles to Figure 1 through Figure 6. We also adjusted all
figure titles to use sentence case instead of title case. -->
<t>The following example of a JSON-serialized set of links represents two links
that share a link context and relation type but have different link targets.</t>
<figure>
<name>Linkset with two links with the same context</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"item": [
{"href": "https://example.com/foo1"},
{"href": "https://example.com/foo2"}
]
}
]
}]]>
</sourcecode>
</figure>
<t>The following example shows a set of links that represents two links, each with
a different link context, link target, and relation type.
One relation type is registered, and the other is an extension relation type.</t>
<figure>
<name>Linkset with two links with different contexts</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"next": [
{"href": "https://example.com/foo1"}
]
},
{ "anchor": "https://example.net/boo",
"https://example.com/relations/baz" : [
{"href": "https://example.com/foo2"}
]
}
]
}]]>
</sourcecode>
</figure>
</section>
<section anchor="json-target-attributes" numbered="true" toc="default">
<name>Link Target Attributes</name>
<t>A link may be further qualified by target attributes as defined by <xref target="RFC8288" section="2"/>.
Three types of attributes exist:</t>
<ul>
<li>Serialization-defined attributes as described in <xref target="RFC8288" section="3.4.1"></xref>.</li>
<li>Extension attributes defined and used by communities as allowed by
<xref target="RFC8288" section="3.4.2"/>.</li>
<li>Internationalized versions of the "title" attribute as defined by <xref target="RFC8288"/> and of extension attributes
allowed by <xref target="RFC8288" section="3.4"/>.</li>
</ul>
<t>The handling of these different types of attributes is described in the sections below.</t>
<section anchor="json-target-attributes-existing" numbered="true" toc="default">
<name>Target Attributes Defined by Web Linking</name>
<t><xref target="RFC8288" section="3.4.1"/> defines the following target attributes that may be used to annotate links:
"hreflang", "media", "title", "title*", and "type";
these target attributes follow different occurrence and value patterns.
In the JSON representation, these attributes <bcp14>MUST</bcp14> be conveyed as additional
members of the link target object as follows:</t>
<dl spacing="normal">
<dt>"hreflang":</dt><dd>The "hreflang" target attribute,
defined as optional and repeatable by <xref target="RFC8288"/>,
<bcp14>MUST</bcp14> be represented by an "hreflang" member, its value <bcp14>MUST</bcp14> be an array (even if there is only one value to be represented),
and each value in that array <bcp14>MUST</bcp14> be a string -- representing one value
of the "hreflang" target attribute for a link -- that follows the same
model as the syntax discussed in <xref target="RFC8288"/>.</dd>
<dt>"media":</dt><dd>The "media" target attribute,
defined as optional and not repeatable by <xref target="RFC8288"/>, <bcp14>MUST</bcp14> be
represented by a "media" member
in the link target object, and its value <bcp14>MUST</bcp14> be a string that follows the
same model as the syntax discussed in <xref target="RFC8288"/>.</dd>
<dt>"title":</dt><dd>The "title" target attribute,
defined as optional and not repeatable by <xref target="RFC8288"/>,
<bcp14>MUST</bcp14> be represented by a "title"
member in the link target object, and its value <bcp14>MUST</bcp14> be a JSON string.</dd>
<dt>"title*":</dt><dd>The "title*" target attribute,
defined as optional and not repeatable by <xref target="RFC8288"/>,
is motivated by character encoding
and language issues and follows the model defined in <xref target="RFC8187"/>.
The details of the JSON
representation that applies to "title*" are described in
<xref target="linkset-json-i18n-link-parameter"/>.
</dd>
<dt>"type":</dt><dd>The "type" target attribute,
defined as optional and not repeatable by <xref target="RFC8288"/>,
<bcp14>MUST</bcp14> be represented by a "type" member
in the link target object, and its value <bcp14>MUST</bcp14> be a string that follows the
same model as the syntax discussed in <xref target="RFC8288"/>.</dd>
</dl>
<t>The following example illustrates how the "hreflang" (repeatable) target attribute and the "type" (not repeatable) target attribute are represented in a link target object.</t>
<figure>
<name>Linkset with "hreflang" and "type" target attributes</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"next": [
{ "href": "https://example.com/foo",
"type": "text/html",
"hreflang": [ "en" , "de" ]
}
]
}
]
}]]>
</sourcecode>
</figure>
</section>
<section anchor="linkset-json-i18n-link-parameter" numbered="true" toc="default">
<name>Internationalized Target Attributes</name>
<t>In addition to the target attributes described in <xref target="json-target-attributes-existing"/>,
<xref target="RFC8288" section="3.4"/> also supports
attributes that follow the content model of <xref target="RFC8187"/>.
In <xref target="RFC8288"/>, these target
attributes are recognizable by the use of a trailing asterisk in the attribute name,
such as "title*".
The content model of <xref target="RFC8187"/> uses a string-based microsyntax
that represents the character encoding, an optional language tag,
and the escaped attribute value encoded according to the specified character encoding.</t>
<t>The JSON serialization for these target attributes <bcp14>MUST</bcp14> be
as follows:</t>
<ul>
<li>An internationalized target attribute is represented as a member of the link context object with
the same name (including the "*") as the attribute.</li>
<li>The character encoding information
as prescribed by <xref target="RFC8187"/> is not preserved; instead, the
content of the internationalized attribute is represented as a JSON string.</li>
<li>The value of the internationalized target attribute is an
array that contains one or more JSON objects. The name of one member
of such JSON objects is "value",
and its value is the actual content (in its unescaped version) of the internationalized target attribute, i.e., the
value of the attribute from which
the encoding and language information are removed.
The name of another, optional member of such JSON objects is "language", and
its value is the language tag <xref target="RFC5646"/>
for the language in which the attribute content is conveyed.
</li>
</ul>
<t>The following example illustrates how the "title*" target attribute as
defined by <xref target="RFC8288" section="3.4.1"/> is represented in a link target object.</t>
<figure>
<name>Linkset with "title" and "title*" target attributes</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"next": [
{ "href": "https://example.com/foo",
"type": "text/html",
"hreflang": [ "en" , "de" ],
"title": "Next chapter",
"title*": [ { "value": "nächstes Kapitel" ,
"language" : "de" } ]
}
]
}
]
}]]>
</sourcecode>
</figure>
<t>The above example assumes that the German title contains an umlaut character (in the original syntax, it would be encoded as title*=UTF-8'de'n%c3%a4chstes%20Kapitel),
which gets encoded in its unescaped form in the JSON representation.
Implementations <bcp14>MUST</bcp14> properly decode/encode internationalized target attributes that follow the model of <xref target="RFC8187"/> when transcoding between the "application/linkset" format and the "application/linkset+json" format.</t>
</section>
<section anchor="json-target-attributes-extension" numbered="true" toc="default">
<name>Extension Target Attributes</name>
<t>Extension target attributes (e.g., as listed in <xref
target="json-target-attributes-existing"/>) are attributes that are not defined by <xref target="RFC8288" section="3.4.1"/> but are nevertheless
used to qualify links.
They can be defined by communities in any way deemed necessary, and it is up to them
to make sure their usage is understood by target applications.
However, lacking standardization, there is no interoperable
understanding of these extension attributes. One important consequence is that
their cardinality is unknown to generic applications. Therefore, in the JSON serialization,
all extension target attributes are treated as repeatable.</t>
<t>The JSON serialization for these target attributes <bcp14>MUST</bcp14> be
as follows:</t>
<ul>
<li>An extension target attribute is represented as a member of the link target object with the same name as the attribute, including the "*" if applicable.</li>
<li>The value of an extension attribute <bcp14>MUST</bcp14> be represented by an array, even if there is only one value to be represented.</li>
<li>If the extension target attribute does not have a name with a trailing asterisk,
then each value in that array <bcp14>MUST</bcp14> be a JSON string that represents one value
of the attribute.</li>
<li>If the extension attribute has a name with a trailing asterisk
(it follows the content model of <xref target="RFC8187"/>),
then each value in that array <bcp14>MUST</bcp14> be a JSON object. The value of each such JSON object
<bcp14>MUST</bcp14> be structured as described in <xref target="linkset-json-i18n-link-parameter"/>.</li>
</ul>
<t>The following example shows a link target object with three extension target attributes. The value for each extension target attribute is an array. The first two are regular extension target attributes, with the first one ("foo") having only one value and the second one ("bar") having two.
The last extension target attribute ("baz*") follows the naming rule of <xref target="RFC8187"/> and therefore is encoded according to the serialization described in <xref target="linkset-json-i18n-link-parameter"/>.</t>
<figure>
<name>Linkset with extension target attributes</name>
<sourcecode type="json"><![CDATA[
{ "linkset":
[
{ "anchor": "https://example.net/bar",
"next": [
{ "href": "https://example.com/foo",
"type": "text/html",
"foo": [ "foovalue" ],
"bar": [ "barone", "bartwo" ],
"baz*": [ { "value": "bazvalue" ,
"language" : "en" } ]
}
]
}
]
}]]>
</sourcecode>
</figure>
</section>
</section>
<section anchor="json-extensibility" numbered="true" toc="default">
<name>JSON Extensibility</name>
<t>The Web Linking model <xref target="RFC8288"/> provides for the use of extension target attributes as discussed in
<xref target="json-target-attributes-extension"/>.
The use of other forms of extensions is <bcp14>NOT RECOMMENDED</bcp14>.
Limiting the JSON format in this way allows unambiguous round trips between links provided in the HTTP "Link" header field,
sets of links serialized according to the "application/linkset" format, and sets of links serialized
according to the "application/linkset+json" format.
</t>
<!-- [rfced] Section 4.2.5: "allows to" does not parse. We updated
this sentence as follows. If this does not preserve your intended
meaning, please provide clarifying text.
Original:
Limiting the JSON format in
this way allows to unambiguously round trip between links provided in
the HTTP "Link" header field, sets of links serialized according to
the "application/linkset" format, and sets of links serialized
according to the "application/linkset+json" format.
Currently:
Limiting the JSON format in
this way allows unambiguous round trips between links provided in the
HTTP "Link" header field, sets of links serialized according to the
"application/linkset" format, and sets of links serialized according
to the "application/linkset+json" format.
Response:
We accept the change. Thanks. -->
<t>Cases may exist in which the use of extensions other than those discussed in <xref target="json-target-attributes-extension"/> may be useful --
for example, when a link set publisher needs to include descriptive or technical metadata for internal consumption.
If such extensions are used, they <bcp14>MUST NOT</bcp14> change the semantics of the JSON members defined in this specification.
Agents that consume JSON linkset documents can safely ignore such extensions.</t>
</section>
</section>
</section>
<section anchor="profile-attribute" numbered="true" toc="default">
<name>The "profile" Parameter for Media Types to Represent Sets of Links</name>
<t>As a means to convey specific constraints or conventions (as per <xref target="RFC6906"/>) that apply to a link set document,
the "profile" parameter <bcp14>MAY</bcp14> be used in conjunction with the media types "application/linkset" and
"application/linkset+json" as detailed in
Sections <xref target="linkset-native" format="counter"/> and <xref target="linkset-json" format="counter"/>, respectively.
For example, the parameter could be used to indicate that a link set uses a specific, limited set of link relation
types.</t>
<t>The value of the "profile" parameter <bcp14>MUST</bcp14> be a non-empty list of space-separated URIs,
each of which identifies specific constraints or conventions that apply to the link set document. When providing multiple
profile URIs, care should be taken that the corresponding profiles are not conflicting.
Profile URIs <bcp14>MAY</bcp14> be registered in the IANA's "Profile URIs" registry in the manner specified by <xref target="RFC7284"/>.</t>
<t>The presence of a "profile" parameter in conjunction with the "application/linkset" and
"application/linkset+json" media types does not change the semantics of
a link set. As such, clients with and without knowledge of profile URIs can use the same representation.</t>
<t><xref target="profile-parameter-example"/> shows an example of using the "profile" parameter in conjunction with the
"application/linkset+json" media type.</t>
</section>
<section anchor="linkset-link-relation" numbered="true" toc="default">
<name>The "linkset" Relation Type for Linking to a Set of Links</name>
<t>The target of a link with the "linkset" relation type provides a set of links,
including links in which the resource that is the link context participates.</t>
<t>A link with the "linkset" relation type <bcp14>MAY</bcp14> be provided in the header field and/or
the body of a resource's representation. It may also be discovered by other means, such as through
client-side information.</t>
<t>A resource <bcp14>MAY</bcp14> provide more than one link with a "linkset" relation type.
Multiple such links can refer to the same set of links expressed using different
media types, or to different sets of links, potentially provided by different third-party services.</t>
<t>The set of links provided by the resource that is the target of a "linkset" link may contain links in which the
resource that is the context of the "linkset" link does not participate. User agents <bcp14>MUST</bcp14> process each link
in the link set independently, including processing of the link context and link target, and <bcp14>MAY</bcp14> ignore links from
the link set in which the context of the "linkset" link does not participate.</t>
<t>A user agent that follows a "linkset" link and obtains links for which anchors and targets are expressed as
relative references (as per <xref target="RFC3986" section="4.1"/>) <bcp14>MUST</bcp14> determine what the context is for these links; it <bcp14>SHOULD</bcp14> ignore links for which it is unable to
unambiguously make that determination.</t>
<t>As a means to convey specific constraints or conventions (as per <xref target="RFC6906"/>) that apply to a link set document,
the "profile" attribute <bcp14>MAY</bcp14> be used in conjunction with the "linkset" link relation type.
For example, the attribute could be used to indicate that a link set uses a specific, limited set of link relation
types. The value of the "profile" attribute <bcp14>MUST</bcp14> be a non-empty
list of space-separated URIs, each of which identifies specific constraints or conventions that apply
to the link set document. Profile URIs <bcp14>MAY</bcp14> be registered in the IANA's "Profile URIs" registry in the manner specified by <xref target="RFC7284"/>.
<xref target="profile-attribute-example"/> shows an example of using the "profile" attribute on a link
with the "linkset" relation type, making both the link set and the profile(s) to which it complies discoverable.</t>
</section>
<section anchor="linkset-link-examples" numbered="true" toc="default">
<name>Examples</name>
<t>Sections <xref target="linkset-link-link-format" format="counter"/> and <xref target="linkset-link-json-format" format="counter"/>
show examples whereby a set of links is provided as "application/linkset" and "application/linkset+json" documents, respectively.
<xref target="linkset-rel-example"/> illustrates the use of the "linkset" link relation type to support the discovery of sets of links, and
<xref target="profile-examples"/> shows how to convey profile information pertaining to a link set.</t>
<section anchor="linkset-link-link-format" numbered="true" toc="default">
<name>Set of Links Provided as "application/linkset"</name>
<t><xref target="Request1"/> shows a client issuing an
HTTP GET request against resource <https://example.org/links/resource1>.</t>
<figure anchor="Request1">
<name>Client HTTP GET request</name>
<sourcecode type="http-message"><![CDATA[
GET /links/resource1 HTTP/1.1
Host: example.org
]]>
</sourcecode>
</figure>
<!-- [rfced] Sections 7.1 and subsequent: We changed
<artwork type="http-message"' to '<sourcecode type="http-message"'
per <https://www.rfc-editor.org/materials/sourcecode-types.txt>.
Please let us know any concerns.
Also, should Figure 19 in Appendix A be
'<sourcecode type="http-message"' as well?
Response:
We accept the changes. Figure 19 should not be changed because it
is not an HTTP message. Thanks. -->
<t><xref target="Response1.1"/> shows the response to the GET request of
<xref target="Request1"/>. The response contains a "Content-Type" header field
specifying that the media type of the response is "application/linkset". A set of links, revealing authorship and versioning related
to resource <https://example.org/resource1>, is provided in the response body. The HTTP "Link" header field indicates the availability
of an alternate representation of the set of links using media type "application/linkset+json".</t>
<figure anchor="Response1.1">
<name>Response to HTTP GET includes a set of links</name>
<sourcecode type="http-message"><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:35:51 GMT
Server: Apache-Coyote/1.1
Content-Length: 1023
Content-Type: application/linkset
Link: <https://example.org/links/resource1>
; rel="alternate"
; type="application/linkset+json"
<https://authors.example.net/johndoe>
; rel="author"
; type="application/rdf+xml"
; anchor="https://example.org/resource1",
<https://example.org/resource1?version=3>
; rel="latest-version"
; type="text/html"
; anchor="https://example.org/resource1",
<https://example.org/resource1?version=2>
; rel="predecessor-version"
; type="text/html"
; anchor="https://example.org/resource1?version=3",
<https://example.org/resource1?version=1>
; rel="predecessor-version"
; type="text/html"
; anchor="https://example.org/resource1?version=2",
<https://example.org/resource1?version=1>
; rel="memento"
; type="text/html"
; datetime="Thu, 13 Jun 2019 09:34:33 GMT"
; anchor="https://example.org/resource1",
<https://example.org/resource1?version=2>
; rel="memento"
; type="text/html"
; datetime="Sun, 21 Jul 2019 12:22:04 GMT"
; anchor="https://example.org/resource1",
<https://authors.example.net/alice>
; rel="author"
; anchor="https://example.org/resource1#comment=1" ]]>
</sourcecode>
</figure>
</section>
<section anchor="linkset-link-json-format" numbered="true" toc="default">
<name>Set of Links Provided as "application/linkset+json"</name>
<t><xref target="Request4"/> shows the client issuing an HTTP GET
request against <https://example.org/links/resource1>.
In the request, the client uses an "Accept" header field to indicate that it prefers a response in the
"application/linkset+json" format.</t>
<figure anchor="Request4">
<name>Client HTTP GET request expressing preference for an "application&wj;/linkset+json" response</name>
<sourcecode type="http-message"><![CDATA[
GET links/resource1 HTTP/1.1
Host: example.org
Accept: application/linkset+json
]]>
</sourcecode>
</figure>
<t><xref target="Response4.1"/> shows the response to the HTTP GET request of <xref target="Request4"/>.
The set of links is serialized according to the media type "application/linkset+json".</t>
<figure anchor="Response4.1">
<name>Response to the client's request for the linkset</name>
<sourcecode type="http-message"><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:46:22 GMT
Server: Apache-Coyote/1.1
Content-Type: application/linkset+json
Link: <https://example.org/links/resource1>
; rel="alternate"
; type="application/linkset"
Content-Length: 1246
{ "linkset":
[
{ "anchor": "https://example.org/resource1",
"author": [
{ "href": "https://authors.example.net/johndoe",
"type": "application/rdf+xml"
}
],
"memento": [
{ "href": "https://example.org/resource1?version=1",
"type": "text/html",
"datetime": "Thu, 13 Jun 2019 09:34:33 GMT"
},
{ "href": "https://example.org/resource1?version=2",
"type": "text/html",
"datetime": "Sun, 21 Jul 2019 12:22:04 GMT"
}
],
"latest-version": [
{ "href": "https://example.org/resource1?version=3",
"type": "text/html"
}
]
},
{ "anchor": "https://example.org/resource1?version=3",
"predecessor-version": [
{ "href": "https://example.org/resource1?version=2",
"type": "text/html"
}
]
},
{ "anchor": "https://example.org/resource1?version=2",
"predecessor-version": [
{ "href": "https://example.org/resource1?version=1",
"type": "text/html"
}
]
},
{ "anchor": "https://example.org/resource1#comment=1",
"author": [
{ "href": "https://authors.example.net/alice"}
]
}
]
}]]>
</sourcecode>
</figure>
</section>
<section anchor="linkset-rel-example" numbered="true" toc="default">
<name>Discovering a Link Set via the "linkset" Link Relation Type</name>
<t><xref target="Request3"/> shows a client issuing an
HTTP HEAD request against resource
<https://example.org/resource1>.</t>
<figure anchor="Request3">
<name>Client HTTP HEAD request</name>
<sourcecode type="http-message"><![CDATA[
HEAD resource1 HTTP/1.1
Host: example.org
]]>
</sourcecode>
</figure>
<t><xref target="Response3.1"/> shows the response to the HEAD request of
<xref target="Request3"/>. The response contains an HTTP "Link" header field with
a link that has the "linkset" relation type. It indicates that a set of links is provided
by resource <https://example.org/links/resource1>, which
provides a representation with media type "application/linkset+json".</t>
<figure anchor="Response3.1">
<name>Response to HTTP HEAD request</name>
<sourcecode type="http-message"><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 12 Aug 2019 10:45:54 GMT
Server: Apache-Coyote/1.1
Link: <https://example.org/links/resource1>
; rel="linkset"
; type="application/linkset+json"
Content-Length: 236
Content-Type: text/html;charset=utf-8
]]>
</sourcecode>
</figure>
</section>
<section anchor="profile-examples" numbered="true" toc="default">
<name>Link Set Profiles</name>
<t>The examples in this section illustrate the use of the "profile" attribute for a link with the "linkset" link relation type and the "profile" attribute for a link set media type. The examples are inspired by the implementation of link sets by GS1 (the standards body behind many of the world's barcodes).</t>
<section anchor="profile-attribute-example" numbered="true" toc="default">
<name>Using a "profile" Attribute with a "linkset" Link</name>
<t><xref target="Request_pr_at"/> shows a client issuing an
HTTP HEAD request against trade item 09506000134352 at <eref target="https://id.gs1.org/01/9506000134352" brackets="angle"/>.</t>
<figure anchor="Request_pr_at">
<name>Client HTTP HEAD request</name>
<sourcecode type="http-message"><![CDATA[
HEAD /01/9506000134352 HTTP/1.1
Host: id.gs1.org
]]>
</sourcecode>
</figure>
<t><xref target="Response_pr_at"/> shows the server's response to the request of
<xref target="Request_pr_at"/>, including a "linkset" link with a "profile" attribute
that has the profile URI <eref target="https://www.gs1.org/voc/?show=linktypes" brackets="angle"/> as its value.
Dereferencing that URI yields a profile document that lists all the link relation types that
a client can expect when requesting the link set made discoverable by the "linkset" link. The link relation types are
presented in abbreviated form, e.g., <gs1:activityIdeas>, whereas the actual link relation type URIs are
available as hyperlinks on the abbreviations, e.g., <eref target="https://www.gs1.org/voc/activityIdeas" brackets="angle"/>.
For posterity, that profile document was saved in the Internet Archive at
<eref target="https://web.archive.org/web/20210927160406/https://www.gs1.org/voc/?show=linktypes" brackets="angle"/>
on 27 September 2021.</t>
<figure anchor="Response_pr_at">
<name>Response to the client's HEAD request, including a "profile" attribute for the "linkset" link</name>
<sourcecode type="http-message"><![CDATA[
HTTP/1.1 307 Temporary Redirect
Date: Mon, 27 Sep 2021 16:03:07 GMT
Server: nginx
Link: <https://id.gs1.org/01/9506000134352?linkType=all>
; rel="linkset"
; type="application/linkset+json"
; profile="https://www.gs1.org/voc/?show=linktypes"
Location: https://example.com/risotto-rice-with-mushrooms/
]]>
</sourcecode>
</figure>
<!-- [rfced] Figure 14: Would you like the ";" (semicolon) lines to
be indented per Figures 8, 10, 12, and 19? We ask because Figure 14
appears to be an outlier as far as the indentation (or lack thereof)
goes.
Original:
HTTP/1.1 307 Temporary Redirect
Date: Mon, 27 Sep 2021 16:03:07 GMT
Server: nginx
Link: https://id.gs1.org/01/9506000134352?linkType=all
; rel="linkset"
; type="application/linkset+json"
; profile="https://www.gs1.org/voc/?show=linktypes"
Location: https://example.com/risotto-rice-with-mushrooms/
Possibly:
HTTP/1.1 307 Temporary Redirect
Date: Mon, 27 Sep 2021 16:03:07 GMT
Server: nginx
Link: <https://id.gs1.org/01/9506000134352?linkType=all>
; rel="linkset"
; type="application/linkset+json"
; profile="https://www.gs1.org/voc/?show=linktypes"
Location: https://example.com/risotto-rice-with-mushrooms/
Response:
Thanks, we made the change as suggested. -->
</section>
<section anchor="profile-parameter-example" numbered="true" toc="default">
<name>Using a "profile" Parameter with a Link Set Media Type</name>
<t><xref target="Request_pr_par"/> shows a client issuing an
HTTP HEAD request against the link set <eref target="https://id.gs1.org/01/9506000134352?linkType=all" brackets="angle"/> that was discovered through the HTTP interactions shown in <xref target="profile-attribute-example"/>.</t>
<figure anchor="Request_pr_par">
<name>Client HTTP HEAD request</name>
<sourcecode type="http-message"><![CDATA[
HEAD /01/9506000134352?linkType=all HTTP/1.1
Host: id.gs1.org
]]>
</sourcecode>
</figure>
<t><xref target="Response_pr_par"/> shows the server's response to the request of <xref target="Request_pr_par"/>. Note the "profile" parameter for the "application/linkset+json" media type, which has as its value the same profile URI <eref target="https://www.gs1.org/voc/?show=linktypes" brackets="angle"/> as was used in <xref target="Response_pr_at"/>.</t>
<!-- [rfced] Section 7.4.2: We changed
"used in <xref target="Response_pr_at"/>" to "used in Figure 14".
Please let us know any concerns.
Original:
Note the "profile" parameter for the application/linkset+json media
type, which has as value the same Profile URI <https://www.gs1.org/
voc/?show=linktypes> as was used in <xref target="Response_pr_at"/>.
Currently:
Note the "profile" parameter for the "application/linkset+json" media
type, which has as its value the same profile URI
<https://www.gs1.org/voc/?show=linktypes> as was used in Figure 14.
Response:
We believe this should remain as it is and it seems like this was not
changed in the XML anyways. This is a link and from what we can
tell, it works as intended in the formatted versions. -->
<figure anchor="Response_pr_par">
<name>Response to the client's HEAD request, including a "profile" parameter for the "application/linkset+json" media type</name>
<sourcecode type="http-message"><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 27 Sep 2021 16:03:33 GMT
Server: nginx
Content-Type: application/linkset+json;
profile="https://www.gs1.org/voc/?show=linktypes"