Debian Codegraph @

rfc8820.html

raw
1 <!DOCTYPE html>
2 <html lang="en" class="RFC BCP">
3 <head>
4 <meta charset="utf-8">
5 <meta content="Common,Latin" name="scripts">
6 <meta content="initial-scale=1.0" name="viewport">
7 <title>RFC 8820: URI Design and Ownership</title>
8 <meta content="Mark Nottingham" name="author">
9 <meta content="
10 Section 1.1.1 of RFC 3986 defines URI syntax as &quot;a federated and
11 extensible naming system wherein each scheme's specification may further
12 restrict the syntax and semantics of identifiers using that scheme.&quot; In
13 other words, the structure of a URI is defined by its scheme. While it
14 is common for schemes to further delegate their substructure to the
15 URI's owner, publishing independent standards that mandate particular
16 forms of substructure in URIs is often problematic.
17 This document provides guidance on the specification of URI
18 substructure in standards.
19 This document obsoletes RFC 7320 and updates RFC 3986.
20 " name="description">
21 <meta content="xml2rfc 2.46.0" name="generator">
22 <meta content="URI structure" name="keyword">
23 <meta content="8820" name="rfc.number">
24 <link href="rfc8820.xml" rel="alternate" type="application/rfc+xml">
25 <link href="#copyright" rel="license">
26 <style type="text/css">/*
27
28 NOTE: Changes at the bottom of this file overrides some earlier settings.
29
30 Once the style has stabilized and has been adopted as an official RFC style,
31 this can be consolidated so that style settings occur only in one place, but
32 for now the contents of this file consists first of the initial CSS work as
33 provided to the RFC Formatter (xml2rfc) work, followed by itemized and
34 commented changes found necssary during the development of the v3
35 formatters.
36
37 */
38
39 /* fonts */
40 @import url('https://fonts.googleapis.com/css?family=Noto+Sans'); /* Sans-serif */
41 @import url('https://fonts.googleapis.com/css?family=Noto+Serif'); /* Serif (print) */
42 @import url('https://fonts.googleapis.com/css?family=Roboto+Mono'); /* Monospace */
43
44 @viewport {
45 zoom: 1.0;
46 width: extend-to-zoom;
47 }
48 @-ms-viewport {
49 width: extend-to-zoom;
50 zoom: 1.0;
51 }
52 /* general and mobile first */
53 html {
54 }
55 body {
56 max-width: 90%;
57 margin: 1.5em auto;
58 color: #222;
59 background-color: #fff;
60 font-size: 14px;
61 font-family: 'Noto Sans', Arial, Helvetica, sans-serif;
62 line-height: 1.6;
63 scroll-behavior: smooth;
64 }
65 .ears {
66 display: none;
67 }
68
69 /* headings */
70 #title, h1, h2, h3, h4, h5, h6 {
71 margin: 1em 0 0.5em;
72 font-weight: bold;
73 line-height: 1.3;
74 }
75 #title {
76 clear: both;
77 border-bottom: 1px solid #ddd;
78 margin: 0 0 0.5em 0;
79 padding: 1em 0 0.5em;
80 }
81 .author {
82 padding-bottom: 4px;
83 }
84 h1 {
85 font-size: 26px;
86 margin: 1em 0;
87 }
88 h2 {
89 font-size: 22px;
90 margin-top: -20px; /* provide offset for in-page anchors */
91 padding-top: 33px;
92 }
93 h3 {
94 font-size: 18px;
95 margin-top: -36px; /* provide offset for in-page anchors */
96 padding-top: 42px;
97 }
98 h4 {
99 font-size: 16px;
100 margin-top: -36px; /* provide offset for in-page anchors */
101 padding-top: 42px;
102 }
103 h5, h6 {
104 font-size: 14px;
105 }
106 #n-copyright-notice {
107 border-bottom: 1px solid #ddd;
108 padding-bottom: 1em;
109 margin-bottom: 1em;
110 }
111 /* general structure */
112 p {
113 padding: 0;
114 margin: 0 0 1em 0;
115 text-align: left;
116 }
117 div, span {
118 position: relative;
119 }
120 div {
121 margin: 0;
122 }
123 .alignRight.art-text {
124 background-color: #f9f9f9;
125 border: 1px solid #eee;
126 border-radius: 3px;
127 padding: 1em 1em 0;
128 margin-bottom: 1.5em;
129 }
130 .alignRight.art-text pre {
131 padding: 0;
132 }
133 .alignRight {
134 margin: 1em 0;
135 }
136 .alignRight > *:first-child {
137 border: none;
138 margin: 0;
139 float: right;
140 clear: both;
141 }
142 .alignRight > *:nth-child(2) {
143 clear: both;
144 display: block;
145 border: none;
146 }
147 svg {
148 display: block;
149 }
150 .alignCenter.art-text {
151 background-color: #f9f9f9;
152 border: 1px solid #eee;
153 border-radius: 3px;
154 padding: 1em 1em 0;
155 margin-bottom: 1.5em;
156 }
157 .alignCenter.art-text pre {
158 padding: 0;
159 }
160 .alignCenter {
161 margin: 1em 0;
162 }
163 .alignCenter > *:first-child {
164 border: none;
165 /* this isn't optimal, but it's an existence proof. PrinceXML doesn't
166 support flexbox yet.
167 */
168 display: table;
169 margin: 0 auto;
170 }
171
172 /* lists */
173 ol, ul {
174 padding: 0;
175 margin: 0 0 1em 2em;
176 }
177 ol ol, ul ul, ol ul, ul ol {
178 margin-left: 1em;
179 }
180 li {
181 margin: 0 0 0.25em 0;
182 }
183 .ulCompact li {
184 margin: 0;
185 }
186 ul.empty, .ulEmpty {
187 list-style-type: none;
188 }
189 ul.empty li, .ulEmpty li {
190 margin-top: 0.5em;
191 }
192 ul.compact, .ulCompact,
193 ol.compact, .olCompact {
194 line-height: 100%;
195 margin: 0 0 0 2em;
196 }
197
198 /* definition lists */
199 dl {
200 }
201 dl > dt {
202 float: left;
203 margin-right: 1em;
204 }
205 /*
206 dl.nohang > dt {
207 float: none;
208 }
209 */
210 dl > dd {
211 margin-bottom: .8em;
212 min-height: 1.3em;
213 }
214 dl.compact > dd, .dlCompact > dd {
215 margin-bottom: 0em;
216 }
217 dl > dd > dl {
218 margin-top: 0.5em;
219 margin-bottom: 0em;
220 }
221
222 /* links */
223 a {
224 text-decoration: none;
225 }
226 a[href] {
227 color: #22e; /* Arlen: WCAG 2019 */
228 }
229 a[href]:hover {
230 background-color: #f2f2f2;
231 }
232 figcaption a[href],
233 a[href].selfRef {
234 color: #222;
235 }
236 /* XXX probably not this:
237 a.selfRef:hover {
238 background-color: transparent;
239 cursor: default;
240 } */
241
242 /* Figures */
243 tt, code, pre, code {
244 background-color: #f9f9f9;
245 font-family: 'Roboto Mono', monospace;
246 }
247 pre {
248 border: 1px solid #eee;
249 margin: 0;
250 padding: 1em;
251 }
252 img {
253 max-width: 100%;
254 }
255 figure {
256 margin: 0;
257 }
258 figure blockquote {
259 margin: 0.8em 0.4em 0.4em;
260 }
261 figcaption {
262 font-style: italic;
263 margin: 0 0 1em 0;
264 }
265 @media screen {
266 pre {
267 overflow-x: auto;
268 max-width: 100%;
269 max-width: calc(100% - 22px);
270 }
271 }
272
273 /* aside, blockquote */
274 aside, blockquote {
275 margin-left: 0;
276 padding: 1.2em 2em;
277 }
278 blockquote {
279 background-color: #f9f9f9;
280 color: #111; /* Arlen: WCAG 2019 */
281 border: 1px solid #ddd;
282 border-radius: 3px;
283 margin: 1em 0;
284 }
285 cite {
286 display: block;
287 text-align: right;
288 font-style: italic;
289 }
290
291 /* tables */
292 table {
293 width: 100%;
294 margin: 0 0 1em;
295 border-collapse: collapse;
296 border: 1px solid #eee;
297 }
298 th, td {
299 text-align: left;
300 vertical-align: top;
301 padding: 0.5em 0.75em;
302 }
303 th {
304 text-align: left;
305 background-color: #e9e9e9;
306 }
307 tr:nth-child(2n+1) > td {
308 background-color: #f5f5f5;
309 }
310 table caption {
311 font-style: italic;
312 margin: 0;
313 padding: 0;
314 text-align: left;
315 }
316 table p {
317 /* XXX to avoid bottom margin on table row signifiers. If paragraphs should
318 be allowed within tables more generally, it would be far better to select on a class. */
319 margin: 0;
320 }
321
322 /* pilcrow */
323 a.pilcrow {
324 color: #666; /* Arlen: AHDJ 2019 */
325 text-decoration: none;
326 visibility: hidden;
327 user-select: none;
328 -ms-user-select: none;
329 -o-user-select:none;
330 -moz-user-select: none;
331 -khtml-user-select: none;
332 -webkit-user-select: none;
333 -webkit-touch-callout: none;
334 }
335 @media screen {
336 aside:hover > a.pilcrow,
337 p:hover > a.pilcrow,
338 blockquote:hover > a.pilcrow,
339 div:hover > a.pilcrow,
340 li:hover > a.pilcrow,
341 pre:hover > a.pilcrow {
342 visibility: visible;
343 }
344 a.pilcrow:hover {
345 background-color: transparent;
346 }
347 }
348
349 /* misc */
350 hr {
351 border: 0;
352 border-top: 1px solid #eee;
353 }
354 .bcp14 {
355 font-variant: small-caps;
356 }
357
358 .role {
359 font-variant: all-small-caps;
360 }
361
362 /* info block */
363 #identifiers {
364 margin: 0;
365 font-size: 0.9em;
366 }
367 #identifiers dt {
368 width: 3em;
369 clear: left;
370 }
371 #identifiers dd {
372 float: left;
373 margin-bottom: 0;
374 }
375 #identifiers .authors .author {
376 display: inline-block;
377 margin-right: 1.5em;
378 }
379 #identifiers .authors .org {
380 font-style: italic;
381 }
382
383 /* The prepared/rendered info at the very bottom of the page */
384 .docInfo {
385 color: #666; /* Arlen: WCAG 2019 */
386 font-size: 0.9em;
387 font-style: italic;
388 margin-top: 2em;
389 }
390 .docInfo .prepared {
391 float: left;
392 }
393 .docInfo .prepared {
394 float: right;
395 }
396
397 /* table of contents */
398 #toc {
399 padding: 0.75em 0 2em 0;
400 margin-bottom: 1em;
401 }
402 nav.toc ul {
403 margin: 0 0.5em 0 0;
404 padding: 0;
405 list-style: none;
406 }
407 nav.toc li {
408 line-height: 1.3em;
409 margin: 0.75em 0;
410 padding-left: 1.2em;
411 text-indent: -1.2em;
412 }
413 /* references */
414 .references dt {
415 text-align: right;
416 font-weight: bold;
417 min-width: 7em;
418 }
419 .references dd {
420 margin-left: 8em;
421 overflow: auto;
422 }
423
424 .refInstance {
425 margin-bottom: 1.25em;
426 }
427
428 .references .ascii {
429 margin-bottom: 0.25em;
430 }
431
432 /* index */
433 .index ul {
434 margin: 0 0 0 1em;
435 padding: 0;
436 list-style: none;
437 }
438 .index ul ul {
439 margin: 0;
440 }
441 .index li {
442 margin: 0;
443 text-indent: -2em;
444 padding-left: 2em;
445 padding-bottom: 5px;
446 }
447 .indexIndex {
448 margin: 0.5em 0 1em;
449 }
450 .index a {
451 font-weight: 700;
452 }
453 /* make the index two-column on all but the smallest screens */
454 @media (min-width: 600px) {
455 .index ul {
456 -moz-column-count: 2;
457 -moz-column-gap: 20px;
458 }
459 .index ul ul {
460 -moz-column-count: 1;
461 -moz-column-gap: 0;
462 }
463 }
464
465 /* authors */
466 address.vcard {
467 font-style: normal;
468 margin: 1em 0;
469 }
470
471 address.vcard .nameRole {
472 font-weight: 700;
473 margin-left: 0;
474 }
475 address.vcard .label {
476 font-family: "Noto Sans",Arial,Helvetica,sans-serif;
477 margin: 0.5em 0;
478 }
479 address.vcard .type {
480 display: none;
481 }
482 .alternative-contact {
483 margin: 1.5em 0 1em;
484 }
485 hr.addr {
486 border-top: 1px dashed;
487 margin: 0;
488 color: #ddd;
489 max-width: calc(100% - 16px);
490 }
491
492 /* temporary notes */
493 .rfcEditorRemove::before {
494 position: absolute;
495 top: 0.2em;
496 right: 0.2em;
497 padding: 0.2em;
498 content: "The RFC Editor will remove this note";
499 color: #9e2a00; /* Arlen: WCAG 2019 */
500 background-color: #ffd; /* Arlen: WCAG 2019 */
501 }
502 .rfcEditorRemove {
503 position: relative;
504 padding-top: 1.8em;
505 background-color: #ffd; /* Arlen: WCAG 2019 */
506 border-radius: 3px;
507 }
508 .cref {
509 background-color: #ffd; /* Arlen: WCAG 2019 */
510 padding: 2px 4px;
511 }
512 .crefSource {
513 font-style: italic;
514 }
515 /* alternative layout for smaller screens */
516 @media screen and (max-width: 1023px) {
517 body {
518 padding-top: 2em;
519 }
520 #title {
521 padding: 1em 0;
522 }
523 h1 {
524 font-size: 24px;
525 }
526 h2 {
527 font-size: 20px;
528 margin-top: -18px; /* provide offset for in-page anchors */
529 padding-top: 38px;
530 }
531 #identifiers dd {
532 max-width: 60%;
533 }
534 #toc {
535 position: fixed;
536 z-index: 2;
537 top: 0;
538 right: 0;
539 padding: 0;
540 margin: 0;
541 background-color: inherit;
542 border-bottom: 1px solid #ccc;
543 }
544 #toc h2 {
545 margin: -1px 0 0 0;
546 padding: 4px 0 4px 6px;
547 padding-right: 1em;
548 min-width: 190px;
549 font-size: 1.1em;
550 text-align: right;
551 background-color: #444;
552 color: white;
553 cursor: pointer;
554 }
555 #toc h2::before { /* css hamburger */
556 float: right;
557 position: relative;
558 width: 1em;
559 height: 1px;
560 left: -164px;
561 margin: 6px 0 0 0;
562 background: white none repeat scroll 0 0;
563 box-shadow: 0 4px 0 0 white, 0 8px 0 0 white;
564 content: "";
565 }
566 #toc nav {
567 display: none;
568 padding: 0.5em 1em 1em;
569 overflow: auto;
570 height: calc(100vh - 48px);
571 border-left: 1px solid #ddd;
572 }
573 }
574
575 /* alternative layout for wide screens */
576 @media screen and (min-width: 1024px) {
577 body {
578 max-width: 724px;
579 margin: 42px auto;
580 padding-left: 1.5em;
581 padding-right: 29em;
582 }
583 #toc {
584 position: fixed;
585 top: 42px;
586 right: 42px;
587 width: 25%;
588 margin: 0;
589 padding: 0 1em;
590 z-index: 1;
591 }
592 #toc h2 {
593 border-top: none;
594 border-bottom: 1px solid #ddd;
595 font-size: 1em;
596 font-weight: normal;
597 margin: 0;
598 padding: 0.25em 1em 1em 0;
599 }
600 #toc nav {
601 display: block;
602 height: calc(90vh - 84px);
603 bottom: 0;
604 padding: 0.5em 0 0;
605 overflow: auto;
606 }
607 img { /* future proofing */
608 max-width: 100%;
609 height: auto;
610 }
611 }
612
613 /* pagination */
614 @media print {
615 body {
616
617 width: 100%;
618 }
619 p {
620 orphans: 3;
621 widows: 3;
622 }
623 #n-copyright-notice {
624 border-bottom: none;
625 }
626 #toc, #n-introduction {
627 page-break-before: always;
628 }
629 #toc {
630 border-top: none;
631 padding-top: 0;
632 }
633 figure, pre {
634 page-break-inside: avoid;
635 }
636 figure {
637 overflow: scroll;
638 }
639 h1, h2, h3, h4, h5, h6 {
640 page-break-after: avoid;
641 }
642 h2+*, h3+*, h4+*, h5+*, h6+* {
643 page-break-before: avoid;
644 }
645 pre {
646 white-space: pre-wrap;
647 word-wrap: break-word;
648 font-size: 10pt;
649 }
650 table {
651 border: 1px solid #ddd;
652 }
653 td {
654 border-top: 1px solid #ddd;
655 }
656 }
657
658 /* This is commented out here, as the string-set: doesn't
659 pass W3C validation currently */
660 /*
661 .ears thead .left {
662 string-set: ears-top-left content();
663 }
664
665 .ears thead .center {
666 string-set: ears-top-center content();
667 }
668
669 .ears thead .right {
670 string-set: ears-top-right content();
671 }
672
673 .ears tfoot .left {
674 string-set: ears-bottom-left content();
675 }
676
677 .ears tfoot .center {
678 string-set: ears-bottom-center content();
679 }
680
681 .ears tfoot .right {
682 string-set: ears-bottom-right content();
683 }
684 */
685
686 @page :first {
687 padding-top: 0;
688 @top-left {
689 content: normal;
690 border: none;
691 }
692 @top-center {
693 content: normal;
694 border: none;
695 }
696 @top-right {
697 content: normal;
698 border: none;
699 }
700 }
701
702 @page {
703 size: A4;
704 margin-bottom: 45mm;
705 padding-top: 20px;
706 /* The follwing is commented out here, but set appropriately by in code, as
707 the content depends on the document */
708 /*
709 @top-left {
710 content: 'Internet-Draft';
711 vertical-align: bottom;
712 border-bottom: solid 1px #ccc;
713 }
714 @top-left {
715 content: string(ears-top-left);
716 vertical-align: bottom;
717 border-bottom: solid 1px #ccc;
718 }
719 @top-center {
720 content: string(ears-top-center);
721 vertical-align: bottom;
722 border-bottom: solid 1px #ccc;
723 }
724 @top-right {
725 content: string(ears-top-right);
726 vertical-align: bottom;
727 border-bottom: solid 1px #ccc;
728 }
729 @bottom-left {
730 content: string(ears-bottom-left);
731 vertical-align: top;
732 border-top: solid 1px #ccc;
733 }
734 @bottom-center {
735 content: string(ears-bottom-center);
736 vertical-align: top;
737 border-top: solid 1px #ccc;
738 }
739 @bottom-right {
740 content: '[Page ' counter(page) ']';
741 vertical-align: top;
742 border-top: solid 1px #ccc;
743 }
744 */
745
746 }
747
748 /* Changes introduced to fix issues found during implementation */
749 /* Make sure links are clickable even if overlapped by following H* */
750 a {
751 z-index: 2;
752 }
753 /* Separate body from document info even without intervening H1 */
754 section {
755 clear: both;
756 }
757
758
759 /* Top align author divs, to avoid names without organization dropping level with org names */
760 .author {
761 vertical-align: top;
762 }
763
764 /* Leave room in document info to show Internet-Draft on one line */
765 #identifiers dt {
766 width: 8em;
767 }
768
769 /* Don't waste quite as much whitespace between label and value in doc info */
770 #identifiers dd {
771 margin-left: 1em;
772 }
773
774 /* Give floating toc a background color (needed when it's a div inside section */
775 #toc {
776 background-color: white;
777 }
778
779 /* Make the collapsed ToC header render white on gray also when it's a link */
780 @media screen and (max-width: 1023px) {
781 #toc h2 a,
782 #toc h2 a:link,
783 #toc h2 a:focus,
784 #toc h2 a:hover,
785 #toc a.toplink,
786 #toc a.toplink:hover {
787 color: white;
788 background-color: #444;
789 text-decoration: none;
790 }
791 }
792
793 /* Give the bottom of the ToC some whitespace */
794 @media screen and (min-width: 1024px) {
795 #toc {
796 padding: 0 0 1em 1em;
797 }
798 }
799
800 /* Style section numbers with more space between number and title */
801 .section-number {
802 padding-right: 0.5em;
803 }
804
805 /* prevent monospace from becoming overly large */
806 tt, code, pre, code {
807 font-size: 95%;
808 }
809
810 /* Fix the height/width aspect for ascii art*/
811 pre.sourcecode,
812 .art-text pre {
813 line-height: 1.12;
814 }
815
816
817 /* Add styling for a link in the ToC that points to the top of the document */
818 a.toplink {
819 float: right;
820 margin-right: 0.5em;
821 }
822
823 /* Fix the dl styling to match the RFC 7992 attributes */
824 dl > dt,
825 dl.dlParallel > dt {
826 float: left;
827 margin-right: 1em;
828 }
829 dl.dlNewline > dt {
830 float: none;
831 }
832
833 /* Provide styling for table cell text alignment */
834 table td.text-left,
835 table th.text-left {
836 text-align: left;
837 }
838 table td.text-center,
839 table th.text-center {
840 text-align: center;
841 }
842 table td.text-right,
843 table th.text-right {
844 text-align: right;
845 }
846
847 /* Make the alternative author contact informatio look less like just another
848 author, and group it closer with the primary author contact information */
849 .alternative-contact {
850 margin: 0.5em 0 0.25em 0;
851 }
852 address .non-ascii {
853 margin: 0 0 0 2em;
854 }
855
856 /* With it being possible to set tables with alignment
857 left, center, and right, { width: 100%; } does not make sense */
858 table {
859 width: auto;
860 }
861
862 /* Avoid reference text that sits in a block with very wide left margin,
863 because of a long floating dt label.*/
864 .references dd {
865 overflow: visible;
866 }
867
868 /* Control caption placement */
869 caption {
870 caption-side: bottom;
871 }
872
873 /* Limit the width of the author address vcard, so names in right-to-left
874 script don't end up on the other side of the page. */
875
876 address.vcard {
877 max-width: 30em;
878 margin-right: auto;
879 }
880
881 /* For address alignment dependent on LTR or RTL scripts */
882 address div.left {
883 text-align: left;
884 }
885 address div.right {
886 text-align: right;
887 }
888
889 /* Provide table alignment support. We can't use the alignX classes above
890 since they do unwanted things with caption and other styling. */
891 table.right {
892 margin-left: auto;
893 margin-right: 0;
894 }
895 table.center {
896 margin-left: auto;
897 margin-right: auto;
898 }
899 table.left {
900 margin-left: 0;
901 margin-right: auto;
902 }
903
904 /* Give the table caption label the same styling as the figcaption */
905 caption a[href] {
906 color: #222;
907 }
908
909 @media print {
910 .toplink {
911 display: none;
912 }
913
914 /* avoid overwriting the top border line with the ToC header */
915 #toc {
916 padding-top: 1px;
917 }
918
919 /* Avoid page breaks inside dl and author address entries */
920 .vcard {
921 page-break-inside: avoid;
922 }
923
924 }
925 /* Tweak the bcp14 keyword presentation */
926 .bcp14 {
927 font-variant: small-caps;
928 font-weight: bold;
929 font-size: 0.9em;
930 }
931 /* Tweak the invisible space above H* in order not to overlay links in text above */
932 h2 {
933 margin-top: -18px; /* provide offset for in-page anchors */
934 padding-top: 31px;
935 }
936 h3 {
937 margin-top: -18px; /* provide offset for in-page anchors */
938 padding-top: 24px;
939 }
940 h4 {
941 margin-top: -18px; /* provide offset for in-page anchors */
942 padding-top: 24px;
943 }
944 /* Float artwork pilcrow to the right */
945 @media screen {
946 .artwork a.pilcrow {
947 display: block;
948 line-height: 0.7;
949 margin-top: 0.15em;
950 }
951 }
952 /* Make pilcrows on dd visible */
953 @media screen {
954 dd:hover > a.pilcrow {
955 visibility: visible;
956 }
957 }
958 /* Make the placement of figcaption match that of a table's caption
959 by removing the figure's added bottom margin */
960 .alignLeft.art-text,
961 .alignCenter.art-text,
962 .alignRight.art-text {
963 margin-bottom: 0;
964 }
965 .alignLeft,
966 .alignCenter,
967 .alignRight {
968 margin: 1em 0 0 0;
969 }
970 /* In print, the pilcrow won't show on hover, so prevent it from taking up space,
971 possibly even requiring a new line */
972 @media print {
973 a.pilcrow {
974 display: none;
975 }
976 }
977 /* Styling for the external metadata */
978 div#external-metadata {
979 background-color: #eee;
980 padding: 0.5em;
981 margin-bottom: 0.5em;
982 display: none;
983 }
984 div#internal-metadata {
985 padding: 0.5em; /* to match the external-metadata padding */
986 }
987 /* Styling for title RFC Number */
988 h1#rfcnum {
989 clear: both;
990 margin: 0 0 -1em;
991 padding: 1em 0 0 0;
992 }
993 /* Make .olPercent look the same as <ol><li> */
994 dl.olPercent > dd {
995 margin-bottom: 0.25em;
996 min-height: initial;
997 }
998 /* Give aside some styling to set it apart */
999 aside {
1000 border-left: 1px solid #ddd;
1001 margin: 1em 0 1em 2em;
1002 padding: 0.2em 2em;
1003 }
1004 aside > dl,
1005 aside > ol,
1006 aside > ul,
1007 aside > table,
1008 aside > p {
1009 margin-bottom: 0.5em;
1010 }
1011 /* Additional page break settings */
1012 @media print {
1013 figcaption, table caption {
1014 page-break-before: avoid;
1015 }
1016 }
1017 /* Font size adjustments for print */
1018 @media print {
1019 body { font-size: 10pt; line-height: normal; max-width: 96%; }
1020 h1 { font-size: 1.72em; padding-top: 1.5em; } /* 1*1.2*1.2*1.2 */
1021 h2 { font-size: 1.44em; padding-top: 1.5em; } /* 1*1.2*1.2 */
1022 h3 { font-size: 1.2em; padding-top: 1.5em; } /* 1*1.2 */
1023 h4 { font-size: 1em; padding-top: 1.5em; }
1024 h5, h6 { font-size: 1em; margin: initial; padding: 0.5em 0 0.3em; }
1025 }
1026 /* Sourcecode margin in print, when there's no pilcrow */
1027 @media print {
1028 .artwork,
1029 .sourcecode {
1030 margin-bottom: 1em;
1031 }
1032 }
1033 /* Avoid narrow tables forcing too narrow table captions, which may render badly */
1034 table {
1035 min-width: 20em;
1036 }
1037 /* ol type a */
1038 ol.type-a { list-style-type: lower-alpha; }
1039 ol.type-A { list-style-type: upper-alpha; }
1040 ol.type-i { list-style-type: lower-roman; }
1041 ol.type-I { list-style-type: lower-roman; }
1042 /* Apply the print table and row borders in general, on request from the RPC,
1043 and increase the contrast between border and odd row background sligthtly */
1044 table {
1045 border: 1px solid #ddd;
1046 }
1047 td {
1048 border-top: 1px solid #ddd;
1049 }
1050 tr:nth-child(2n+1) > td {
1051 background-color: #f8f8f8;
1052 }
1053 /* Use style rules to govern display of the TOC. */
1054 @media screen and (max-width: 1023px) {
1055 #toc nav { display: none; }
1056 #toc.active nav { display: block; }
1057 }
1058 /* Add support for keepWithNext */
1059 .keepWithNext {
1060 break-after: avoid-page;
1061 break-after: avoid-page;
1062 }
1063 /* Add support for keepWithPrevious */
1064 .keepWithPrevious {
1065 break-before: avoid-page;
1066 }
1067 /* Change the approach to avoiding breaks inside artwork etc. */
1068 figure, pre, table, .artwork, .sourcecode {
1069 break-before: avoid-page;
1070 break-after: auto;
1071 }
1072 /* Avoid breaks between <dt> and <dd> */
1073 dl {
1074 break-before: auto;
1075 break-inside: auto;
1076 }
1077 dt {
1078 break-before: auto;
1079 break-after: avoid-page;
1080 }
1081 dd {
1082 break-before: avoid-page;
1083 break-after: auto;
1084 orphans: 3;
1085 widows: 3
1086 }
1087 span.break, dd.break {
1088 margin-bottom: 0;
1089 min-height: 0;
1090 break-before: auto;
1091 break-inside: auto;
1092 break-after: auto;
1093 }
1094 /* Undo break-before ToC */
1095 @media print {
1096 #toc {
1097 break-before: auto;
1098 }
1099 }
1100 /* Text in compact lists should not get extra bottim margin space,
1101 since that would makes the list not compact */
1102 ul.compact p, .ulCompact p,
1103 ol.compact p, .olCompact p {
1104 margin: 0;
1105 }
1106 /* But the list as a whole needs the extra space at the end */
1107 section ul.compact,
1108 section .ulCompact,
1109 section ol.compact,
1110 section .olCompact {
1111 margin-bottom: 1em; /* same as p not within ul.compact etc. */
1112 }
1113 /* The tt and code background above interferes with for instance table cell
1114 backgrounds. Changed to something a bit more selective. */
1115 tt, code {
1116 background-color: transparent;
1117 }
1118 p tt, p code {
1119 background-color: #f9f9f9;
1120 }
1121 </style>
1122 <link href="rfc-local.css" rel="stylesheet" type="text/css">
1123 <link href="https://dx.doi.org/10.17487/rfc8820" rel="alternate">
1124 <link href="urn:issn:2070-1721" rel="alternate">
1125 <link href="https://datatracker.ietf.org/doc/draft-nottingham-rfc7320bis-03" rel="prev">
1126 </head>
1127 <body>
1128 <script src="https://www.rfc-editor.org/js/metadata.min.js"></script>
1129 <table class="ears">
1130 <thead><tr>
1131 <td class="left">RFC 8820</td>
1132 <td class="center">URI Design and Ownership</td>
1133 <td class="right">June 2020</td>
1134 </tr></thead>
1135 <tfoot><tr>
1136 <td class="left">Nottingham</td>
1137 <td class="center">Best Current Practice</td>
1138 <td class="right">[Page]</td>
1139 </tr></tfoot>
1140 </table>
1141 <div id="external-metadata" class="document-information"></div>
1142 <div id="internal-metadata" class="document-information">
1143 <dl id="identifiers">
1144 <dt class="label-stream">Stream:</dt>
1145 <dd class="stream">Internet Engineering Task Force (IETF)</dd>
1146 <dt class="label-rfc">RFC:</dt>
1147 <dd class="rfc"><a href="https://www.rfc-editor.org/rfc/rfc8820" class="eref">8820</a></dd>
1148 <dt class="label-bcp">BCP:</dt>
1149 <dd class="bcp">190</dd>
1150 <dt class="label-obsoletes">Obsoletes:</dt>
1151 <dd class="obsoletes">
1152 <a href="https://www.rfc-editor.org/rfc/rfc7320" class="eref">7320</a> </dd>
1153 <dt class="label-updates">Updates:</dt>
1154 <dd class="updates">
1155 <a href="https://www.rfc-editor.org/rfc/rfc3986" class="eref">3986</a> </dd>
1156 <dt class="label-category">Category:</dt>
1157 <dd class="category">Best Current Practice</dd>
1158 <dt class="label-published">Published:</dt>
1159 <dd class="published">
1160 <time datetime="2020-06" class="published">June 2020</time>
1161 </dd>
1162 <dt class="label-issn">ISSN:</dt>
1163 <dd class="issn">2070-1721</dd>
1164 <dt class="label-authors">Author:</dt>
1165 <dd class="authors">
1166 <div class="author">
1167 <div class="author-name">M. Nottingham</div>
1168 </div>
1169 </dd>
1170 </dl>
1171 </div>
1172 <h1 id="rfcnum">RFC 8820</h1>
1173 <h1 id="title">URI Design and Ownership</h1>
1174 <section id="section-abstract">
1175 <h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
1176 <p id="section-abstract-1">Section 1.1.1 of RFC 3986 defines URI syntax as "a federated and
1177 extensible naming system wherein each scheme's specification may further
1178 restrict the syntax and semantics of identifiers using that scheme." In
1179 other words, the structure of a URI is defined by its scheme. While it
1180 is common for schemes to further delegate their substructure to the
1181 URI's owner, publishing independent standards that mandate particular
1182 forms of substructure in URIs is often problematic.<a href="#section-abstract-1" class="pilcrow">¶</a></p>
1183 <p id="section-abstract-2">This document provides guidance on the specification of URI
1184 substructure in standards.<a href="#section-abstract-2" class="pilcrow">¶</a></p>
1185 <p id="section-abstract-3">This document obsoletes RFC 7320 and updates RFC 3986.<a href="#section-abstract-3" class="pilcrow">¶</a></p>
1186 </section>
1187 <div id="status-of-memo">
1188 <section id="section-boilerplate.1">
1189 <h2 id="name-status-of-this-memo">
1190 <a href="#name-status-of-this-memo" class="section-name selfRef">Status of This Memo</a>
1191 </h2>
1192 <p id="section-boilerplate.1-1">
1193 This memo documents an Internet Best Current Practice.<a href="#section-boilerplate.1-1" class="pilcrow">¶</a></p>
1194 <p id="section-boilerplate.1-2">
1195 This document is a product of the Internet Engineering Task Force
1196 (IETF). It represents the consensus of the IETF community. It has
1197 received public review and has been approved for publication by
1198 the Internet Engineering Steering Group (IESG). Further information
1199 on BCPs is available in Section 2 of RFC 7841.<a href="#section-boilerplate.1-2" class="pilcrow">¶</a></p>
1200 <p id="section-boilerplate.1-3">
1201 Information about the current status of this document, any
1202 errata, and how to provide feedback on it may be obtained at
1203 <span><a href="https://www.rfc-editor.org/info/rfc8820">https://www.rfc-editor.org/info/rfc8820</a></span>.<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
1204 </section>
1205 </div>
1206 <div id="copyright">
1207 <section id="section-boilerplate.2">
1208 <h2 id="name-copyright-notice">
1209 <a href="#name-copyright-notice" class="section-name selfRef">Copyright Notice</a>
1210 </h2>
1211 <p id="section-boilerplate.2-1">
1212 Copyright (c) 2020 IETF Trust and the persons identified as the
1213 document authors. All rights reserved.<a href="#section-boilerplate.2-1" class="pilcrow">¶</a></p>
1214 <p id="section-boilerplate.2-2">
1215 This document is subject to BCP 78 and the IETF Trust's Legal
1216 Provisions Relating to IETF Documents
1217 (<span><a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a></span>) in effect on the date of
1218 publication of this document. Please review these documents
1219 carefully, as they describe your rights and restrictions with
1220 respect to this document. Code Components extracted from this
1221 document must include Simplified BSD License text as described in
1222 Section 4.e of the Trust Legal Provisions and are provided without
1223 warranty as described in the Simplified BSD License.<a href="#section-boilerplate.2-2" class="pilcrow">¶</a></p>
1224 </section>
1225 </div>
1226 <div id="toc">
1227 <section id="section-toc.1">
1228 <a href="#" onclick="scroll(0,0)" class="toplink">▲</a><h2 id="name-table-of-contents">
1229 <a href="#name-table-of-contents" class="section-name selfRef">Table of Contents</a>
1230 </h2>
1231 <nav class="toc"><ul class="compact ulEmpty toc">
1232 <li class="compact ulEmpty toc" id="section-toc.1-1.1">
1233 <p id="section-toc.1-1.1.1" class="keepWithNext"><a href="#section-1" class="xref">1</a>.  <a href="#name-introduction" class="xref">Introduction</a><a href="#section-toc.1-1.1.1" class="pilcrow">¶</a></p>
1234 <ul class="compact ulEmpty toc">
1235 <li class="compact ulEmpty toc" id="section-toc.1-1.1.2.1">
1236 <p id="section-toc.1-1.1.2.1.1" class="keepWithNext"><a href="#section-1.1" class="xref">1.1</a>.  <a href="#name-intended-audience" class="xref">Intended Audience</a><a href="#section-toc.1-1.1.2.1.1" class="pilcrow">¶</a></p>
1237 </li>
1238 <li class="compact ulEmpty toc" id="section-toc.1-1.1.2.2">
1239 <p id="section-toc.1-1.1.2.2.1" class="keepWithNext"><a href="#section-1.2" class="xref">1.2</a>.  <a href="#name-notational-conventions" class="xref">Notational Conventions</a><a href="#section-toc.1-1.1.2.2.1" class="pilcrow">¶</a></p>
1240 </li>
1241 </ul>
1242 </li>
1243 <li class="compact ulEmpty toc" id="section-toc.1-1.2">
1244 <p id="section-toc.1-1.2.1"><a href="#section-2" class="xref">2</a>.  <a href="#name-best-current-practices-for-" class="xref">Best Current Practices for Standardizing Structured URIs</a><a href="#section-toc.1-1.2.1" class="pilcrow">¶</a></p>
1245 <ul class="compact ulEmpty toc">
1246 <li class="compact ulEmpty toc" id="section-toc.1-1.2.2.1">
1247 <p id="section-toc.1-1.2.2.1.1"><a href="#section-2.1" class="xref">2.1</a>.  <a href="#name-uri-schemes" class="xref">URI Schemes</a><a href="#section-toc.1-1.2.2.1.1" class="pilcrow">¶</a></p>
1248 </li>
1249 <li class="compact ulEmpty toc" id="section-toc.1-1.2.2.2">
1250 <p id="section-toc.1-1.2.2.2.1"><a href="#section-2.2" class="xref">2.2</a>.  <a href="#name-uri-authorities" class="xref">URI Authorities</a><a href="#section-toc.1-1.2.2.2.1" class="pilcrow">¶</a></p>
1251 </li>
1252 <li class="compact ulEmpty toc" id="section-toc.1-1.2.2.3">
1253 <p id="section-toc.1-1.2.2.3.1"><a href="#section-2.3" class="xref">2.3</a>.  <a href="#name-uri-paths" class="xref">URI Paths</a><a href="#section-toc.1-1.2.2.3.1" class="pilcrow">¶</a></p>
1254 </li>
1255 <li class="compact ulEmpty toc" id="section-toc.1-1.2.2.4">
1256 <p id="section-toc.1-1.2.2.4.1"><a href="#section-2.4" class="xref">2.4</a>.  <a href="#name-uri-queries" class="xref">URI Queries</a><a href="#section-toc.1-1.2.2.4.1" class="pilcrow">¶</a></p>
1257 </li>
1258 <li class="compact ulEmpty toc" id="section-toc.1-1.2.2.5">
1259 <p id="section-toc.1-1.2.2.5.1"><a href="#section-2.5" class="xref">2.5</a>.  <a href="#name-uri-fragment-identifiers" class="xref">URI Fragment Identifiers</a><a href="#section-toc.1-1.2.2.5.1" class="pilcrow">¶</a></p>
1260 </li>
1261 </ul>
1262 </li>
1263 <li class="compact ulEmpty toc" id="section-toc.1-1.3">
1264 <p id="section-toc.1-1.3.1"><a href="#section-3" class="xref">3</a>.  <a href="#name-alternatives-to-specifying-" class="xref">Alternatives to Specifying Structure in URIs</a><a href="#section-toc.1-1.3.1" class="pilcrow">¶</a></p>
1265 </li>
1266 <li class="compact ulEmpty toc" id="section-toc.1-1.4">
1267 <p id="section-toc.1-1.4.1"><a href="#section-4" class="xref">4</a>.  <a href="#name-security-considerations" class="xref">Security Considerations</a><a href="#section-toc.1-1.4.1" class="pilcrow">¶</a></p>
1268 </li>
1269 <li class="compact ulEmpty toc" id="section-toc.1-1.5">
1270 <p id="section-toc.1-1.5.1"><a href="#section-5" class="xref">5</a>.  <a href="#name-iana-considerations" class="xref">IANA Considerations</a><a href="#section-toc.1-1.5.1" class="pilcrow">¶</a></p>
1271 </li>
1272 <li class="compact ulEmpty toc" id="section-toc.1-1.6">
1273 <p id="section-toc.1-1.6.1"><a href="#section-6" class="xref">6</a>.  <a href="#name-references" class="xref">References</a><a href="#section-toc.1-1.6.1" class="pilcrow">¶</a></p>
1274 <ul class="compact ulEmpty toc">
1275 <li class="compact ulEmpty toc" id="section-toc.1-1.6.2.1">
1276 <p id="section-toc.1-1.6.2.1.1"><a href="#section-6.1" class="xref">6.1</a>.  <a href="#name-normative-references" class="xref">Normative References</a><a href="#section-toc.1-1.6.2.1.1" class="pilcrow">¶</a></p>
1277 </li>
1278 <li class="compact ulEmpty toc" id="section-toc.1-1.6.2.2">
1279 <p id="section-toc.1-1.6.2.2.1"><a href="#section-6.2" class="xref">6.2</a>.  <a href="#name-informative-references" class="xref">Informative References</a><a href="#section-toc.1-1.6.2.2.1" class="pilcrow">¶</a></p>
1280 </li>
1281 </ul>
1282 </li>
1283 <li class="compact ulEmpty toc" id="section-toc.1-1.7">
1284 <p id="section-toc.1-1.7.1"><a href="#section-appendix.a" class="xref">Appendix A</a>.  <a href="#name-changes-from-rfc-7320" class="xref">Changes from RFC 7320</a><a href="#section-toc.1-1.7.1" class="pilcrow">¶</a></p>
1285 </li>
1286 <li class="compact ulEmpty toc" id="section-toc.1-1.8">
1287 <p id="section-toc.1-1.8.1"><a href="#section-appendix.b" class="xref"></a><a href="#name-acknowledgments" class="xref">Acknowledgments</a><a href="#section-toc.1-1.8.1" class="pilcrow">¶</a></p>
1288 </li>
1289 <li class="compact ulEmpty toc" id="section-toc.1-1.9">
1290 <p id="section-toc.1-1.9.1"><a href="#section-appendix.c" class="xref"></a><a href="#name-authors-address" class="xref">Author's Address</a><a href="#section-toc.1-1.9.1" class="pilcrow">¶</a></p>
1291 </li>
1292 </ul>
1293 </nav>
1294 </section>
1295 </div>
1296 <div id="intro">
1297 <section id="section-1">
1298 <h2 id="name-introduction">
1299 <a href="#section-1" class="section-number selfRef">1. </a><a href="#name-introduction" class="section-name selfRef">Introduction</a>
1300 </h2>
1301 <p id="section-1-1">URIs <span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> very often include
1302 structured application data. This might include artifacts from
1303 filesystems (often occurring in the path component) and user information
1304 (often in the query component). In some cases, there can even be
1305 application-specific data in the authority component (e.g., some
1306 applications are spread across several hostnames to enable a form of
1307 partitioning or dispatch).<a href="#section-1-1" class="pilcrow">¶</a></p>
1308 <p id="section-1-2">Implementations can impose further constraints upon the structure of
1309 URIs; for example, many web servers use the filename extension of the
1310 last path segment to determine the media type of the response. Likewise,
1311 prepackaged applications often have highly structured URIs that can only
1312 be changed in limited ways (often, just the hostname and port on which
1313 they are deployed).<a href="#section-1-2" class="pilcrow">¶</a></p>
1314 <p id="section-1-3">Because the owner of the URI (as defined in <span>[<a href="#webarch" class="xref">webarch</a>]</span>, Section 2.2.2.1) is choosing to use the
1315 server or the application, this can be seen as reasonable delegation of authority. However, when
1316 such conventions are mandated by a party other than the owner, it can have several potentially
1317 detrimental effects:<a href="#section-1-3" class="pilcrow">¶</a></p>
1318 <ul class="normal">
1319 <li class="normal" id="section-1-4.1">Collisions - As more ad hoc conventions for URI structure become standardized, it becomes more
1320 likely that there will be collisions between them (especially considering that servers,
1321 applications, and individual deployments will have their own conventions).<a href="#section-1-4.1" class="pilcrow">¶</a>
1322 </li>
1323 <li class="normal" id="section-1-4.2">Dilution - When the information added to a URI is ephemeral, this dilutes its utility by reducing
1324 its stability (see <span>[<a href="#webarch" class="xref">webarch</a>]</span>, Section 3.5.1) and can cause several alternate forms of the URI
1325 to exist (see <span>[<a href="#webarch" class="xref">webarch</a>]</span>, Section 2.3.1).<a href="#section-1-4.2" class="pilcrow">¶</a>
1326 </li>
1327 <li class="normal" id="section-1-4.3">Rigidity - Fixed URI syntax often interferes with desired deployment patterns. For example, if an
1328 authority wishes to offer several applications on a single hostname, it becomes difficult to
1329 impossible to do if their URIs do not allow the required flexibility.<a href="#section-1-4.3" class="pilcrow">¶</a>
1330 </li>
1331 <li class="normal" id="section-1-4.4">Operational Difficulty - Supporting some URI conventions can be difficult in some
1332 implementations. For example, specifying that a particular query parameter be used with "http"
1333 URIs can preclude the use of web servers that serve the response from a filesystem. Likewise, an
1334 application that fixes a base path for its operation (e.g., "/v1") makes it impossible to deploy
1335 other applications with the same prefix on the same host.<a href="#section-1-4.4" class="pilcrow">¶</a>
1336 </li>
1337 <li class="normal" id="section-1-4.5">Client Assumptions - When conventions are standardized, some clients will inevitably assume that
1338 the standards are in use when those conventions are seen. This can lead to interoperability
1339 problems; for example, if a specification documents that the "sig" URI query parameter indicates
1340 that its payload is a cryptographic signature for the URI, it can lead to undesirable behavior.<a href="#section-1-4.5" class="pilcrow">¶</a>
1341 </li>
1342 </ul>
1343 <p id="section-1-5">Publishing a standard that constrains an existing URI structure in ways that aren't explicitly
1344 allowed by <span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> (usually, by updating the URI scheme definition) is therefore sometimes
1345 problematic, both for these reasons and because the structure of a URI needs to be firmly under
1346 the control of its owner.<a href="#section-1-5" class="pilcrow">¶</a></p>
1347 <p id="section-1-6">This document explains some best current practices for establishing URI structures, conventions, and
1348 formats in standards. It also offers strategies for specifications in <a href="#alternatives" class="xref">Section 3</a>.<a href="#section-1-6" class="pilcrow">¶</a></p>
1349 <div id="intended-audience">
1350 <section id="section-1.1">
1351 <h3 id="name-intended-audience">
1352 <a href="#section-1.1" class="section-number selfRef">1.1. </a><a href="#name-intended-audience" class="section-name selfRef">Intended Audience</a>
1353 </h3>
1354 <p id="section-1.1-1">This document's guidelines and requirements target the authors of specifications that constrain the
1355 syntax or structure of URIs or parts of them. Two classes of such specifications are called out
1356 specifically:<a href="#section-1.1-1" class="pilcrow">¶</a></p>
1357 <ul class="normal">
1358 <li class="normal" id="section-1.1-2.1">Protocol Extensions ("Extensions") - specifications that offer new capabilities that could apply
1359 to any identifier or to a large subset of possible identifiers, e.g., a new signature mechanism
1360 for "http" URIs, metadata for any URI, or a new format.<a href="#section-1.1-2.1" class="pilcrow">¶</a>
1361 </li>
1362 <li class="normal" id="section-1.1-2.2">Applications Using URIs ("Applications") - specifications that
1363 use URIs to meet specific needs,
1364 e.g., an HTTP interface to particular information on a host.<a href="#section-1.1-2.2" class="pilcrow">¶</a>
1365 </li>
1366 </ul>
1367 <p id="section-1.1-3">Requirements that target the generic class "Specifications" apply to all specifications, including
1368 both those enumerated above and others.<a href="#section-1.1-3" class="pilcrow">¶</a></p>
1369 <p id="section-1.1-4">Note that this specification ought not be interpreted as preventing the allocation of control of
1370 URIs by parties that legitimately own them or have delegated that ownership; for example, a
1371 specification might legitimately define the semantics of a URI on IANA's web site as part of
1372 the establishment of a registry.<a href="#section-1.1-4" class="pilcrow">¶</a></p>
1373 <p id="section-1.1-5">There may be existing IETF specifications that already deviate from the guidance in this document.
1374 In these cases, it is up to the relevant communities (i.e., those of the URI
1375 scheme as well as any relevant community that
1376 produced the specification in question) to determine an appropriate outcome, e.g., updating
1377 the scheme definition or changing the specification.<a href="#section-1.1-5" class="pilcrow">¶</a></p>
1378 </section>
1379 </div>
1380 <div id="notational-conventions">
1381 <section id="section-1.2">
1382 <h3 id="name-notational-conventions">
1383 <a href="#section-1.2" class="section-number selfRef">1.2. </a><a href="#name-notational-conventions" class="section-name selfRef">Notational Conventions</a>
1384 </h3>
1385 <p id="section-1.2-1">The key words "<span class="bcp14">MUST</span>", "<span class="bcp14">MUST NOT</span>",
1386 "<span class="bcp14">REQUIRED</span>", "<span class="bcp14">SHALL</span>",
1387 "<span class="bcp14">SHALL NOT</span>", "<span class="bcp14">SHOULD</span>",
1388 "<span class="bcp14">SHOULD NOT</span>",
1389 "<span class="bcp14">RECOMMENDED</span>", "<span class="bcp14">NOT RECOMMENDED</span>",
1390 "<span class="bcp14">MAY</span>", and "<span class="bcp14">OPTIONAL</span>" in this document
1391 are to be interpreted as described in BCP 14
1392 <span>[<a href="#RFC2119" class="xref">RFC2119</a>]</span> <span>[<a href="#RFC8174" class="xref">RFC8174</a>]</span> when, and only
1393 when, they appear in all capitals, as shown here.<a href="#section-1.2-1" class="pilcrow">¶</a></p>
1394 </section>
1395 </div>
1396 </section>
1397 </div>
1398 <div id="best-current-practices-for-standardizing-structured-uris">
1399 <section id="section-2">
1400 <h2 id="name-best-current-practices-for-">
1401 <a href="#section-2" class="section-number selfRef">2. </a><a href="#name-best-current-practices-for-" class="section-name selfRef">Best Current Practices for Standardizing Structured URIs</a>
1402 </h2>
1403 <p id="section-2-1">This section updates <span>[<a href="#RFC3986" class="xref">RFC3986</a>]</span> by advising Specifications how they should define structure and
1404 semantics within URIs. Best practices differ, depending on the URI component in question, as
1405 described below.<a href="#section-2-1" class="pilcrow">¶</a></p>
1406 <div id="uri-schemes">
1407 <section id="section-2.1">
1408 <h3 id="name-uri-schemes">
1409 <a href="#section-2.1" class="section-number selfRef">2.1. </a><a href="#name-uri-schemes" class="section-name selfRef">URI Schemes</a>
1410 </h3>
1411 <p id="section-2.1-1">Applications and Extensions can require the use of one or more specific URI schemes; for example, it is perfectly
1412 acceptable to require that an Application support "http" and "https" URIs. However, Applications
1413 ought not preclude the use of other URI schemes in the future, unless they are clearly only usable
1414 with the nominated schemes.<a href="#section-2.1-1" class="pilcrow">¶</a></p>
1415 <p id="section-2.1-2">A Specification that defines substructure for URI schemes overall (e.g., a prefix or suffix for URI
1416 scheme names) <span class="bcp14">MUST</span> do so by modifying <span>[<a href="#BCP35" class="xref">BCP35</a>]</span> (an exceptional circumstance).<a href="#section-2.1-2" class="pilcrow">¶</a></p>
1417 </section>
1418 </div>
1419 <div id="uri-authorities">
1420 <section id="section-2.2">
1421 <h3 id="name-uri-authorities">
1422 <a href="#section-2.2" class="section-number selfRef">2.2. </a><a href="#name-uri-authorities" class="section-name selfRef">URI Authorities</a>
1423 </h3>
1424 <p id="section-2.2-1">Scheme definitions define the presence, format, and semantics of an
1425 authority component in URIs; all other Specifications <span class="bcp14">MUST NOT</span> constrain or define the structure or the semantics for URI
1426 authorities, unless they update the scheme registration itself or the
1427 structures it relies upon (e.g., DNS name syntax, as defined in <span><a href="https://www.rfc-editor.org/rfc/rfc1034#section-3.5" class="relref">Section 3.5</a> of [<a href="#RFC1034" class="xref">RFC1034</a>]</span>).<a href="#section-2.2-1" class="pilcrow">¶</a></p>
1428 <p id="section-2.2-2">For example, an Extension or Application cannot say that the "foo" prefix in
1429 "https://foo_app.example.com" is meaningful or triggers special handling in
1430 URIs, unless they update either the "http" URI scheme or the DNS hostname
1431 syntax.<a href="#section-2.2-2" class="pilcrow">¶</a></p>
1432 <p id="section-2.2-3">Applications can nominate or constrain the port they use, when applicable. For example,
1433 BarApp could run over port nnnn (provided that it is properly registered).<a href="#section-2.2-3" class="pilcrow">¶</a></p>
1434 </section>
1435 </div>
1436 <div id="uri-paths">
1437 <section id="section-2.3">
1438 <h3 id="name-uri-paths">
1439 <a href="#section-2.3" class="section-number selfRef">2.3. </a><a href="#name-uri-paths" class="section-name selfRef">URI Paths</a>
1440 </h3>
1441 <p id="section-2.3-1">Scheme definitions define the presence, format, and semantics of a path component in URIs, although these are often delegated to the Application(s) in a given deployment.<a href="#section-2.3-1" class="pilcrow">¶</a></p>
1442 <p id="section-2.3-2">To avoid collisions, rigidity, and erroneous client assumptions, Specifications <span class="bcp14">MUST NOT</span> define a
1443 fixed prefix for their URI paths -- for example, "/myapp" -- unless allowed by the scheme definition.<a href="#section-2.3-2" class="pilcrow">¶</a></p>
1444 <p id="section-2.3-3">One such exception to this requirement is registered "well-known" URIs, as specified by
1445 <span>[<a href="#RFC8615" class="xref">RFC8615</a>]</span>. See that document for a description of the applicability of that mechanism.<a href="#section-2.3-3" class="pilcrow">¶</a></p>
1446 <p id="section-2.3-4">Note that this does not apply to Applications defining a structure
1447 of a URI's path "under" a resource
1448 controlled by the server. Because the prefix is under control of the party deploying the
1449 Application, collisions and rigidity are avoided, and the risk of erroneous client assumptions is
1450 reduced.<a href="#section-2.3-4" class="pilcrow">¶</a></p>
1451 <p id="section-2.3-5">For example, an Application might define "app_root" as a deployment-controlled URI prefix.
1452 Application-defined resources might then be assumed to be present at "{app_root}/foo" and
1453 "{app_root}/bar".<a href="#section-2.3-5" class="pilcrow">¶</a></p>
1454 <p id="section-2.3-6">Extensions <span class="bcp14">MUST NOT</span> define a structure within individual URI components (e.g., a prefix or suffix),
1455 again to avoid collisions and erroneous client assumptions.<a href="#section-2.3-6" class="pilcrow">¶</a></p>
1456 </section>
1457 </div>
1458 <div id="uri-queries">
1459 <section id="section-2.4">
1460 <h3 id="name-uri-queries">
1461 <a href="#section-2.4" class="section-number selfRef">2.4. </a><a href="#name-uri-queries" class="section-name selfRef">URI Queries</a>
1462 </h3>
1463 <p id="section-2.4-1">The presence, format, and semantics of the query component of URIs are dependent upon many factors
1464 and can be constrained by a scheme definition. Often, they are determined by the implementation of
1465 a resource itself.<a href="#section-2.4-1" class="pilcrow">¶</a></p>
1466 <p id="section-2.4-2">Applications can specify the syntax of queries for the resources under their control. However,
1467 doing so can cause operational difficulties for deployments that do not support a particular form
1468 of a query. For example, a site may wish to support an Application using "static" files that do not
1469 support query parameters.<a href="#section-2.4-2" class="pilcrow">¶</a></p>
1470 <p id="section-2.4-3">Extensions <span class="bcp14">MUST NOT</span> constrain the format or semantics of queries, to avoid collisions and erroneous
1471 client assumptions. For example, an Extension that indicates that all query parameters with the
1472 name "sig" indicate a cryptographic signature would collide with potentially preexisting query
1473 parameters on sites and lead clients to assume that any matching query parameter is a signature.<a href="#section-2.4-3" class="pilcrow">¶</a></p>
1474 <p id="section-2.4-4">Per the "Form submission" section of <span>[<a href="#HTML5" class="xref">HTML5</a>]</span>, HTML constrains the syntax of
1475 query strings used in form submission.
1476 New form languages are encouraged to allow creation of a broader variety of URIs
1477 (e.g., by allowing the form to create new path components, and so forth).<a href="#section-2.4-4" class="pilcrow">¶</a></p>
1478 </section>
1479 </div>
1480 <div id="uri-fragment-identifiers">
1481 <section id="section-2.5">
1482 <h3 id="name-uri-fragment-identifiers">
1483 <a href="#section-2.5" class="section-number selfRef">2.5. </a><a href="#name-uri-fragment-identifiers" class="section-name selfRef">URI Fragment Identifiers</a>
1484 </h3>
1485 <p id="section-2.5-1"><span><a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.5" class="relref">Section 3.5</a> of [<a href="#RFC3986" class="xref">RFC3986</a>]</span> specifies fragment identifiers' syntax and semantics as being dependent
1486 upon the media type of a potentially retrieved resource. As a result, other Specifications <span class="bcp14">MUST NOT</span>
1487 define structure within the fragment identifier, unless they are explicitly defining one for reuse
1488 by media types in their definitions (for example, as JSON Pointer <span>[<a href="#RFC6901" class="xref">RFC6901</a>]</span> does).<a href="#section-2.5-1" class="pilcrow">¶</a></p>
1489 <p id="section-2.5-2">An Application that defines common fragment identifiers across media types not
1490 controlled by it would engender interoperability problems with handlers for those media types
1491 (because the new, non-standard syntax is not expected).<a href="#section-2.5-2" class="pilcrow">¶</a></p>
1492 </section>
1493 </div>
1494 </section>
1495 </div>
1496 <div id="alternatives">
1497 <section id="section-3">
1498 <h2 id="name-alternatives-to-specifying-">
1499 <a href="#section-3" class="section-number selfRef">3. </a><a href="#name-alternatives-to-specifying-" class="section-name selfRef">Alternatives to Specifying Structure in URIs</a>
1500 </h2>
1501 <p id="section-3-1">Given the issues described in <a href="#intro" class="xref">Section 1</a>, the most successful strategy for Applications and
1502 Extensions that wish to use URIs is to use them in the fashion for which they were designed: as links that
1503 are exchanged as part of the protocol, rather than statically specified syntax. Several existing
1504 specifications can aid in this.<a href="#section-3-1" class="pilcrow">¶</a></p>
1505 <p id="section-3-2"><span>[<a href="#RFC8288" class="xref">RFC8288</a>]</span> specifies relation types for web links. By providing a framework for linking on the
1506 Web, where every link has a relation type, context, and target, it allows Applications to define a
1507 link's semantics and connectivity.<a href="#section-3-2" class="pilcrow">¶</a></p>
1508 <p id="section-3-3"><span>[<a href="#RFC6570" class="xref">RFC6570</a>]</span> provides a standard syntax for URI Templates that can be used to dynamically insert
1509 Application-specific variables into a URI to enable such Applications while avoiding impinging upon
1510 URI owners' control of them.<a href="#section-3-3" class="pilcrow">¶</a></p>
1511 <p id="section-3-4"><span>[<a href="#RFC8615" class="xref">RFC8615</a>]</span> allows specific paths to be "reserved" for standard use on URI schemes that opt into
1512 that mechanism ("http" and "https" by default). Note, however, that this is not a general "escape
1513 valve" for Applications that need structured URIs; see that specification for more information.<a href="#section-3-4" class="pilcrow">¶</a></p>
1514 <p id="section-3-5">Specifying more elaborate structures in an attempt to avoid collisions is not an acceptable
1515 solution and does not address the issues described in <a href="#intro" class="xref">Section 1</a>. For example, prefixing query parameters
1516 with "myapp_" does not help, because the prefix itself is subject to the risk of collision (since
1517 it is not "reserved").<a href="#section-3-5" class="pilcrow">¶</a></p>
1518 </section>
1519 </div>
1520 <div id="security-considerations">
1521 <section id="section-4">
1522 <h2 id="name-security-considerations">
1523 <a href="#section-4" class="section-number selfRef">4. </a><a href="#name-security-considerations" class="section-name selfRef">Security Considerations</a>
1524 </h2>
1525 <p id="section-4-1">This document does not introduce new protocol artifacts with security considerations. It prohibits
1526 some practices that might lead to vulnerabilities; for example, if a security-sensitive mechanism
1527 is introduced by assuming that a URI path component or query string has a particular meaning, false
1528 positives might be encountered (due to sites that already use the chosen string). See also
1529 <span>[<a href="#RFC6943" class="xref">RFC6943</a>]</span>.<a href="#section-4-1" class="pilcrow">¶</a></p>
1530 </section>
1531 </div>
1532 <div id="iana-considerations">
1533 <section id="section-5">
1534 <h2 id="name-iana-considerations">
1535 <a href="#section-5" class="section-number selfRef">5. </a><a href="#name-iana-considerations" class="section-name selfRef">IANA Considerations</a>
1536 </h2>
1537 <p id="section-5-1">This document has no IANA actions.<a href="#section-5-1" class="pilcrow">¶</a></p>
1538 </section>
1539 </div>
1540 <section id="section-6">
1541 <h2 id="name-references">
1542 <a href="#section-6" class="section-number selfRef">6. </a><a href="#name-references" class="section-name selfRef">References</a>
1543 </h2>
1544 <section id="section-6.1">
1545 <h3 id="name-normative-references">
1546 <a href="#section-6.1" class="section-number selfRef">6.1. </a><a href="#name-normative-references" class="section-name selfRef">Normative References</a>
1547 </h3>
1548 <dl class="references">
1549 <dt id="RFC2119">[RFC2119]</dt>
1550 <dd>
1551 <span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;</span>. </dd>
1552 <dd class="break"></dd>
1553 <dt id="RFC3986">[RFC3986]</dt>
1554 <dd>
1555 <span class="refAuthor">Berners-Lee, T.</span><span class="refAuthor">, Fielding, R.</span><span class="refAuthor">, and L. Masinter</span>, <span class="refTitle">"Uniform Resource Identifier (URI): Generic Syntax"</span>, <span class="seriesInfo">STD 66</span>, <span class="seriesInfo">RFC 3986</span>, <span class="seriesInfo">DOI 10.17487/RFC3986</span>, <time datetime="2005-01" class="refDate">January 2005</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc3986">https://www.rfc-editor.org/info/rfc3986</a>&gt;</span>. </dd>
1556 <dd class="break"></dd>
1557 <dt id="RFC8174">[RFC8174]</dt>
1558 <dd>
1559 <span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>&gt;</span>. </dd>
1560 <dd class="break"></dd>
1561 <dt id="webarch">[webarch]</dt>
1562 <dd>
1563 <span class="refAuthor">Jacobs, I.</span><span class="refAuthor"> and N. Walsh</span>, <span class="refTitle">"Architecture of the World Wide Web, Volume One"</span>, <time datetime="2004-12" class="refDate">December 2004</time>, <span>&lt;<a href="https://www.w3.org/TR/2004/REC-webarch-20041215">https://www.w3.org/TR/2004/REC-webarch-20041215</a>&gt;</span>. </dd>
1564 <dd class="break"></dd>
1565 </dl>
1566 </section>
1567 <section id="section-6.2">
1568 <h3 id="name-informative-references">
1569 <a href="#section-6.2" class="section-number selfRef">6.2. </a><a href="#name-informative-references" class="section-name selfRef">Informative References</a>
1570 </h3>
1571 <dl class="references">
1572 <dt id="BCP35">[BCP35]</dt>
1573 <dd>
1574 <span class="refAuthor">Thaler, D., Ed.</span><span class="refAuthor">, Hansen, T.</span><span class="refAuthor">, and T. Hardie</span>, <span class="refTitle">"Guidelines and Registration Procedures for New URI Schemes"</span>, <span class="seriesInfo">BCP 35</span>, <span class="seriesInfo">RFC 7595</span>, <time datetime="2015-06" class="refDate">June 2015</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/bcp35">https://www.rfc-editor.org/info/bcp35</a>&gt;</span>. </dd>
1575 <dd class="break"></dd>
1576 <dt id="HTML5">[HTML5]</dt>
1577 <dd>
1578 <span class="refAuthor">WHATWG</span>, <span class="refTitle">"HTML - Living Standard"</span>, <span class="refContent">Section 4.10.21</span>, <time datetime="2020-06" class="refDate">June 2020</time>, <span>&lt;<a href="https://html.spec.whatwg.org/#form-submission">https://html.spec.whatwg.org/#form-submission</a>&gt;</span>. </dd>
1579 <dd class="break"></dd>
1580 <dt id="RFC1034">[RFC1034]</dt>
1581 <dd>
1582 <span class="refAuthor">Mockapetris, P.</span>, <span class="refTitle">"Domain names - concepts and facilities"</span>, <span class="seriesInfo">STD 13</span>, <span class="seriesInfo">RFC 1034</span>, <span class="seriesInfo">DOI 10.17487/RFC1034</span>, <time datetime="1987-11" class="refDate">November 1987</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc1034">https://www.rfc-editor.org/info/rfc1034</a>&gt;</span>. </dd>
1583 <dd class="break"></dd>
1584 <dt id="RFC6570">[RFC6570]</dt>
1585 <dd>
1586 <span class="refAuthor">Gregorio, J.</span><span class="refAuthor">, Fielding, R.</span><span class="refAuthor">, Hadley, M.</span><span class="refAuthor">, Nottingham, M.</span><span class="refAuthor">, and D. Orchard</span>, <span class="refTitle">"URI Template"</span>, <span class="seriesInfo">RFC 6570</span>, <span class="seriesInfo">DOI 10.17487/RFC6570</span>, <time datetime="2012-03" class="refDate">March 2012</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6570">https://www.rfc-editor.org/info/rfc6570</a>&gt;</span>. </dd>
1587 <dd class="break"></dd>
1588 <dt id="RFC6901">[RFC6901]</dt>
1589 <dd>
1590 <span class="refAuthor">Bryan, P., Ed.</span><span class="refAuthor">, Zyp, K.</span><span class="refAuthor">, and M. Nottingham, Ed.</span>, <span class="refTitle">"JavaScript Object Notation (JSON) Pointer"</span>, <span class="seriesInfo">RFC 6901</span>, <span class="seriesInfo">DOI 10.17487/RFC6901</span>, <time datetime="2013-04" class="refDate">April 2013</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6901">https://www.rfc-editor.org/info/rfc6901</a>&gt;</span>. </dd>
1591 <dd class="break"></dd>
1592 <dt id="RFC6943">[RFC6943]</dt>
1593 <dd>
1594 <span class="refAuthor">Thaler, D., Ed.</span>, <span class="refTitle">"Issues in Identifier Comparison for Security Purposes"</span>, <span class="seriesInfo">RFC 6943</span>, <span class="seriesInfo">DOI 10.17487/RFC6943</span>, <time datetime="2013-05" class="refDate">May 2013</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6943">https://www.rfc-editor.org/info/rfc6943</a>&gt;</span>. </dd>
1595 <dd class="break"></dd>
1596 <dt id="RFC8288">[RFC8288]</dt>
1597 <dd>
1598 <span class="refAuthor">Nottingham, M.</span>, <span class="refTitle">"Web Linking"</span>, <span class="seriesInfo">RFC 8288</span>, <span class="seriesInfo">DOI 10.17487/RFC8288</span>, <time datetime="2017-10" class="refDate">October 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8288">https://www.rfc-editor.org/info/rfc8288</a>&gt;</span>. </dd>
1599 <dd class="break"></dd>
1600 <dt id="RFC8615">[RFC8615]</dt>
1601 <dd>
1602 <span class="refAuthor">Nottingham, M.</span>, <span class="refTitle">"Well-Known Uniform Resource Identifiers (URIs)"</span>, <span class="seriesInfo">RFC 8615</span>, <span class="seriesInfo">DOI 10.17487/RFC8615</span>, <time datetime="2019-05" class="refDate">May 2019</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8615">https://www.rfc-editor.org/info/rfc8615</a>&gt;</span>. </dd>
1603 <dd class="break"></dd>
1604 </dl>
1605 </section>
1606 </section>
1607 <div id="changes-from-rfc7320">
1608 <section id="section-appendix.a">
1609 <h2 id="name-changes-from-rfc-7320">
1610 <a href="#section-appendix.a" class="section-number selfRef">Appendix A. </a><a href="#name-changes-from-rfc-7320" class="section-name selfRef">Changes from RFC 7320</a>
1611 </h2>
1612 <p id="section-appendix.a-1">Many of the requirements of RFC 7320 were removed, in the spirit of making this BCP guidance rather than rules.<a href="#section-appendix.a-1" class="pilcrow">¶</a></p>
1613 </section>
1614 </div>
1615 <div id="acknowledgments">
1616 <section id="section-appendix.b">
1617 <h2 id="name-acknowledgments">
1618 <a href="#name-acknowledgments" class="section-name selfRef">Acknowledgments</a>
1619 </h2>
1620 <p id="section-appendix.b-1">Thanks to <span class="contact-name">David Booth</span>, <span class="contact-name">Dave Crocker</span>, <span class="contact-name">Tim Bray</span>, <span class="contact-name">Anne van Kesteren</span>, <span class="contact-name">Martin Thomson</span>, <span class="contact-name">Erik Wilde</span>, <span class="contact-name">Dave Thaler</span>, and <span class="contact-name">Barry Leiba</span> for their suggestions and feedback.<a href="#section-appendix.b-1" class="pilcrow">¶</a></p>
1621 </section>
1622 </div>
1623 <div id="authors-addresses">
1624 <section id="section-appendix.c">
1625 <h2 id="name-authors-address">
1626 <a href="#name-authors-address" class="section-name selfRef">Author's Address</a>
1627 </h2>
1628 <address class="vcard">
1629 <div dir="auto" class="left"><span class="fn nameRole">Mark Nottingham</span></div>
1630 <div class="email">
1631 <span>Email:</span>
1632 <a href="mailto:[email protected]" class="email">[email protected]</a>
1633 </div>
1634 <div class="url">
1635 <span>URI:</span>
1636 <a href="https://www.mnot.net/" class="url">https://www.mnot.net/</a>
1637 </div>
1638 </address>
1639 </section>
1640 </div>
1641 <script>const toc = document.getElementById("toc");
1642 toc.querySelector("h2").addEventListener("click", e => {
1643 toc.classList.toggle("active");
1644 });
1645 toc.querySelector("nav").addEventListener("click", e => {
1646 toc.classList.remove("active");
1647 });
1648 </script>
1649 </body>
1650 </html>