oapi-profile-builder 2.4.0__tar.gz → 3.0.0__tar.gz

{oapi_profile_builder-2.4.0/src/oapi_profile_builder.egg-info → oapi_profile_builder-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.4.0
+Version: 3.0.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -234,18 +234,27 @@ keywords:
   - my-parameter
   - my-domain
 
+# ── Profile-level constraints ─────────────────────────────────────────────
+# Define what any conforming implementation MUST support.
+# Validated at build time and embedded in the generated OpenAPI as
+# enum/pattern constraints so runtime tools can enforce them.
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
 
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
 
 output_formats:
   - name: GeoJSON
     media_type: application/geo+json
 
+# ── Reference metadata ────────────────────────────────────────────────────
+# Describes the structure of collections a conforming service should expose.
+# For dynamic fields (extent intervals, custom dimension values), use the
+# full possible range — not a snapshot of current live data.
 collections:
   - id: my_collection
     links:
@@ -264,6 +273,11 @@ collections:
         unit:
           label: Celsius
           symbol: "°C"
+
+# ── Normative requirements and abstract tests ─────────────────────────────
+# Drive the AsciiDoc/PDF output. Tests must reference a valid requirement id.
+requirements: []
+abstract_tests: []
 ```
 
 ### Top-level fields
@@ -297,6 +311,16 @@ collections:
 
 Uses the [edr-pydantic](https://github.com/KNMI/edr-pydantic) `Collection` model — the same schema an EDR server returns at `/collections/{id}`.
 
+> **Service-level vs collection-level fields**
+>
+> The profile has two distinct levels that serve different purposes — they don't merge or override each other:
+>
+> - **Service-level fields** (`extent_requirements`, `parameter_schema`, `parameter_name_pattern`, `collection_id_pattern`) define *constraints* that any conforming implementation must satisfy. They are validated at build time and embedded in the generated OpenAPI as schema constraints (enums, patterns) so runtime tools can enforce them against a live server.
+>
+> - **`collections[]`** provides *reference metadata* — the structure and representative values of collections a conforming service should expose. This mirrors what an EDR server returns at `/collections/{id}` and drives the generated OpenAPI paths and response schemas.
+>
+> For fields that are inherently dynamic (e.g. `extent.temporal.interval`, `extent.custom[].values`), use representative values that describe the *full possible range*, not a snapshot of current live data. For example, use an open-ended temporal interval `["2020-01-01T00:00:00Z", null]` rather than a specific end date, and list all valid custom dimension values rather than only those currently in the dataset. The `validate-server` command tests API structure and response schema conformance — it does not assert that specific data values in responses match the profile config exactly.
+
 | Field | Required | Description |
 |---|---|---|
 | `id` | yes | Collection identifier |
@@ -363,25 +387,41 @@ parameter_names:
 
 ### `extent_requirements`
 
-Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI.
+Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI as `enum` or `pattern` constraints on the collection response schema.
+
+These are **profile-level constraints** — they define what any conforming implementation must support, independent of the specific values a live service happens to have at a given moment.
+
+CRS/TRS/VRS constraints are split into two distinct concerns:
+
+- `extent_crs` / `extent_trs` / `extent_vrs` — constrain the **single value** used to express the extent (`extent.spatial.crs`, `extent.temporal.trs`, `extent.vertical.vrs`). Typically just CRS84 / Gregorian.
+- `supported_crs` / `supported_trs` / `supported_vrs` — constrain the **list of values** the service supports for queries (the top-level `crs` array and `data_queries.*.variables.crs_details`). Usually broader than the extent constraint.
+
+Each constraint uses either `allowed` (exact list) or `pattern` (regex) — not both.
 
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
 
-  # Option A: exact list
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
-    - "http://www.opengis.net/def/crs/EPSG/0/4326"
-
-  # Option B: regex (accepts any OGC or EPSG CRS)
-  # crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
-
-  allowed_trs:
-    - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
+  # Extent is always expressed in CRS84
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+
+  # Service supports CRS84 plus any EPSG CRS for queries
+  supported_crs:
+    pattern: "^(http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84|http://www\\.opengis\\.net/def/crs/EPSG/.*)$"
+  # or an explicit list:
+  # supported_crs:
+  #   allowed:
+  #     - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  #     - "http://www.opengis.net/def/crs/EPSG/0/4326"
+
+  extent_trs:
+    allowed:
+      - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
-Either `allowed_crs` or `crs_pattern` is required. The same enum/regex approach applies to `allowed_trs`/`trs_pattern` and `allowed_vrs`/`vrs_pattern`.
+At least one of `extent_crs` or `supported_crs` is required. The same applies to TRS and VRS — all are optional individually but at least one CRS constraint must be present.
 
 ---
 

{oapi_profile_builder-2.4.0 → oapi_profile_builder-3.0.0}/README.md

@@ -189,18 +189,27 @@ keywords:
   - my-parameter
   - my-domain
 
+# ── Profile-level constraints ─────────────────────────────────────────────
+# Define what any conforming implementation MUST support.
+# Validated at build time and embedded in the generated OpenAPI as
+# enum/pattern constraints so runtime tools can enforce them.
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
 
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
 
 output_formats:
   - name: GeoJSON
     media_type: application/geo+json
 
+# ── Reference metadata ────────────────────────────────────────────────────
+# Describes the structure of collections a conforming service should expose.
+# For dynamic fields (extent intervals, custom dimension values), use the
+# full possible range — not a snapshot of current live data.
 collections:
   - id: my_collection
     links:
@@ -219,6 +228,11 @@ collections:
         unit:
           label: Celsius
           symbol: "°C"
+
+# ── Normative requirements and abstract tests ─────────────────────────────
+# Drive the AsciiDoc/PDF output. Tests must reference a valid requirement id.
+requirements: []
+abstract_tests: []
 ```
 
 ### Top-level fields
@@ -252,6 +266,16 @@ collections:
 
 Uses the [edr-pydantic](https://github.com/KNMI/edr-pydantic) `Collection` model — the same schema an EDR server returns at `/collections/{id}`.
 
+> **Service-level vs collection-level fields**
+>
+> The profile has two distinct levels that serve different purposes — they don't merge or override each other:
+>
+> - **Service-level fields** (`extent_requirements`, `parameter_schema`, `parameter_name_pattern`, `collection_id_pattern`) define *constraints* that any conforming implementation must satisfy. They are validated at build time and embedded in the generated OpenAPI as schema constraints (enums, patterns) so runtime tools can enforce them against a live server.
+>
+> - **`collections[]`** provides *reference metadata* — the structure and representative values of collections a conforming service should expose. This mirrors what an EDR server returns at `/collections/{id}` and drives the generated OpenAPI paths and response schemas.
+>
+> For fields that are inherently dynamic (e.g. `extent.temporal.interval`, `extent.custom[].values`), use representative values that describe the *full possible range*, not a snapshot of current live data. For example, use an open-ended temporal interval `["2020-01-01T00:00:00Z", null]` rather than a specific end date, and list all valid custom dimension values rather than only those currently in the dataset. The `validate-server` command tests API structure and response schema conformance — it does not assert that specific data values in responses match the profile config exactly.
+
 | Field | Required | Description |
 |---|---|---|
 | `id` | yes | Collection identifier |
@@ -318,25 +342,41 @@ parameter_names:
 
 ### `extent_requirements`
 
-Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI.
+Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI as `enum` or `pattern` constraints on the collection response schema.
+
+These are **profile-level constraints** — they define what any conforming implementation must support, independent of the specific values a live service happens to have at a given moment.
+
+CRS/TRS/VRS constraints are split into two distinct concerns:
+
+- `extent_crs` / `extent_trs` / `extent_vrs` — constrain the **single value** used to express the extent (`extent.spatial.crs`, `extent.temporal.trs`, `extent.vertical.vrs`). Typically just CRS84 / Gregorian.
+- `supported_crs` / `supported_trs` / `supported_vrs` — constrain the **list of values** the service supports for queries (the top-level `crs` array and `data_queries.*.variables.crs_details`). Usually broader than the extent constraint.
+
+Each constraint uses either `allowed` (exact list) or `pattern` (regex) — not both.
 
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
 
-  # Option A: exact list
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
-    - "http://www.opengis.net/def/crs/EPSG/0/4326"
-
-  # Option B: regex (accepts any OGC or EPSG CRS)
-  # crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
-
-  allowed_trs:
-    - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
+  # Extent is always expressed in CRS84
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+
+  # Service supports CRS84 plus any EPSG CRS for queries
+  supported_crs:
+    pattern: "^(http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84|http://www\\.opengis\\.net/def/crs/EPSG/.*)$"
+  # or an explicit list:
+  # supported_crs:
+  #   allowed:
+  #     - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  #     - "http://www.opengis.net/def/crs/EPSG/0/4326"
+
+  extent_trs:
+    allowed:
+      - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
-Either `allowed_crs` or `crs_pattern` is required. The same enum/regex approach applies to `allowed_trs`/`trs_pattern` and `allowed_vrs`/`vrs_pattern`.
+At least one of `extent_crs` or `supported_crs` is required. The same applies to TRS and VRS — all are optional individually but at least one CRS constraint must be present.
 
 ---
 

{oapi_profile_builder-2.4.0 → oapi_profile_builder-3.0.0}/pyproject.toml

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

{oapi_profile_builder-2.4.0 → oapi_profile_builder-3.0.0}/src/oapi_profile_builder/generate.py

@@ -416,24 +416,26 @@ def _collection_response_schema(coll: Collection,
     - Full parameter_names objects with all fields
     - parameter_name_pattern as propertyNames constraint
     """
-    crs_schema: dict = {"type": "string"}
-    trs_schema: dict = {"type": "string"}
-    vrs_schema: dict = {"type": "string"}
+    crs_schema: dict = {"type": "string"}       # extent.spatial.crs
+    trs_schema: dict = {"type": "string"}       # extent.temporal.trs
+    vrs_schema: dict = {"type": "string"}       # extent.vertical.vrs
+    supported_crs_schema: dict = {"type": "string"}  # crs[] and crs_details[].crs
 
     if profile and profile.extent_requirements:
         er = profile.extent_requirements
-        if er.allowed_crs:
-            crs_schema["enum"] = er.allowed_crs
-        elif er.crs_pattern:
-            crs_schema["pattern"] = er.crs_pattern
-        if er.allowed_trs:
-            trs_schema["enum"] = er.allowed_trs
-        elif er.trs_pattern:
-            trs_schema["pattern"] = er.trs_pattern
-        if er.allowed_vrs:
-            vrs_schema["enum"] = er.allowed_vrs
-        elif er.vrs_pattern:
-            vrs_schema["pattern"] = er.vrs_pattern
+
+        def _apply(schema: dict, constraint: "object | None") -> None:
+            if constraint is None:
+                return
+            if getattr(constraint, "allowed", None):
+                schema["enum"] = constraint.allowed
+            elif getattr(constraint, "pattern", None):
+                schema["pattern"] = constraint.pattern
+
+        _apply(crs_schema, er.extent_crs)
+        _apply(trs_schema, er.extent_trs)
+        _apply(vrs_schema, er.extent_vrs)
+        _apply(supported_crs_schema, er.supported_crs)
 
     # Build parameter_names schema — use profile-supplied schema if present,
     # otherwise fall back to the default EDR Parameter schema.
@@ -459,11 +461,14 @@ def _collection_response_schema(coll: Collection,
     if coll.output_formats:
         output_formats_schema["items"] = {"type": "string", "enum": list(coll.output_formats)}
 
-    # Build crs array schema — use collection-level crs list if present
-    crs_array_schema: dict = {"type": "array", "items": crs_schema}
+    # Build crs array schema — use collection-level crs list if present,
+    # otherwise apply supported_crs constraint from extent_requirements.
+    # supported_crs is distinct from extent_crs: it constrains what the
+    # service supports for queries, not how the extent itself is expressed.
     if coll.crs:
-        # Collection declares its supported CRS list explicitly
-        crs_array_schema["items"] = {"type": "string", "enum": list(coll.crs)}
+        crs_array_schema: dict = {"type": "array", "items": {"type": "string", "enum": list(coll.crs)}}
+    else:
+        crs_array_schema = {"type": "array", "items": supported_crs_schema}
 
     schema: dict = {
         "type": "object",
@@ -585,7 +590,7 @@ def _collection_response_schema(coll: Collection,
                                                 "type": "object",
                                                 "required": ["crs"],
                                                 "properties": {
-                                                    "crs": crs_schema,
+                                                    "crs": supported_crs_schema,
                                                     "wkt": {"type": "string"},
                                                 },
                                             },

{oapi_profile_builder-2.4.0 → oapi_profile_builder-3.0.0}/src/oapi_profile_builder/models.py

@@ -60,6 +60,7 @@ from pydantic import AwareDatetime, BaseModel, Field, field_validator, model_val
 # ---------------------------------------------------------------------------
 
 from edr_pydantic.base_model import EdrBaseModel  # noqa: E402 — after stdlib imports
+from edr_pydantic.parameter import Parameters  # noqa: E402
 
 
 class TemporalWithNullBounds(EdrBaseModel):
@@ -80,18 +81,32 @@ class ExtentWithNullBounds(EDRExtent):
 
 class Collection(EDRCollection):
     """
-    EDR Collection with a null-aware temporal extent.
+    EDR Collection with a null-aware temporal extent and optional parameter_names.
 
-    Identical to edr_pydantic.collections.Collection except that
-    extent uses ExtentWithNullBounds so open-ended intervals like
-    ["2020-01-01T00:00:00Z", null] are accepted.
+    Differences from edr_pydantic.collections.Collection:
 
-    post_queries controls whether POST operations are generated for this
-    collection's data query endpoints.  None means inherit the profile-level
-    allow_post_queries default.  Set to True or False to override per-collection.
+    - extent uses ExtentWithNullBounds so open-ended intervals like
+      ["2020-01-01T00:00:00Z", null] are accepted (spec-compliant).
+
+    - parameter_names is Optional (default None). edr-pydantic marks it as
+      required, but OGC API - EDR Part 3 allows a profile to define the
+      *schema* for parameter objects via parameter_schema without mandating
+      any specific parameter names in the profile document itself.
+
+    - post_queries controls whether POST operations are generated for this
+      collection's data query endpoints. None means inherit the profile-level
+      allow_post_queries default. Set to True or False to override per-collection.
     """
 
     extent: Optional[ExtentWithNullBounds] = None  # type: ignore[assignment]
+    parameter_names: Optional[Parameters] = Field(  # type: ignore[assignment]
+        default=None,
+        description=(
+            "Map of parameter id → Parameter object. "
+            "Optional — omit when using parameter_schema to describe the structure "
+            "without mandating specific parameter names."
+        ),
+    )
     post_queries: Optional[bool] = Field(
         default=None,
         description=(
@@ -149,20 +164,87 @@ class SubscriptionFilter(BaseModel):
     type: FilterType = FilterType.string
 
 
+class CrsConstraint(BaseModel):
+    """An enum or regex constraint on a CRS/TRS/VRS value or list.
+
+    Exactly one of `allowed` or `pattern` must be set.
+    """
+    allowed: list[str] | None = Field(
+        default=None,
+        description="Enumerated list of accepted values",
+    )
+    pattern: str | None = Field(
+        default=None,
+        description="Regular expression that accepted values must match",
+    )
+
+    @model_validator(mode="after")
+    def exactly_one(self) -> CrsConstraint:
+        if self.allowed is None and self.pattern is None:
+            raise ValueError("Either 'allowed' or 'pattern' must be specified")
+        if self.allowed is not None and self.pattern is not None:
+            raise ValueError("Only one of 'allowed' or 'pattern' may be specified, not both")
+        return self
+
+
 class ExtentRequirements(BaseModel):
-    """Profile-level extent restrictions per OGC API - EDR Part 3."""
-    minimum_bbox: list[float] = Field(min_length=4, max_length=4, description="Minimum spatial bounds [minLon, minLat, maxLon, maxLat]")
-    allowed_crs: list[str] | None = Field(default=None, description="Enumerated list of valid CRS values")
-    crs_pattern: str | None = Field(default=None, description="Regular expression defining valid CRS string patterns")
-    allowed_trs: list[str] | None = Field(default=None, description="Enumerated list of valid TRS values")
-    trs_pattern: str | None = Field(default=None, description="Regular expression defining valid TRS string patterns")
-    allowed_vrs: list[str] | None = Field(default=None, description="Enumerated list of valid VRS values")
-    vrs_pattern: str | None = Field(default=None, description="Regular expression defining valid VRS string patterns")
+    """Profile-level extent restrictions per OGC API - EDR Part 3.
+
+    CRS/TRS/VRS constraints are split into two distinct concerns:
+
+    - ``extent_crs`` / ``extent_trs`` / ``extent_vrs`` — constrain the single
+      CRS/TRS/VRS value used to *express* the extent (``extent.spatial.crs``,
+      ``extent.temporal.trs``, ``extent.vertical.vrs``).  Typically this is
+      just CRS84 / Gregorian.
+
+    - ``supported_crs`` / ``supported_trs`` / ``supported_vrs`` — constrain
+      the list of CRS/TRS/VRS values the service *supports* for queries
+      (the top-level ``crs`` array and ``data_queries.*.variables.crs_details``).
+      This is usually broader than the extent CRS.
+    """
+    minimum_bbox: list[float] = Field(
+        min_length=4, max_length=4,
+        description="Minimum spatial bounds [minLon, minLat, maxLon, maxLat]",
+    )
+
+    # --- Extent CRS/TRS/VRS (single value on extent object) ---
+    extent_crs: CrsConstraint | None = Field(
+        default=None,
+        description="Constraint on extent.spatial.crs — the CRS the extent is expressed in",
+    )
+    extent_trs: CrsConstraint | None = Field(
+        default=None,
+        description="Constraint on extent.temporal.trs — the TRS the temporal extent is expressed in",
+    )
+    extent_vrs: CrsConstraint | None = Field(
+        default=None,
+        description="Constraint on extent.vertical.vrs — the VRS the vertical extent is expressed in",
+    )
+
+    # --- Supported CRS/TRS/VRS (lists — what the service supports for queries) ---
+    supported_crs: CrsConstraint | None = Field(
+        default=None,
+        description=(
+            "Constraint on the top-level crs array and crs_details — "
+            "the CRS values the service supports for data queries. "
+            "Typically broader than extent_crs."
+        ),
+    )
+    supported_trs: CrsConstraint | None = Field(
+        default=None,
+        description="Constraint on supported TRS values for data queries",
+    )
+    supported_vrs: CrsConstraint | None = Field(
+        default=None,
+        description="Constraint on supported VRS values for data queries",
+    )
 
     @model_validator(mode="after")
     def validate_crs_specification(self) -> ExtentRequirements:
-        if self.allowed_crs is None and self.crs_pattern is None:
-            raise ValueError("Either allowed_crs or crs_pattern must be specified")
+        if self.extent_crs is None and self.supported_crs is None:
+            raise ValueError(
+                "At least one of 'extent_crs' or 'supported_crs' must be specified"
+            )
         return self
 
 
@@ -327,13 +409,11 @@ class ServiceProfile(BaseModel):
             if not coll.parameter_names:
                 continue
             for param_name, param in coll.parameter_names.root.items():
-                # Check if unit is specified
                 if not hasattr(param, 'unit') or param.unit is None:
                     raise ValueError(
                         f"Parameter '{param_name}' in collection '{coll.id}' must specify unit "
                         f"(required by OGC API - EDR Part 3 REQ_parameter-names)"
                     )
-                # Check if observedProperty is specified (already required by edr-pydantic)
                 if not hasattr(param, 'observedProperty') or param.observedProperty is None:
                     raise ValueError(
                         f"Parameter '{param_name}' in collection '{coll.id}' must specify observedProperty"
@@ -382,69 +462,49 @@ class ServiceProfile(BaseModel):
 
     @model_validator(mode="after")
     def validate_collection_extent_patterns(self) -> ServiceProfile:
-        """Validate collection CRS/TRS/VRS values against extent_requirements patterns and enums."""
+        """Validate collection CRS/TRS/VRS values against extent_requirements constraints."""
         if not self.extent_requirements:
             return self
         er = self.extent_requirements
 
-        # Compile patterns once, validating regex syntax
-        crs_pat = _compile_optional_pattern("crs_pattern", er.crs_pattern)
-        trs_pat = _compile_optional_pattern("trs_pattern", er.trs_pattern)
-        vrs_pat = _compile_optional_pattern("vrs_pattern", er.vrs_pattern)
+        # Helper: check a single value against a CrsConstraint
+        def _check(label: str, value: str, constraint: "CrsConstraint | None") -> None:
+            if constraint is None:
+                return
+            if constraint.allowed is not None and value not in constraint.allowed:
+                raise ValueError(
+                    f"{label} '{value}' is not in allowed list {constraint.allowed}"
+                )
+            if constraint.pattern is not None:
+                pat = _compile_optional_pattern(label, constraint.pattern)
+                if pat and not pat.fullmatch(value):
+                    raise ValueError(
+                        f"{label} '{value}' does not match pattern '{constraint.pattern}'"
+                    )
 
         for coll in self.collections:
-            # --- CRS ---
+            # --- extent.spatial.crs → extent_crs ---
             crs = coll.extent.spatial.crs if coll.extent and coll.extent.spatial else None
             if crs:
-                if er.allowed_crs and crs not in er.allowed_crs:
-                    raise ValueError(
-                        f"Collection '{coll.id}' CRS '{crs}' is not in allowed_crs "
-                        f"{er.allowed_crs}"
-                    )
-                if crs_pat and not crs_pat.fullmatch(crs):
-                    raise ValueError(
-                        f"Collection '{coll.id}' CRS '{crs}' does not match "
-                        f"crs_pattern '{er.crs_pattern}'"
-                    )
+                _check(f"Collection '{coll.id}' extent.spatial.crs", crs, er.extent_crs)
 
-            # --- TRS ---
-            trs = (
-                coll.extent.temporal.trs
-                if coll.extent and coll.extent.temporal else None
-            )
+            # --- extent.temporal.trs → extent_trs ---
+            trs = coll.extent.temporal.trs if coll.extent and coll.extent.temporal else None
             if trs:
-                if er.allowed_trs and trs not in er.allowed_trs:
-                    raise ValueError(
-                        f"Collection '{coll.id}' TRS '{trs}' is not in allowed_trs "
-                        f"{er.allowed_trs}"
-                    )
-                if trs_pat and not trs_pat.fullmatch(trs):
-                    raise ValueError(
-                        f"Collection '{coll.id}' TRS '{trs}' does not match "
-                        f"trs_pattern '{er.trs_pattern}'"
-                    )
+                _check(f"Collection '{coll.id}' extent.temporal.trs", trs, er.extent_trs)
 
-            # --- VRS ---
-            vrs = (
-                coll.extent.vertical.vrs
-                if coll.extent and coll.extent.vertical else None
-            )
+            # --- extent.vertical.vrs → extent_vrs ---
+            vrs = coll.extent.vertical.vrs if coll.extent and coll.extent.vertical else None
             if vrs:
-                if er.allowed_vrs and vrs not in er.allowed_vrs:
-                    raise ValueError(
-                        f"Collection '{coll.id}' VRS '{vrs}' is not in allowed_vrs "
-                        f"{er.allowed_vrs}"
-                    )
-                if vrs_pat and not vrs_pat.fullmatch(vrs):
-                    raise ValueError(
-                        f"Collection '{coll.id}' VRS '{vrs}' does not match "
-                        f"vrs_pattern '{er.vrs_pattern}'"
-                    )
+                _check(f"Collection '{coll.id}' extent.vertical.vrs", vrs, er.extent_vrs)
+
+            # --- top-level crs array → supported_crs ---
+            if coll.crs and er.supported_crs:
+                for crs_val in coll.crs:
+                    _check(f"Collection '{coll.id}' crs[]", crs_val, er.supported_crs)
 
-            # --- crs_details in data_queries ---
-            # Each data query may declare crs_details with per-query CRS support.
-            # Validate those CRS values against the same allowed_crs / crs_pattern.
-            if coll.data_queries and (er.allowed_crs or crs_pat):
+            # --- crs_details in data_queries → supported_crs ---
+            if coll.data_queries and er.supported_crs:
                 for qt_name, qt_val in coll.data_queries:
                     if qt_val is None:
                         continue
@@ -455,19 +515,11 @@ class ServiceProfile(BaseModel):
                     )
                     for entry in (crs_details or []):
                         dq_crs = entry.get("crs") if isinstance(entry, dict) else None
-                        if not dq_crs:
-                            continue
-                        if er.allowed_crs and dq_crs not in er.allowed_crs:
-                            raise ValueError(
-                                f"Collection '{coll.id}' data query '{qt_name}' "
-                                f"crs_details CRS '{dq_crs}' is not in allowed_crs "
-                                f"{er.allowed_crs}"
-                            )
-                        if crs_pat and not crs_pat.fullmatch(dq_crs):
-                            raise ValueError(
-                                f"Collection '{coll.id}' data query '{qt_name}' "
-                                f"crs_details CRS '{dq_crs}' does not match "
-                                f"crs_pattern '{er.crs_pattern}'"
+                        if dq_crs:
+                            _check(
+                                f"Collection '{coll.id}' data_queries.{qt_name}.crs_details",
+                                dq_crs,
+                                er.supported_crs,
                             )
         return self
 

{oapi_profile_builder-2.4.0 → oapi_profile_builder-3.0.0/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.4.0
+Version: 3.0.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -234,18 +234,27 @@ keywords:
   - my-parameter
   - my-domain
 
+# ── Profile-level constraints ─────────────────────────────────────────────
+# Define what any conforming implementation MUST support.
+# Validated at build time and embedded in the generated OpenAPI as
+# enum/pattern constraints so runtime tools can enforce them.
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
 
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
 
 output_formats:
   - name: GeoJSON
     media_type: application/geo+json
 
+# ── Reference metadata ────────────────────────────────────────────────────
+# Describes the structure of collections a conforming service should expose.
+# For dynamic fields (extent intervals, custom dimension values), use the
+# full possible range — not a snapshot of current live data.
 collections:
   - id: my_collection
     links:
@@ -264,6 +273,11 @@ collections:
         unit:
           label: Celsius
           symbol: "°C"
+
+# ── Normative requirements and abstract tests ─────────────────────────────
+# Drive the AsciiDoc/PDF output. Tests must reference a valid requirement id.
+requirements: []
+abstract_tests: []
 ```
 
 ### Top-level fields
@@ -297,6 +311,16 @@ collections:
 
 Uses the [edr-pydantic](https://github.com/KNMI/edr-pydantic) `Collection` model — the same schema an EDR server returns at `/collections/{id}`.
 
+> **Service-level vs collection-level fields**
+>
+> The profile has two distinct levels that serve different purposes — they don't merge or override each other:
+>
+> - **Service-level fields** (`extent_requirements`, `parameter_schema`, `parameter_name_pattern`, `collection_id_pattern`) define *constraints* that any conforming implementation must satisfy. They are validated at build time and embedded in the generated OpenAPI as schema constraints (enums, patterns) so runtime tools can enforce them against a live server.
+>
+> - **`collections[]`** provides *reference metadata* — the structure and representative values of collections a conforming service should expose. This mirrors what an EDR server returns at `/collections/{id}` and drives the generated OpenAPI paths and response schemas.
+>
+> For fields that are inherently dynamic (e.g. `extent.temporal.interval`, `extent.custom[].values`), use representative values that describe the *full possible range*, not a snapshot of current live data. For example, use an open-ended temporal interval `["2020-01-01T00:00:00Z", null]` rather than a specific end date, and list all valid custom dimension values rather than only those currently in the dataset. The `validate-server` command tests API structure and response schema conformance — it does not assert that specific data values in responses match the profile config exactly.
+
 | Field | Required | Description |
 |---|---|---|
 | `id` | yes | Collection identifier |
@@ -363,25 +387,41 @@ parameter_names:
 
 ### `extent_requirements`
 
-Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI.
+Constrains CRS, TRS, and VRS values across all collections. Validated at build time and embedded in the generated OpenAPI as `enum` or `pattern` constraints on the collection response schema.
+
+These are **profile-level constraints** — they define what any conforming implementation must support, independent of the specific values a live service happens to have at a given moment.
+
+CRS/TRS/VRS constraints are split into two distinct concerns:
+
+- `extent_crs` / `extent_trs` / `extent_vrs` — constrain the **single value** used to express the extent (`extent.spatial.crs`, `extent.temporal.trs`, `extent.vertical.vrs`). Typically just CRS84 / Gregorian.
+- `supported_crs` / `supported_trs` / `supported_vrs` — constrain the **list of values** the service supports for queries (the top-level `crs` array and `data_queries.*.variables.crs_details`). Usually broader than the extent constraint.
+
+Each constraint uses either `allowed` (exact list) or `pattern` (regex) — not both.
 
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
 
-  # Option A: exact list
-  allowed_crs:
-    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
-    - "http://www.opengis.net/def/crs/EPSG/0/4326"
-
-  # Option B: regex (accepts any OGC or EPSG CRS)
-  # crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
-
-  allowed_trs:
-    - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
+  # Extent is always expressed in CRS84
+  extent_crs:
+    allowed:
+      - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+
+  # Service supports CRS84 plus any EPSG CRS for queries
+  supported_crs:
+    pattern: "^(http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84|http://www\\.opengis\\.net/def/crs/EPSG/.*)$"
+  # or an explicit list:
+  # supported_crs:
+  #   allowed:
+  #     - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+  #     - "http://www.opengis.net/def/crs/EPSG/0/4326"
+
+  extent_trs:
+    allowed:
+      - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
-Either `allowed_crs` or `crs_pattern` is required. The same enum/regex approach applies to `allowed_trs`/`trs_pattern` and `allowed_vrs`/`vrs_pattern`.
+At least one of `extent_crs` or `supported_crs` is required. The same applies to TRS and VRS — all are optional individually but at least one CRS constraint must be present.
 
 ---