prettify

Contrast-Security-OSS · Nov 20, 2024 · 0a67177 · 0a67177
1 parent 7698d9d
commit 0a67177
Show file tree

Hide file tree

Showing 36 changed files with 512 additions and 511 deletions.
diff --git a/Makefile b/Makefile
@@ -184,12 +184,12 @@ fix-format:
 
 # Run all checks in order of speed / likely failure.
 .PHONY: check
-check: misspell markdownlint attribute-registry-generation markdown-link-check check-format check-policies
+check: misspell markdownlint check-format attribute-registry-generation markdown-link-check check-policies
 	@echo "All checks complete"
 
 # Attempt to fix issues / regenerate tables.
 .PHONY: fix
-fix: table-generation attribute-registry-generation misspell-correction fix-format
+fix: table-generation attribute-registry-generation misspell-correction fix-format markdown-toc
 	@echo "All autofixes complete"
 
 .PHONY: install-tools

diff --git a/docs/attributes-registry/azure.md b/docs/attributes-registry/azure.md
@@ -10,7 +10,7 @@
 
 This document defines generic attributes for Azure SDK.
 
-| Attribute | Type | Description | Examples | Stability |
-|---|---|---|---|---|
-| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                                                                               | Type   | Description                                                                                                                                                             | Examples                                                          | Stability                                                        |
+| --------------------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------- |
+| <a id="az-namespace" href="#az-namespace">`az.namespace`</a>                            | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response.                                                       | `00000000-0000-0000-0000-000000000000`                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
diff --git a/docs/attributes-registry/browser.md b/docs/attributes-registry/browser.md
@@ -10,12 +10,12 @@
 
 The web browser attributes
 
-| Attribute | Type | Description | Examples | Stability |
-|---|---|---|---|---|
-| <a id="browser-brands" href="#browser-brands">`browser.brands`</a> | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| <a id="browser-language" href="#browser-language">`browser.language`</a> | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| <a id="browser-mobile" href="#browser-mobile">`browser.mobile`</a> | boolean | A boolean that is true if the browser is running on a mobile device [3] |  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| <a id="browser-platform" href="#browser-platform">`browser.platform`</a> | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                                                                | Type     | Description                                                             | Examples                                          | Stability                                                        |
+| ------------------------------------------------------------------------ | -------- | ----------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------- |
+| <a id="browser-brands" href="#browser-brands">`browser.brands`</a>       | string[] | Array of brand name and version separated by a space [1]                | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="browser-language" href="#browser-language">`browser.language`</a> | string   | Preferred language of the user using the browser [2]                    | `en`; `en-US`; `fr`; `fr-FR`                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="browser-mobile" href="#browser-mobile">`browser.mobile`</a>       | boolean  | A boolean that is true if the browser is running on a mobile device [3] |                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="browser-platform" href="#browser-platform">`browser.platform`</a> | string   | The platform on which the browser is running [4]                        | `Windows`; `macOS`; `Android`                     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1] `browser.brands`:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`).
 

diff --git a/docs/attributes-registry/client.md b/docs/attributes-registry/client.md
@@ -10,11 +10,11 @@
 
 These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
 
-| Attribute | Type | Description | Examples | Stability |
-|---|---|---|---|---|
+| Attribute                                                          | Type   | Description                                                                                                                 | Examples                                          | Stability                                                  |
+| ------------------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------- |
 | <a id="client-address" href="#client-address">`client.address`</a> | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
-| <a id="client-port" href="#client-port">`client.port`</a> | int | Client port number. [2] | `65123` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
+| <a id="client-port" href="#client-port">`client.port`</a>          | int    | Client port number. [2]                                                                                                     | `65123`                                           | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
 
-**[1] `client.address`:** When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries,  for example proxies, if it's available.
+**[1] `client.address`:** When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
 
-**[2] `client.port`:** When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries,  for example proxies, if it's available.
+**[2] `client.port`:** When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.