oapi-profile-builder 2.0.2__tar.gz → 2.0.3__tar.gz

{oapi_profile_builder-2.0.2/src/oapi_profile_builder.egg-info → oapi_profile_builder-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.0.2
+Version: 2.0.3
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -63,6 +63,9 @@ pip install oapi-profile-builder
 
 ## Workflow
 
+<img width="1001" height="721" alt="OGC API Service Profile Builder - Pydantic Validation Architecture drawio" src="https://github.com/user-attachments/assets/092c3dfc-549e-41b0-8a92-af0b89689950" />
+
+
 ### 1. Author a Profile Config
 
 A profile config is a YAML or JSON file. Start with the minimal example:
@@ -293,6 +296,133 @@ The skipped tests are optional features not implemented by the server.
 
 ---
 
+## Profile Configuration Guide
+
+This section explains what is and isn't allowed when creating a profile, and how the tool validates your configuration.
+
+### What Gets Validated
+
+When you run `generate` or `validate`, the tool instantiates a `ServiceProfile` Pydantic model that enforces all of the following rules before any files are written. If any rule is violated, you get a clear error message pointing to the offending field.
+
+#### Profile-Level Fields
+
+| Field | Rules |
+|---|---|
+| `name` | Must match `^[a-z0-9_]+$` — lowercase letters, digits, and underscores only. Used in OGC URIs. |
+| `title` | Any non-empty string. |
+| `version` | Any string. Defaults to `"1.0"`. |
+| `collections` | At least one collection is required. No duplicate `id` values. |
+
+#### Collection IDs
+
+By default, collection IDs can be any string accepted by edr-pydantic. To enforce a naming convention across all collections, use `collection_id_pattern`:
+
+```yaml
+# Only allow lowercase snake_case collection IDs
+collection_id_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+The pattern is matched using Python's `re.fullmatch()`, so it must match the **entire** ID string.
+
+#### CRS, TRS, and VRS Constraints
+
+Each collection declares a CRS in `extent.spatial.crs`, and optionally a TRS in `extent.temporal.trs` and VRS in `extent.vertical.vrs`. The profile can constrain these values in two ways:
+
+**Enumerated list** — only the exact values listed are accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  allowed_crs:
+    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+    - "http://www.opengis.net/def/crs/EPSG/0/4326"
+```
+
+**Regex pattern** — any value matching the pattern is accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+```
+
+If both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both**. At least one of `allowed_crs` or `crs_pattern` is required when `extent_requirements` is present.
+
+The same enum/regex approach works for TRS (`allowed_trs` / `trs_pattern`) and VRS (`allowed_vrs` / `vrs_pattern`).
+
+#### Parameter Name Constraints
+
+By default, parameter names (the keys in `parameter_names`) can be any string. To enforce a naming convention, use `parameter_name_pattern`:
+
+```yaml
+# CF-style lowercase parameter names
+parameter_name_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+```yaml
+# Allow uppercase abbreviations like WMO codes
+parameter_name_pattern: "^[A-Za-z][A-Za-z0-9_]*$"
+```
+
+Every key in every collection's `parameter_names` must match this pattern. The pattern uses `re.fullmatch()`.
+
+Additionally, per OGC API - EDR Part 3, every parameter must specify both `unit` and `observedProperty`. The tool enforces this automatically.
+
+#### Requirement and Test IDs
+
+| Field | Rules |
+|---|---|
+| Requirement `id` | Must match `^[a-z0-9][a-z0-9\-]*$` — lowercase, digits, hyphens. Cannot end with a hyphen. |
+| AbstractTest `id` | Must exactly equal its `requirement_id`. |
+| AbstractTest `requirement_id` | Must reference an existing requirement `id`. |
+
+#### What Happens When Validation Fails
+
+The tool prints a Pydantic validation error with the field path and a human-readable message. For example:
+
+```
+Value error, Collection 'my_data' CRS 'urn:ogc:def:crs:EPSG::4326'
+does not match crs_pattern '^http://www\.opengis\.net/def/crs/(OGC|EPSG)/.*$'
+```
+
+```
+Value error, Parameter name 'WIND_SPEED' in collection 'weather'
+does not match parameter_name_pattern '^[a-z][a-z0-9_]*$'
+```
+
+```
+Value error, Collection id 'My-Collection' does not match
+collection_id_pattern '^[a-z][a-z0-9_]*$'
+```
+
+### How Patterns Flow Into the Generated OpenAPI
+
+When you specify `crs_pattern`, `allowed_crs`, or `parameter_name_pattern`, those constraints are embedded in the generated `openapi.yaml` so that runtime validation tools can enforce them:
+
+- `crs_pattern` → `pattern` on the CRS string schema in collection responses
+- `allowed_crs` → `enum` on the CRS string schema
+- `trs_pattern` / `allowed_trs` → `pattern` / `enum` on the TRS field in extent.temporal
+- `vrs_pattern` / `allowed_vrs` → `pattern` / `enum` on the VRS field in extent.vertical
+- `parameter_name_pattern` → `propertyNames.pattern` on the `parameter_names` object schema
+
+This means schemathesis, CITE tests, and client SDKs can validate server responses against these constraints without needing access to the original profile YAML.
+
+### Quick Reference: Regex Examples
+
+| Use Case | Pattern |
+|---|---|
+| Only OGC CRS84 | `^http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84$` |
+| Any OGC or EPSG CRS | `^http://www\\.opengis\\.net/def/crs/(OGC\|EPSG)/.*$` |
+| Any valid CRS URI | `^http://www\\.opengis\\.net/def/crs/.*$` |
+| ISO-8601 TRS family | `^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$` |
+| Lowercase snake_case names | `^[a-z][a-z0-9_]*$` |
+| CF standard name style | `^[a-z][a-z0-9_]*(_[a-z0-9]+)*$` |
+| WMO-style alphanumeric | `^[A-Za-z][A-Za-z0-9_]*$` |
+| Lowercase with hyphens | `^[a-z][a-z0-9\\-]*$` |
+
+---
+
 ## Config Reference
 
 ### Top-level fields
@@ -313,7 +443,8 @@ The skipped tests are optional features not implemented by the server.
 | `required_conformance_classes` | `list[string]` | no | Conformance classes that implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | `object` | no | Profile-level extent restrictions (see below) |
 | `output_formats` | `list` | no | Profile-level output format definitions with schema references (see below) |
-| `collection_id_pattern` | `string` | no | Regex pattern for valid collection IDs |
+| `collection_id_pattern` | `string` | no | Regex pattern that all collection IDs must match (validated at build time) |
+| `parameter_name_pattern` | `string` | no | Regex pattern that all `parameter_names` keys must match (validated at build time) |
 
 ---
 
@@ -376,7 +507,7 @@ parameter_names:
 
 ### `extent_requirements`
 
-Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
+Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent. These constraints are **enforced at profile build time** — if any collection's CRS, TRS, or VRS value violates the rules here, the profile will be rejected with a clear error message. The constraints are also **embedded in the generated OpenAPI** so that downstream tools (schemathesis, CITE tests, client SDKs) can enforce them at runtime.
 
 | Field | Type | Required | Description |
 |---|---|---|---|
@@ -390,6 +521,8 @@ Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
 
 **Note:** Either `allowed_crs` or `crs_pattern` must be specified.
 
+**Enum approach** — lock down to specific values:
+
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
@@ -400,6 +533,19 @@ extent_requirements:
     - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
+**Regex approach** — allow any CRS from a family:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+  # Accept any ISO-8601 TRS
+  trs_pattern: "^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$"
+```
+
+Both approaches can coexist — if both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both** constraints.
+
 ---
 
 ### `output_formats[]`
@@ -561,12 +707,23 @@ This tool implements the requirements of OGC API - EDR Part 3: Service Profiles
 4. **Extent Requirements** (REQ_extent)
    - Profile-level `extent_requirements` specify minimum bounds
    - CRS/TRS/VRS restrictions via enumerated lists or regex patterns
+   - **Enforced at build time**: collection CRS/TRS/VRS values are validated against `allowed_*` lists and `*_pattern` regexes
+   - **Propagated to OpenAPI**: constraints appear as `enum` or `pattern` in the generated collection response schemas
+
+5. **Parameter Names** (REQ_parameter-names)
+   - Validates that all parameters specify `unit` and `observedProperty`
+   - Optional `parameter_name_pattern` enforces naming conventions across all collections
+   - Pattern constraints are embedded in the generated OpenAPI as `propertyNames.pattern`
+
+6. **Collection ID Pattern**
+   - Optional `collection_id_pattern` enforces naming conventions for collection IDs
+   - Validated at build time via `re.fullmatch()`
 
-5. **Output Formats** (REQ_output-format)
+7. **Output Formats** (REQ_output-format)
    - Profile-level `output_formats` with schema references
    - Links to JSON Schema, XML Schema, or format specifications
 
-6. **Pub/Sub** (REQ_pubsub)
+8. **Pub/Sub** (REQ_pubsub)
    - Automatically adds Part 2 conformance requirement when `pubsub` is present
    - AsyncAPI document specifies channels and payloads
 
@@ -619,7 +776,7 @@ generate(profile, Path("./output"))
 
 ## License
 
-MIT — See [LICENSE](LICENSE) for details.
+Apache — See [LICENSE](LICENSE) for details.
 
 ## Contact
 

{oapi_profile_builder-2.0.2 → oapi_profile_builder-2.0.3}/README.md

@@ -18,6 +18,9 @@ pip install oapi-profile-builder
 
 ## Workflow
 
+<img width="1001" height="721" alt="OGC API Service Profile Builder - Pydantic Validation Architecture drawio" src="https://github.com/user-attachments/assets/092c3dfc-549e-41b0-8a92-af0b89689950" />
+
+
 ### 1. Author a Profile Config
 
 A profile config is a YAML or JSON file. Start with the minimal example:
@@ -248,6 +251,133 @@ The skipped tests are optional features not implemented by the server.
 
 ---
 
+## Profile Configuration Guide
+
+This section explains what is and isn't allowed when creating a profile, and how the tool validates your configuration.
+
+### What Gets Validated
+
+When you run `generate` or `validate`, the tool instantiates a `ServiceProfile` Pydantic model that enforces all of the following rules before any files are written. If any rule is violated, you get a clear error message pointing to the offending field.
+
+#### Profile-Level Fields
+
+| Field | Rules |
+|---|---|
+| `name` | Must match `^[a-z0-9_]+$` — lowercase letters, digits, and underscores only. Used in OGC URIs. |
+| `title` | Any non-empty string. |
+| `version` | Any string. Defaults to `"1.0"`. |
+| `collections` | At least one collection is required. No duplicate `id` values. |
+
+#### Collection IDs
+
+By default, collection IDs can be any string accepted by edr-pydantic. To enforce a naming convention across all collections, use `collection_id_pattern`:
+
+```yaml
+# Only allow lowercase snake_case collection IDs
+collection_id_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+The pattern is matched using Python's `re.fullmatch()`, so it must match the **entire** ID string.
+
+#### CRS, TRS, and VRS Constraints
+
+Each collection declares a CRS in `extent.spatial.crs`, and optionally a TRS in `extent.temporal.trs` and VRS in `extent.vertical.vrs`. The profile can constrain these values in two ways:
+
+**Enumerated list** — only the exact values listed are accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  allowed_crs:
+    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+    - "http://www.opengis.net/def/crs/EPSG/0/4326"
+```
+
+**Regex pattern** — any value matching the pattern is accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+```
+
+If both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both**. At least one of `allowed_crs` or `crs_pattern` is required when `extent_requirements` is present.
+
+The same enum/regex approach works for TRS (`allowed_trs` / `trs_pattern`) and VRS (`allowed_vrs` / `vrs_pattern`).
+
+#### Parameter Name Constraints
+
+By default, parameter names (the keys in `parameter_names`) can be any string. To enforce a naming convention, use `parameter_name_pattern`:
+
+```yaml
+# CF-style lowercase parameter names
+parameter_name_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+```yaml
+# Allow uppercase abbreviations like WMO codes
+parameter_name_pattern: "^[A-Za-z][A-Za-z0-9_]*$"
+```
+
+Every key in every collection's `parameter_names` must match this pattern. The pattern uses `re.fullmatch()`.
+
+Additionally, per OGC API - EDR Part 3, every parameter must specify both `unit` and `observedProperty`. The tool enforces this automatically.
+
+#### Requirement and Test IDs
+
+| Field | Rules |
+|---|---|
+| Requirement `id` | Must match `^[a-z0-9][a-z0-9\-]*$` — lowercase, digits, hyphens. Cannot end with a hyphen. |
+| AbstractTest `id` | Must exactly equal its `requirement_id`. |
+| AbstractTest `requirement_id` | Must reference an existing requirement `id`. |
+
+#### What Happens When Validation Fails
+
+The tool prints a Pydantic validation error with the field path and a human-readable message. For example:
+
+```
+Value error, Collection 'my_data' CRS 'urn:ogc:def:crs:EPSG::4326'
+does not match crs_pattern '^http://www\.opengis\.net/def/crs/(OGC|EPSG)/.*$'
+```
+
+```
+Value error, Parameter name 'WIND_SPEED' in collection 'weather'
+does not match parameter_name_pattern '^[a-z][a-z0-9_]*$'
+```
+
+```
+Value error, Collection id 'My-Collection' does not match
+collection_id_pattern '^[a-z][a-z0-9_]*$'
+```
+
+### How Patterns Flow Into the Generated OpenAPI
+
+When you specify `crs_pattern`, `allowed_crs`, or `parameter_name_pattern`, those constraints are embedded in the generated `openapi.yaml` so that runtime validation tools can enforce them:
+
+- `crs_pattern` → `pattern` on the CRS string schema in collection responses
+- `allowed_crs` → `enum` on the CRS string schema
+- `trs_pattern` / `allowed_trs` → `pattern` / `enum` on the TRS field in extent.temporal
+- `vrs_pattern` / `allowed_vrs` → `pattern` / `enum` on the VRS field in extent.vertical
+- `parameter_name_pattern` → `propertyNames.pattern` on the `parameter_names` object schema
+
+This means schemathesis, CITE tests, and client SDKs can validate server responses against these constraints without needing access to the original profile YAML.
+
+### Quick Reference: Regex Examples
+
+| Use Case | Pattern |
+|---|---|
+| Only OGC CRS84 | `^http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84$` |
+| Any OGC or EPSG CRS | `^http://www\\.opengis\\.net/def/crs/(OGC\|EPSG)/.*$` |
+| Any valid CRS URI | `^http://www\\.opengis\\.net/def/crs/.*$` |
+| ISO-8601 TRS family | `^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$` |
+| Lowercase snake_case names | `^[a-z][a-z0-9_]*$` |
+| CF standard name style | `^[a-z][a-z0-9_]*(_[a-z0-9]+)*$` |
+| WMO-style alphanumeric | `^[A-Za-z][A-Za-z0-9_]*$` |
+| Lowercase with hyphens | `^[a-z][a-z0-9\\-]*$` |
+
+---
+
 ## Config Reference
 
 ### Top-level fields
@@ -268,7 +398,8 @@ The skipped tests are optional features not implemented by the server.
 | `required_conformance_classes` | `list[string]` | no | Conformance classes that implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | `object` | no | Profile-level extent restrictions (see below) |
 | `output_formats` | `list` | no | Profile-level output format definitions with schema references (see below) |
-| `collection_id_pattern` | `string` | no | Regex pattern for valid collection IDs |
+| `collection_id_pattern` | `string` | no | Regex pattern that all collection IDs must match (validated at build time) |
+| `parameter_name_pattern` | `string` | no | Regex pattern that all `parameter_names` keys must match (validated at build time) |
 
 ---
 
@@ -331,7 +462,7 @@ parameter_names:
 
 ### `extent_requirements`
 
-Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
+Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent. These constraints are **enforced at profile build time** — if any collection's CRS, TRS, or VRS value violates the rules here, the profile will be rejected with a clear error message. The constraints are also **embedded in the generated OpenAPI** so that downstream tools (schemathesis, CITE tests, client SDKs) can enforce them at runtime.
 
 | Field | Type | Required | Description |
 |---|---|---|---|
@@ -345,6 +476,8 @@ Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
 
 **Note:** Either `allowed_crs` or `crs_pattern` must be specified.
 
+**Enum approach** — lock down to specific values:
+
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
@@ -355,6 +488,19 @@ extent_requirements:
     - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
+**Regex approach** — allow any CRS from a family:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+  # Accept any ISO-8601 TRS
+  trs_pattern: "^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$"
+```
+
+Both approaches can coexist — if both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both** constraints.
+
 ---
 
 ### `output_formats[]`
@@ -516,12 +662,23 @@ This tool implements the requirements of OGC API - EDR Part 3: Service Profiles
 4. **Extent Requirements** (REQ_extent)
    - Profile-level `extent_requirements` specify minimum bounds
    - CRS/TRS/VRS restrictions via enumerated lists or regex patterns
+   - **Enforced at build time**: collection CRS/TRS/VRS values are validated against `allowed_*` lists and `*_pattern` regexes
+   - **Propagated to OpenAPI**: constraints appear as `enum` or `pattern` in the generated collection response schemas
+
+5. **Parameter Names** (REQ_parameter-names)
+   - Validates that all parameters specify `unit` and `observedProperty`
+   - Optional `parameter_name_pattern` enforces naming conventions across all collections
+   - Pattern constraints are embedded in the generated OpenAPI as `propertyNames.pattern`
+
+6. **Collection ID Pattern**
+   - Optional `collection_id_pattern` enforces naming conventions for collection IDs
+   - Validated at build time via `re.fullmatch()`
 
-5. **Output Formats** (REQ_output-format)
+7. **Output Formats** (REQ_output-format)
    - Profile-level `output_formats` with schema references
    - Links to JSON Schema, XML Schema, or format specifications
 
-6. **Pub/Sub** (REQ_pubsub)
+8. **Pub/Sub** (REQ_pubsub)
    - Automatically adds Part 2 conformance requirement when `pubsub` is present
    - AsyncAPI document specifies channels and payloads
 
@@ -574,7 +731,7 @@ generate(profile, Path("./output"))
 
 ## License
 
-MIT — See [LICENSE](LICENSE) for details.
+Apache — See [LICENSE](LICENSE) for details.
 
 ## Contact
 

{oapi_profile_builder-2.0.2 → oapi_profile_builder-2.0.3}/pyproject.toml

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

{oapi_profile_builder-2.0.2 → oapi_profile_builder-2.0.3}/src/oapi_profile_builder/generate.py

@@ -176,12 +176,111 @@ _QUERY_PARAMS: dict[str, list[dict]] = {
 }
 
 
-def _collection_paths(coll: Collection, examples: dict | None = None) -> dict:
+def _collection_response_schema(coll: Collection,
+                                profile: "ServiceProfile | None") -> dict:
+    """Build a 200 response schema for a single collection endpoint.
+
+    When the profile specifies extent_requirements (allowed_crs / crs_pattern,
+    allowed_trs / trs_pattern, allowed_vrs / vrs_pattern) or a
+    parameter_name_pattern, those constraints are embedded in the response
+    schema so that downstream tools (schemathesis, CITE, client SDKs) can
+    enforce them at runtime.
+    """
+    # Start with the base collection schema
+    crs_schema: dict = {"type": "string"}
+    param_name_schema: dict = {"type": "string"}
+
+    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 profile and profile.parameter_name_pattern:
+        param_name_schema["pattern"] = profile.parameter_name_pattern
+
+    schema: dict = {
+        "type": "object",
+        "required": ["id"],
+        "properties": {
+            "id": {"type": "string"},
+            "title": {"type": "string"},
+            "description": {"type": "string"},
+            "links": _LINKS_ARRAY,
+            "crs": {
+                "type": "array",
+                "items": crs_schema,
+            },
+            "parameter_names": {
+                "type": "object",
+                "additionalProperties": {"type": "object"},
+            },
+        },
+    }
+
+    # If we have a parameter_name_pattern, constrain the property names
+    if profile and profile.parameter_name_pattern:
+        schema["properties"]["parameter_names"]["propertyNames"] = param_name_schema
+
+    # Embed TRS constraint in extent.temporal if present
+    if profile and profile.extent_requirements:
+        er = profile.extent_requirements
+        trs_schema: dict = {"type": "string"}
+        if er.allowed_trs:
+            trs_schema["enum"] = er.allowed_trs
+        elif er.trs_pattern:
+            trs_schema["pattern"] = er.trs_pattern
+
+        vrs_schema: dict = {"type": "string"}
+        if er.allowed_vrs:
+            vrs_schema["enum"] = er.allowed_vrs
+        elif er.vrs_pattern:
+            vrs_schema["pattern"] = er.vrs_pattern
+
+        schema["properties"]["extent"] = {
+            "type": "object",
+            "properties": {
+                "spatial": {
+                    "type": "object",
+                    "properties": {
+                        "bbox": {"type": "array"},
+                        "crs": crs_schema,
+                    },
+                },
+                "temporal": {
+                    "type": "object",
+                    "properties": {
+                        "trs": trs_schema,
+                    },
+                },
+                "vertical": {
+                    "type": "object",
+                    "properties": {
+                        "vrs": vrs_schema,
+                    },
+                },
+            },
+        }
+
+    return {
+        "description": "Collection metadata",
+        "content": {"application/json": {"schema": schema}},
+    }
+
+
+def _collection_paths(coll: Collection, examples: dict | None = None,
+                      profile: ServiceProfile | None = None) -> dict:
     paths: dict = {}
     base = f"/collections/{coll.id}"
     tag = coll.id
     desc = getattr(coll, "description", None) or coll.id
 
+    # Build a collection-specific response schema that includes CRS and
+    # parameter-name constraints from the profile's extent_requirements
+    # and parameter_name_pattern.
+    coll_schema = _collection_response_schema(coll, profile)
+
     paths[base] = {"get": {
         "summary": f"Get {coll.title or coll.id} metadata",
         "description": desc,
@@ -189,7 +288,7 @@ def _collection_paths(coll: Collection, examples: dict | None = None) -> dict:
         "tags": [tag],
         "parameters": [_F, _LANG],
         "responses": {
-            "200": _R200_COLLECTION,
+            "200": coll_schema,
             "400": _ERR_400, "404": _ERR_404, "500": _ERR_500,
         },
     }}
@@ -477,7 +576,7 @@ def _processes_paths(profile: ServiceProfile) -> dict:
 def build_openapi(profile: ServiceProfile) -> dict:
     paths: dict = _core_paths(profile)
     for coll in profile.collections:
-        paths.update(_collection_paths(coll, profile.collection_examples.get(coll.id)))
+        paths.update(_collection_paths(coll, profile.collection_examples.get(coll.id), profile))
     paths.update(_processes_paths(profile))
 
     tags = [{"name": "server", "description": profile.title}]

{oapi_profile_builder-2.0.2 → oapi_profile_builder-2.0.3}/src/oapi_profile_builder/models.py

@@ -38,6 +38,7 @@ so that EDR data model types are authoritative and shared with the broader ecosy
 
 from __future__ import annotations
 
+import re
 from enum import Enum
 from typing import Annotated, Literal
 
@@ -201,6 +202,10 @@ class ServiceProfile(BaseModel):
         default=None,
         description="Regex pattern for valid collection IDs"
     )
+    parameter_name_pattern: str | None = Field(
+        default=None,
+        description="Regex pattern that all parameter_names keys must match"
+    )
 
     # OGC identifiers derived from name — not user-supplied
     @property
@@ -270,3 +275,113 @@ class ServiceProfile(BaseModel):
                     )
                 )
         return self
+
+    @model_validator(mode="after")
+    def validate_collection_id_pattern(self) -> ServiceProfile:
+        """Validate collection IDs against collection_id_pattern if specified."""
+        if not self.collection_id_pattern:
+            return self
+        try:
+            pat = re.compile(self.collection_id_pattern)
+        except re.error as exc:
+            raise ValueError(f"Invalid collection_id_pattern regex: {exc}") from exc
+        for coll in self.collections:
+            if not pat.fullmatch(coll.id):
+                raise ValueError(
+                    f"Collection id '{coll.id}' does not match "
+                    f"collection_id_pattern '{self.collection_id_pattern}'"
+                )
+        return self
+
+    @model_validator(mode="after")
+    def validate_collection_extent_patterns(self) -> ServiceProfile:
+        """Validate collection CRS/TRS/VRS values against extent_requirements patterns and enums."""
+        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)
+
+        for coll in self.collections:
+            # --- 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}'"
+                    )
+
+            # --- 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}'"
+                    )
+
+            # --- 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}'"
+                    )
+        return self
+
+    @model_validator(mode="after")
+    def validate_parameter_name_patterns(self) -> ServiceProfile:
+        """Validate parameter_names keys against parameter_name_pattern if specified."""
+        if not self.parameter_name_pattern:
+            return self
+        try:
+            pat = re.compile(self.parameter_name_pattern)
+        except re.error as exc:
+            raise ValueError(f"Invalid parameter_name_pattern regex: {exc}") from exc
+        for coll in self.collections:
+            if not coll.parameter_names:
+                continue
+            for name in coll.parameter_names.root:
+                if not pat.fullmatch(name):
+                    raise ValueError(
+                        f"Parameter name '{name}' in collection '{coll.id}' "
+                        f"does not match parameter_name_pattern "
+                        f"'{self.parameter_name_pattern}'"
+                    )
+        return self
+
+
+def _compile_optional_pattern(label: str, pattern: str | None) -> re.Pattern | None:
+    """Compile a regex pattern string, raising ValueError on invalid syntax."""
+    if pattern is None:
+        return None
+    try:
+        return re.compile(pattern)
+    except re.error as exc:
+        raise ValueError(f"Invalid {label} regex '{pattern}': {exc}") from exc

{oapi_profile_builder-2.0.2 → oapi_profile_builder-2.0.3/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.0.2
+Version: 2.0.3
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -63,6 +63,9 @@ pip install oapi-profile-builder
 
 ## Workflow
 
+<img width="1001" height="721" alt="OGC API Service Profile Builder - Pydantic Validation Architecture drawio" src="https://github.com/user-attachments/assets/092c3dfc-549e-41b0-8a92-af0b89689950" />
+
+
 ### 1. Author a Profile Config
 
 A profile config is a YAML or JSON file. Start with the minimal example:
@@ -293,6 +296,133 @@ The skipped tests are optional features not implemented by the server.
 
 ---
 
+## Profile Configuration Guide
+
+This section explains what is and isn't allowed when creating a profile, and how the tool validates your configuration.
+
+### What Gets Validated
+
+When you run `generate` or `validate`, the tool instantiates a `ServiceProfile` Pydantic model that enforces all of the following rules before any files are written. If any rule is violated, you get a clear error message pointing to the offending field.
+
+#### Profile-Level Fields
+
+| Field | Rules |
+|---|---|
+| `name` | Must match `^[a-z0-9_]+$` — lowercase letters, digits, and underscores only. Used in OGC URIs. |
+| `title` | Any non-empty string. |
+| `version` | Any string. Defaults to `"1.0"`. |
+| `collections` | At least one collection is required. No duplicate `id` values. |
+
+#### Collection IDs
+
+By default, collection IDs can be any string accepted by edr-pydantic. To enforce a naming convention across all collections, use `collection_id_pattern`:
+
+```yaml
+# Only allow lowercase snake_case collection IDs
+collection_id_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+The pattern is matched using Python's `re.fullmatch()`, so it must match the **entire** ID string.
+
+#### CRS, TRS, and VRS Constraints
+
+Each collection declares a CRS in `extent.spatial.crs`, and optionally a TRS in `extent.temporal.trs` and VRS in `extent.vertical.vrs`. The profile can constrain these values in two ways:
+
+**Enumerated list** — only the exact values listed are accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  allowed_crs:
+    - "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
+    - "http://www.opengis.net/def/crs/EPSG/0/4326"
+```
+
+**Regex pattern** — any value matching the pattern is accepted:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+```
+
+If both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both**. At least one of `allowed_crs` or `crs_pattern` is required when `extent_requirements` is present.
+
+The same enum/regex approach works for TRS (`allowed_trs` / `trs_pattern`) and VRS (`allowed_vrs` / `vrs_pattern`).
+
+#### Parameter Name Constraints
+
+By default, parameter names (the keys in `parameter_names`) can be any string. To enforce a naming convention, use `parameter_name_pattern`:
+
+```yaml
+# CF-style lowercase parameter names
+parameter_name_pattern: "^[a-z][a-z0-9_]*$"
+```
+
+```yaml
+# Allow uppercase abbreviations like WMO codes
+parameter_name_pattern: "^[A-Za-z][A-Za-z0-9_]*$"
+```
+
+Every key in every collection's `parameter_names` must match this pattern. The pattern uses `re.fullmatch()`.
+
+Additionally, per OGC API - EDR Part 3, every parameter must specify both `unit` and `observedProperty`. The tool enforces this automatically.
+
+#### Requirement and Test IDs
+
+| Field | Rules |
+|---|---|
+| Requirement `id` | Must match `^[a-z0-9][a-z0-9\-]*$` — lowercase, digits, hyphens. Cannot end with a hyphen. |
+| AbstractTest `id` | Must exactly equal its `requirement_id`. |
+| AbstractTest `requirement_id` | Must reference an existing requirement `id`. |
+
+#### What Happens When Validation Fails
+
+The tool prints a Pydantic validation error with the field path and a human-readable message. For example:
+
+```
+Value error, Collection 'my_data' CRS 'urn:ogc:def:crs:EPSG::4326'
+does not match crs_pattern '^http://www\.opengis\.net/def/crs/(OGC|EPSG)/.*$'
+```
+
+```
+Value error, Parameter name 'WIND_SPEED' in collection 'weather'
+does not match parameter_name_pattern '^[a-z][a-z0-9_]*$'
+```
+
+```
+Value error, Collection id 'My-Collection' does not match
+collection_id_pattern '^[a-z][a-z0-9_]*$'
+```
+
+### How Patterns Flow Into the Generated OpenAPI
+
+When you specify `crs_pattern`, `allowed_crs`, or `parameter_name_pattern`, those constraints are embedded in the generated `openapi.yaml` so that runtime validation tools can enforce them:
+
+- `crs_pattern` → `pattern` on the CRS string schema in collection responses
+- `allowed_crs` → `enum` on the CRS string schema
+- `trs_pattern` / `allowed_trs` → `pattern` / `enum` on the TRS field in extent.temporal
+- `vrs_pattern` / `allowed_vrs` → `pattern` / `enum` on the VRS field in extent.vertical
+- `parameter_name_pattern` → `propertyNames.pattern` on the `parameter_names` object schema
+
+This means schemathesis, CITE tests, and client SDKs can validate server responses against these constraints without needing access to the original profile YAML.
+
+### Quick Reference: Regex Examples
+
+| Use Case | Pattern |
+|---|---|
+| Only OGC CRS84 | `^http://www\\.opengis\\.net/def/crs/OGC/1\\.3/CRS84$` |
+| Any OGC or EPSG CRS | `^http://www\\.opengis\\.net/def/crs/(OGC\|EPSG)/.*$` |
+| Any valid CRS URI | `^http://www\\.opengis\\.net/def/crs/.*$` |
+| ISO-8601 TRS family | `^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$` |
+| Lowercase snake_case names | `^[a-z][a-z0-9_]*$` |
+| CF standard name style | `^[a-z][a-z0-9_]*(_[a-z0-9]+)*$` |
+| WMO-style alphanumeric | `^[A-Za-z][A-Za-z0-9_]*$` |
+| Lowercase with hyphens | `^[a-z][a-z0-9\\-]*$` |
+
+---
+
 ## Config Reference
 
 ### Top-level fields
@@ -313,7 +443,8 @@ The skipped tests are optional features not implemented by the server.
 | `required_conformance_classes` | `list[string]` | no | Conformance classes that implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | `object` | no | Profile-level extent restrictions (see below) |
 | `output_formats` | `list` | no | Profile-level output format definitions with schema references (see below) |
-| `collection_id_pattern` | `string` | no | Regex pattern for valid collection IDs |
+| `collection_id_pattern` | `string` | no | Regex pattern that all collection IDs must match (validated at build time) |
+| `parameter_name_pattern` | `string` | no | Regex pattern that all `parameter_names` keys must match (validated at build time) |
 
 ---
 
@@ -376,7 +507,7 @@ parameter_names:
 
 ### `extent_requirements`
 
-Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
+Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent. These constraints are **enforced at profile build time** — if any collection's CRS, TRS, or VRS value violates the rules here, the profile will be rejected with a clear error message. The constraints are also **embedded in the generated OpenAPI** so that downstream tools (schemathesis, CITE tests, client SDKs) can enforce them at runtime.
 
 | Field | Type | Required | Description |
 |---|---|---|---|
@@ -390,6 +521,8 @@ Profile-level extent restrictions per OGC API - EDR Part 3 REQ_extent.
 
 **Note:** Either `allowed_crs` or `crs_pattern` must be specified.
 
+**Enum approach** — lock down to specific values:
+
 ```yaml
 extent_requirements:
   minimum_bbox: [-180, -90, 180, 90]
@@ -400,6 +533,19 @@ extent_requirements:
     - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian"
 ```
 
+**Regex approach** — allow any CRS from a family:
+
+```yaml
+extent_requirements:
+  minimum_bbox: [-180, -90, 180, 90]
+  # Accept any OGC or EPSG CRS
+  crs_pattern: "^http://www\\.opengis\\.net/def/crs/(OGC|EPSG)/.*$"
+  # Accept any ISO-8601 TRS
+  trs_pattern: "^http://www\\.opengis\\.net/def/uom/ISO-8601/.*$"
+```
+
+Both approaches can coexist — if both `allowed_crs` and `crs_pattern` are specified, a collection's CRS must satisfy **both** constraints.
+
 ---
 
 ### `output_formats[]`
@@ -561,12 +707,23 @@ This tool implements the requirements of OGC API - EDR Part 3: Service Profiles
 4. **Extent Requirements** (REQ_extent)
    - Profile-level `extent_requirements` specify minimum bounds
    - CRS/TRS/VRS restrictions via enumerated lists or regex patterns
+   - **Enforced at build time**: collection CRS/TRS/VRS values are validated against `allowed_*` lists and `*_pattern` regexes
+   - **Propagated to OpenAPI**: constraints appear as `enum` or `pattern` in the generated collection response schemas
+
+5. **Parameter Names** (REQ_parameter-names)
+   - Validates that all parameters specify `unit` and `observedProperty`
+   - Optional `parameter_name_pattern` enforces naming conventions across all collections
+   - Pattern constraints are embedded in the generated OpenAPI as `propertyNames.pattern`
+
+6. **Collection ID Pattern**
+   - Optional `collection_id_pattern` enforces naming conventions for collection IDs
+   - Validated at build time via `re.fullmatch()`
 
-5. **Output Formats** (REQ_output-format)
+7. **Output Formats** (REQ_output-format)
    - Profile-level `output_formats` with schema references
    - Links to JSON Schema, XML Schema, or format specifications
 
-6. **Pub/Sub** (REQ_pubsub)
+8. **Pub/Sub** (REQ_pubsub)
    - Automatically adds Part 2 conformance requirement when `pubsub` is present
    - AsyncAPI document specifies channels and payloads
 
@@ -619,7 +776,7 @@ generate(profile, Path("./output"))
 
 ## License
 
-MIT — See [LICENSE](LICENSE) for details.
+Apache — See [LICENSE](LICENSE) for details.
 
 ## Contact