Merge pull request #114 from vprivat-ads/http_headers

Allow to provide HTTP headers, Configure whether to open URLs when validating assets
stac-utils · Jan 16, 2025 · 9e35465 · 9e35465
2 parents 1395e49 + a5dea87
commit 9e35465
Show file tree

Hide file tree

Showing 13 changed files with 4,397 additions and 2,820 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)
 
 ## Unreleased
 
+### Added
+
+- Allow to provide HTTP headers ([#114](https://github.com/stac-utils/stac-check/pull/114))
+- Configure whether to open URLs when validating assets ([#114](https://github.com/stac-utils/stac-check/pull/114))
+
 ### Changed
 
 - No longer use the deprecated pkg-resources package.

diff --git a/README.md b/README.md
@@ -28,6 +28,10 @@ Options:
                            argument to get full recursion. Ignored if
                            `recursive == False`.
   -r, --recursive          Recursively validate all related stac objects.
+  --no-assets-urls         Disables the opening of href links when validating assets
+                           (enabled by default).
+  --header KEY VALUE       HTTP header to include in the requests. Can be used
+                           multiple times.
   --help                   Show this message and exit.               Show this message and exit.
 ```
 ---
@@ -62,7 +66,7 @@ stac-check: STAC spec validation and linting tool
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 3.1.0
+Validator: stac-validator 3.5.0
 
 
 Recursive: Validate all assets in a collection or catalog
@@ -102,7 +106,7 @@ Error Message: Expecting value: line 1 column 1 (char 0)
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -130,7 +134,7 @@ This object has 4 links
 
 Thanks for using STAC version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -165,7 +169,7 @@ This object has 4 links
 
 Thanks for using STAC version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -207,7 +211,7 @@ This object has 4 links
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid : False
 
@@ -224,6 +228,30 @@ Validation error message:
 
 This object has 5 links
 </pre>
+
+``` stac-check https://stac-catalog.eu/collections/sentinel-s2-l2a/items/item1 --assets --no-assets-urls --header x-api-key $MY_API_KEY --header foo bar```
+<pre>
+<b>stac-check: STAC spec validation and linting tool</b>
+
+Thanks for using STAC version 1.0.0!
+
+Validator: stac-validator 3.5.0
+
+Valid ITEM: True
+
+Schemas validated: 
+    https://stac-extensions.github.io/timestamps/v1.1.0/schema.json
+    https://schemas.stacspec.org/v1.0.0/item-spec/json-schema/item.json
+
+STAC Best Practices: 
+    A STAC collection should contain a summaries field
+    It is recommended to store information like eo:bands in summaries
+
+
+No ASSET format errors!
+
+This object has 4 links
+</pre>
 ---
 ### Create local docs in the /docs folder
-`$ pdoc --html --output-dir pdoc stac_check --force`
+`$ pdoc --output-dir pdoc ./stac_check`
diff --git a/pdoc/index.html b/pdoc/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./stac_check.html"/>
+</head>
+</html>
diff --git a/pdoc/search.js b/pdoc/search.js
diff --git a/pdoc/stac_check.html b/pdoc/stac_check.html
diff --git a/pdoc/stac_check/cli.html b/pdoc/stac_check/cli.html
diff --git a/pdoc/stac_check/index.html b/pdoc/stac_check/index.html