Skip to content

Commit 78d6787

Browse files
committed
Fix the doc issues in url_atteibutes.h
1 parent 7a210ec commit 78d6787

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

api/include/opentelemetry/semconv/url_attributes.h

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ namespace url
2525
static constexpr const char *kUrlFragment = "url.fragment";
2626

2727
/**
28-
* Absolute URL describing a network resource according to <a
29-
* href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986</a> <p> For network calls, URL usually has
28+
* Absolute URL describing a network resource according to
29+
* <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986</a> <p> For network calls, URL usually has
3030
* @code scheme://host[:port][path][?query][#fragment] @endcode format, where the fragment is not
3131
* transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. <p>
3232
* @code url.full @endcode MUST NOT contain credentials passed via URL in form of @code
@@ -40,15 +40,14 @@ static constexpr const char *kUrlFragment = "url.fragment";
4040
* Query string values for the following keys SHOULD be redacted by default and replaced by the
4141
* value @code REDACTED @endcode:
4242
* <ul>
43-
* <li><a
44-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
45-
* AWSAccessKeyId @endcode</a></li> <li><a
46-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
47-
* Signature @endcode</a></li> <li><a
48-
* href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
49-
* @endcode</a></li> <li><a
50-
* href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
51-
* @endcode</a></li>
43+
* <li>
44+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code AWSAccessKeyId @endcode</a>
45+
* </li> <li>
46+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code Signature @endcode</a>
47+
* </li> <li>
48+
* <a href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token"> @code sig @endcode</a>
49+
* </li> <li>
50+
* <a href="https://cloud.google.com/storage/docs/access-control/signed-urls"> @code X-Goog-Signature @endcode</a></li>
5251
* </ul>
5352
* <p>
5453
* This list is subject to change over time.
@@ -67,21 +66,18 @@ static constexpr const char *kUrlFull = "url.full";
6766
static constexpr const char *kUrlPath = "url.path";
6867

6968
/**
70-
* The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.4">URI query</a> component
69+
* The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.4">URI query</a> component @link https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token @code sig @endcode @endlink
7170
* <p>
7271
* Sensitive content provided in @code url.query @endcode SHOULD be scrubbed when instrumentations
7372
* can identify it. <p>
7473
*
7574
* Query string values for the following keys SHOULD be redacted by default and replaced by the
76-
* value @code REDACTED @endcode: <ul> <li><a
77-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
78-
* AWSAccessKeyId @endcode</a></li> <li><a
79-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
80-
* Signature @endcode</a></li> <li><a
81-
* href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
82-
* @endcode</a></li> <li><a
83-
* href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
84-
* @endcode</a></li>
75+
* value @code REDACTED @endcode: <ul> <li>
76+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code AWSAccessKeyId @endcode</a>
77+
* </li> <li>
78+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code Signature @endcode</a></li> <li>
79+
* <a href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token"> @code sig @endcode</a></li> <li>
80+
* <a href="https://cloud.google.com/storage/docs/access-control/signed-urls"> @code X-Goog-Signature @endcode</a></li>
8581
* </ul>
8682
* <p>
8783
* This list is subject to change over time.

0 commit comments

Comments
 (0)