oapi-profile-builder 3.2.0__tar.gz → 3.2.1__tar.gz

{oapi_profile_builder-3.2.0/src/oapi_profile_builder.egg-info → oapi_profile_builder-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.2.0
+Version: 3.2.1
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License

{oapi_profile_builder-3.2.0 → oapi_profile_builder-3.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "oapi-profile-builder"
-version = "3.2.0"
+version = "3.2.1"
 description = "Authoritative tooling for creating OGC API Service Profiles (EDR, Features)"
 readme = "README.md"
 license = { file = "LICENSE" }

{oapi_profile_builder-3.2.0 → oapi_profile_builder-3.2.1}/src/oapi_profile_builder/server_validation.py

@@ -39,6 +39,7 @@ import subprocess
 import sys
 import tempfile
 from pathlib import Path
+from urllib.parse import urljoin, urlsplit
 
 import yaml
 
@@ -60,6 +61,72 @@ VALID_CHECKS = {
 }
 
 
+def _discover_service_desc_path(base_url: str) -> str | None:
+    """
+    Fetch the landing page and resolve where the live server actually serves
+    its OpenAPI document.
+
+    OGC API standards do not fix the OpenAPI document path. It is discoverable
+    via the landing page link with rel="service-desc" (machine-readable). This
+    returns the path relative to ``base_url`` (e.g. "/openapi.json") suitable
+    for use as an OpenAPI path template, or None if it cannot be resolved to a
+    path on the same host as ``base_url``.
+    """
+    try:
+        import requests
+    except ImportError:
+        return None
+
+    # Normalise to a base that urljoin treats as a directory.
+    base = base_url if base_url.endswith("/") else base_url + "/"
+
+    try:
+        resp = requests.get(
+            base,
+            headers={"Accept": "application/json"},
+            timeout=10,
+        )
+        resp.raise_for_status()
+        landing = resp.json()
+    except Exception:
+        return None
+
+    if not isinstance(landing, dict):
+        return None
+
+    links = landing.get("links")
+    if not isinstance(links, list):
+        return None
+
+    href = None
+    for link in links:
+        if isinstance(link, dict) and link.get("rel") == "service-desc" and link.get("href"):
+            href = link["href"]
+            break
+    if not href:
+        return None
+
+    # Resolve relative hrefs against the landing page URL.
+    absolute = urljoin(base, href)
+
+    base_parts = urlsplit(base)
+    href_parts = urlsplit(absolute)
+
+    # schemathesis appends the OpenAPI path template to --url, so the spec can
+    # only describe resources on the same origin as the validated base URL.
+    if (href_parts.scheme, href_parts.netloc) != (base_parts.scheme, base_parts.netloc):
+        return None
+
+    # Return the href path relative to the base URL's path.
+    base_path = base_parts.path  # ends with "/"
+    href_path = href_parts.path or "/"
+    if href_path.startswith(base_path):
+        rel = href_path[len(base_path):]
+    else:
+        rel = href_path.lstrip("/")
+    return "/" + rel
+
+
 def validate_server(
     spec: dict,
     url: str,
@@ -88,6 +155,27 @@ def validate_server(
             )
             sys.exit(1)
 
+    # The OpenAPI document path is discoverable, not fixed by OGC API. The spec
+    # ships a placeholder "/openapi" path; remap it to wherever the live server
+    # actually advertises its service-desc link, or drop it if we cannot resolve
+    # a same-origin path (testing a path the standard never mandated would be a
+    # false failure).
+    drop_openapi_path = False
+    paths = spec.get("paths")
+    if isinstance(paths, dict) and "/openapi" in paths:
+        discovered = _discover_service_desc_path(url)
+        if discovered and discovered != "/openapi":
+            if discovered in paths:
+                # Server serves its spec at a path the profile already describes.
+                paths.pop("/openapi")
+            else:
+                paths[discovered] = paths.pop("/openapi")
+            print(f"Discovered service-desc document at: {discovered}")
+        elif not discovered:
+            drop_openapi_path = True
+            print("Could not resolve service-desc from landing page; "
+                  "excluding /openapi from validation.")
+
     with tempfile.NamedTemporaryFile(
         mode="w", suffix=".yaml", delete=False, encoding="utf-8"
     ) as tmp:
@@ -108,6 +196,9 @@ def validate_server(
         if exclude_pattern:
             cmd += ["--exclude-path-regex", exclude_pattern.pattern]
 
+        if drop_openapi_path:
+            cmd += ["--exclude-path-regex", r"^/openapi$"]
+
         # Exclude POST /execution and job resource paths unless stateful testing is enabled
         if not stateful:
             cmd += ["--exclude-path-regex", r"(/execution$|/jobs/[^/]+)"]

{oapi_profile_builder-3.2.0 → oapi_profile_builder-3.2.1/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.2.0
+Version: 3.2.1
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License