oapi-profile-builder 2.3.0__tar.gz → 2.5.0__tar.gz

{oapi_profile_builder-2.3.0/src/oapi_profile_builder.egg-info → oapi_profile_builder-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.3.0
+Version: 2.5.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -229,6 +229,10 @@ A profile config is a YAML file. The full JSON Schema is at [`profile.schema.jso
 name: my_profile          # lowercase, a-z 0-9 _ only
 title: My EDR Profile
 version: "1.0"
+description: Brief description of what this service profile provides.
+keywords:
+  - my-parameter
+  - my-domain
 
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
@@ -269,7 +273,10 @@ collections:
 | `name` | string | yes | Lowercase `a-z 0-9 _`. Drives OGC URIs and OpenAPI `operationId`s |
 | `title` | string | yes | Human-readable profile title |
 | `version` | string | no | Defaults to `"1.0"` |
+| `description` | string | no | Human-readable description of the service profile. Surfaces in the OpenAPI `info.description` and the landing page response schema |
+| `keywords` | list | no | Service-level keywords (e.g. query types, parameter names, domain terms). Surfaces in `info.x-keywords` and the landing page response schema. Distinct from `document_metadata.keywords`, which are for the OGC PDF header |
 | `server_url` | string | no | Documentation only — not written to the profile OpenAPI |
+| `allow_post_queries` | bool | no | When `true`, generates `POST` alongside `GET` for all EDR data query endpoints. Defaults to `false` |
 | `collections` | list | yes | One or more EDR collections (see below) |
 | `required_conformance_classes` | list | no | Conformance classes implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | object | no | Profile-level CRS/TRS/VRS constraints (see below) |

{oapi_profile_builder-2.3.0 → oapi_profile_builder-2.5.0}/README.md

@@ -184,6 +184,10 @@ A profile config is a YAML file. The full JSON Schema is at [`profile.schema.jso
 name: my_profile          # lowercase, a-z 0-9 _ only
 title: My EDR Profile
 version: "1.0"
+description: Brief description of what this service profile provides.
+keywords:
+  - my-parameter
+  - my-domain
 
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
@@ -224,7 +228,10 @@ collections:
 | `name` | string | yes | Lowercase `a-z 0-9 _`. Drives OGC URIs and OpenAPI `operationId`s |
 | `title` | string | yes | Human-readable profile title |
 | `version` | string | no | Defaults to `"1.0"` |
+| `description` | string | no | Human-readable description of the service profile. Surfaces in the OpenAPI `info.description` and the landing page response schema |
+| `keywords` | list | no | Service-level keywords (e.g. query types, parameter names, domain terms). Surfaces in `info.x-keywords` and the landing page response schema. Distinct from `document_metadata.keywords`, which are for the OGC PDF header |
 | `server_url` | string | no | Documentation only — not written to the profile OpenAPI |
+| `allow_post_queries` | bool | no | When `true`, generates `POST` alongside `GET` for all EDR data query endpoints. Defaults to `false` |
 | `collections` | list | yes | One or more EDR collections (see below) |
 | `required_conformance_classes` | list | no | Conformance classes implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | object | no | Profile-level CRS/TRS/VRS constraints (see below) |

{oapi_profile_builder-2.3.0 → oapi_profile_builder-2.5.0}/pyproject.toml

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

{oapi_profile_builder-2.3.0 → oapi_profile_builder-2.5.0}/src/oapi_profile_builder/generate.py

@@ -89,7 +89,32 @@ _LINK_SCHEMA = {
 _LINKS_ARRAY = {"type": "array", "items": _LINK_SCHEMA}
 
 # Landing page response with required profile link per REQ_publishing
-def _landing_page_schema(profile_uri: str) -> dict:
+def _landing_page_schema(profile_uri: str, title: str = "", description: str = "", keywords: list | None = None) -> dict:
+    schema_props: dict = {
+        "links": {
+            "type": "array",
+            "items": _LINK_SCHEMA,
+            "contains": {
+                "type": "object",
+                "required": ["href", "rel"],
+                "properties": {
+                    "rel": {"const": "profile"},
+                    "href": {"const": profile_uri},
+                },
+            },
+        },
+    }
+    if title:
+        schema_props["title"] = {"type": "string", "const": title}
+    if description:
+        schema_props["description"] = {"type": "string"}
+    if keywords:
+        schema_props["keywords"] = {
+            "type": "array",
+            "items": {"type": "string"},
+            "contains": {"enum": keywords},
+        }
+
     return {
         "description": "Landing page",
         "content": {
@@ -97,23 +122,10 @@ def _landing_page_schema(profile_uri: str) -> dict:
                 "schema": {
                     "type": "object",
                     "required": ["links"],
-                    "properties": {
-                        "links": {
-                            "type": "array",
-                            "items": _LINK_SCHEMA,
-                            "contains": {
-                                "type": "object",
-                                "required": ["href", "rel"],
-                                "properties": {
-                                    "rel": {"const": "profile"},
-                                    "href": {"const": profile_uri}
-                                }
-                            }
-                        }
-                    }
+                    "properties": schema_props,
                 }
             }
-        }
+        },
     }
 
 _R200_CONFORMANCE = {
@@ -823,7 +835,12 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
 
 
 def _core_paths(profile: ServiceProfile) -> dict:
-    landing_response = _landing_page_schema(profile.req_uri)
+    landing_response = _landing_page_schema(
+        profile.req_uri,
+        title=profile.title,
+        description=profile.description or "",
+        keywords=profile.keywords or None,
+    )
     
     # Conformance response with required conformance classes
     conformance_response = _R200_CONFORMANCE.copy()
@@ -1016,8 +1033,9 @@ def build_openapi(profile: ServiceProfile) -> dict:
         "info": {
             "title": profile.title,
             "version": profile.version,
-            "description": f"OGC API - EDR Part 3 Service Profile: {profile.title}",
+            "description": profile.description or f"OGC API - EDR Part 3 Service Profile: {profile.title}",
             "x-ogc-profile": profile.req_uri,
+            "x-keywords": profile.keywords if profile.keywords else [],
             "contact": contact,
         },
         # Per OGC API - EDR Part 3 REQ_publishing: this profile is implementation-independent.

{oapi_profile_builder-2.3.0 → oapi_profile_builder-2.5.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=(
@@ -225,6 +240,22 @@ class ServiceProfile(BaseModel):
     name: Annotated[str, Field(pattern=r"^[a-z0-9_]+$")]
     title: str
     version: str = "1.0"
+    description: str | None = Field(
+        default=None,
+        description=(
+            "Human-readable description of the service profile. Surfaces in the "
+            "OpenAPI info block and the landing page response."
+        ),
+    )
+    keywords: list[str] = Field(
+        default_factory=list,
+        description=(
+            "Service-level keywords describing what this profile provides. "
+            "Surfaces in the OpenAPI info block (as x-keywords) and the landing "
+            "page response. Distinct from document_metadata.keywords, which are "
+            "for the OGC PDF header."
+        ),
+    )
     server_url: str | None = Field(default=None, description="Base URL for implementation (not used in profile OpenAPI per standard)")
     collections: list[Collection] = Field(min_length=1)
     collection_examples: dict[str, dict] = Field(default_factory=dict)
@@ -311,13 +342,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"

{oapi_profile_builder-2.3.0 → oapi_profile_builder-2.5.0/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 2.3.0
+Version: 2.5.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -229,6 +229,10 @@ A profile config is a YAML file. The full JSON Schema is at [`profile.schema.jso
 name: my_profile          # lowercase, a-z 0-9 _ only
 title: My EDR Profile
 version: "1.0"
+description: Brief description of what this service profile provides.
+keywords:
+  - my-parameter
+  - my-domain
 
 required_conformance_classes:
   - "http://www.opengis.net/spec/ogcapi-edr-1/1.0/conf/core"
@@ -269,7 +273,10 @@ collections:
 | `name` | string | yes | Lowercase `a-z 0-9 _`. Drives OGC URIs and OpenAPI `operationId`s |
 | `title` | string | yes | Human-readable profile title |
 | `version` | string | no | Defaults to `"1.0"` |
+| `description` | string | no | Human-readable description of the service profile. Surfaces in the OpenAPI `info.description` and the landing page response schema |
+| `keywords` | list | no | Service-level keywords (e.g. query types, parameter names, domain terms). Surfaces in `info.x-keywords` and the landing page response schema. Distinct from `document_metadata.keywords`, which are for the OGC PDF header |
 | `server_url` | string | no | Documentation only — not written to the profile OpenAPI |
+| `allow_post_queries` | bool | no | When `true`, generates `POST` alongside `GET` for all EDR data query endpoints. Defaults to `false` |
 | `collections` | list | yes | One or more EDR collections (see below) |
 | `required_conformance_classes` | list | no | Conformance classes implementations must declare. Defaults to EDR Core |
 | `extent_requirements` | object | no | Profile-level CRS/TRS/VRS constraints (see below) |