From d6938de38a824a648ddf9842dec9e0e3cd99cbbf Mon Sep 17 00:00:00 2001 From: Ryan Parman Date: Sun, 4 Feb 2024 20:24:27 -0700 Subject: [PATCH] docs: Added link to Google Safe Browsing rules. --- CHANGELOG.md | 12 ++++++++++++ corefunc/url.go | 7 ++++--- docs/data-sources/url_parse.md | 3 +++ templates/data-sources/url_parse.md.tmpl | 3 +++ 4 files changed, 22 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index de6f9518..f526292d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -42,6 +42,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t * [`c4459ad`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/c4459ad7664dc6a1c93b3585705dc46d72cb76d2): Updated BATS tests with Shellcheck feedback. * [`6611f3f`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/6611f3fbd38af4997fb156c22d4157024bd8d76f): Generated updated test artifacts. * [`d6f3437`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/d6f34376297dc934e195c379786053729b8625bb): Added Terratest tests for `corefunc_url_parse`. + ## 1.2.1 — 2024-02-02 [Compare: v1.1.1 → v1.2.1](https://github.com/northwood-labs/terraform-provider-corefunc/compare/v1.1.1..v1.2.1) @@ -126,11 +127,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t * [`6be7398`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/6be7398843e0a757ab4f0308a175843d8603c829): Work on adding automated OpenTofu testing. * [`66abdf2`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/66abdf213d2f88f3ee0e3d44b26dd0b557b25005): Work on adding automated OpenTofu testing. * [`cc77ed9`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/cc77ed99085f9c81281dd7a6dbcc74298d4cdbe1): Improve CHANGELOG generation. + * [`0182c79`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/0182c79239bb888e61e7affcd3ddfaeced41c0d2): Improve CHANGELOG generation. + * [`acee3ef`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/acee3ef09ce457f074bb25f8aada3d029e474027): Add auto-cancelation for multiple CI runs of the same test. + * [`85cfb6c`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/85cfb6c8dfed8d61bf84d246ba58eacbf91cc650): Setup Terratest testing for OpenTofu from the Makefile. + * [`57b1e0e`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/57b1e0eb5f91a87e5450dba5d6f9492fb2c0b374): Improve switching between Terraform/OpenTofu in Terratest. + * [`590c3bc`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/590c3bce781674b2627e494b203570b142555844): Improve switching between Terraform/OpenTofu in Terratest. + ## 1.1.1 — 2023-12-20 [Compare: v1.1.0 → v1.1.1](https://github.com/northwood-labs/terraform-provider-corefunc/compare/v1.1.0..v1.1.1) @@ -151,12 +158,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t * [`f3c07b2`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/f3c07b267eacc0cc4c3fabd81628112f8ea974f2): Updated copyright in all headers to include 2024. * [`1d00129`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/1d0012982e3c1760735a4fa53a6603781bad6930): Updated the `README.md` for the Terratest tests. + * [`1c2bc3c`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/1c2bc3c6f91b6326cd188320d8978972e2aa78dc): Updated the templates used by tfplugindocs. ### Testing * [`e0915df`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/e0915dfb90f9d2824be769dcc629501db99d1b8c): Added tests with Terratest to compare the Terraform provider with the Go library. * [`e5a810a`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/e5a810a8f9a5ffe2737928429df0be3a9a0a25c3): Make the GoSec scanning more robust. + ## 1.1.0 — 2023-12-18 [Compare: v1.0.3 → v1.1.0](https://github.com/northwood-labs/terraform-provider-corefunc/compare/v1.0.3..v1.1.0) @@ -184,6 +193,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t * [`1135f94`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/1135f9439b1966e3da849c2b9272f84eb89cfd36): Begin implementations of StrLeftPad and IntLeftPad. * [`92fbf6f`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/92fbf6f5e7f4fd17b1a33135a851143be1fd276e): Implemented the provider side of leftpad functions. ([#73](https://github.com/northwood-labs/terraform-provider-corefunc/issues/73)) + * [`c047ee1`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/c047ee16b8db3378bcb76dc430d258be9730568c): Added support for `corefunc.Homedir()` and `corefunc_homedir_get`. ([#77](https://github.com/northwood-labs/terraform-provider-corefunc/issues/77)) * [`e3985ba`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/e3985ba1d576e273a14fe930eefb81999a695c53): Added initial support for Homedir lookups. * [`290e1cc`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/290e1cc1a5138e533935d1d8160d86edecc5b065): Added `corefunc_homedir_expand`. @@ -199,6 +209,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t ### Testing * [`57a7b85`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/57a7b85c17040f880dcaf6546c11cb9acd0a7615): Lookup and run fuzz tests programmatically. + ## 1.0.3 — 2023-11-21 [Compare: v1.0.0 → v1.0.3](https://github.com/northwood-labs/terraform-provider-corefunc/compare/v1.0.0..v1.0.3) @@ -206,6 +217,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), adheres t ### Building and Dependencies * [`14759b8`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/14759b8792c77530a0538d2fdb3ed2cacddd8d73): Bump `the` version number to 1.0.3. No changes from 1.0.0. + ## 1.0.0 — 2023-11-21 ### Bug Fixes diff --git a/corefunc/url.go b/corefunc/url.go index 29eceb34..0837887f 100644 --- a/corefunc/url.go +++ b/corefunc/url.go @@ -28,10 +28,11 @@ relative URLs. The parser is up to date as of 2023-05-24 and passes all relevant tests from web-platform-tests -. +. Its API is similar +to Chapter 6 in WHATWG URL Standard . -Its API is similar to Chapter 6 in WHATWG URL Standard -. +Google Safe Browsing is a URL canonicalizer whose rules are defined at +. ---- diff --git a/docs/data-sources/url_parse.md b/docs/data-sources/url_parse.md index afbe54b4..4ac6126e 100644 --- a/docs/data-sources/url_parse.md +++ b/docs/data-sources/url_parse.md @@ -68,6 +68,9 @@ data "corefunc_url_parse" "complex" { ### Complex (with Google Safe Browsing canonicalizer) +[Google Safe Browsing](https://developers.google.com/safe-browsing/v4/urls-hashing#canonicalization) +is a URL canonicalizer with a different set of rules from standard WHATWG URLs. + ```terraform data "corefunc_url_parse" "gsb" { url = "HTTP://u:p@example.com:80/foo?q=1#bar" diff --git a/templates/data-sources/url_parse.md.tmpl b/templates/data-sources/url_parse.md.tmpl index ab3ffc8e..93cbfc07 100644 --- a/templates/data-sources/url_parse.md.tmpl +++ b/templates/data-sources/url_parse.md.tmpl @@ -23,6 +23,9 @@ description: |- ### Complex (with Google Safe Browsing canonicalizer) +[Google Safe Browsing](https://developers.google.com/safe-browsing/v4/urls-hashing#canonicalization) +is a URL canonicalizer with a different set of rules from standard WHATWG URLs. + {{ tffile "examples/data-sources/corefunc_url_parse/data-source-gsb.tf" }} {{ .SchemaMarkdown | trimspace }}