oapi-profile-builder 3.6.1__tar.gz → 3.6.3__tar.gz

{oapi_profile_builder-3.6.1/src/oapi_profile_builder.egg-info → oapi_profile_builder-3.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.6.1
+Version: 3.6.3
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -47,7 +47,7 @@ Dynamic: license-file
 
 # OGC API Service Profile Builder
 
-Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
+Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.0.0/3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
 
 [![PyPI](https://img.shields.io/pypi/v/oapi-profile-builder)](https://pypi.org/project/oapi-profile-builder/)
 [![License](https://img.shields.io/badge/license-Apache-blue)](LICENSE)
@@ -57,7 +57,9 @@ Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — O
 ## Quick Start
 
 ```bash
-pip install oapi-profile-builder
+# Base install. Adds Pillow (cover image generation) with the [pdf] extra —
+# required whenever your profile sets document_metadata.cover.logo.
+pip install 'oapi-profile-builder[pdf]'
 
 # Copy an example config and edit it
 cp examples/minimal_profile.yaml my_profile.yaml
@@ -70,7 +72,7 @@ That's it. The `output/` directory will contain:
 
 ```
 output/
-├── openapi.yaml          # OpenAPI 3.1.0 — ready for Swagger UI, Redoc, schemathesis
+├── openapi.yaml          # OpenAPI 3.0.0 or 3.1.0 — ready for Swagger UI, Redoc, schemathesis
 ├── profile_config.json   # Round-trip serialized profile
 ├── document.adoc         # Metanorma root document
 ├── sections/             # Abstract, Preface, Scope, Conformance, References, Terms
@@ -186,8 +188,18 @@ OGC API - EDR CITE Results
 Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
 
 1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
-2. Paste your profile YAML into the config field and submit.
-3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+2. Paste your profile YAML into the config field.
+3. If your profile references local files (typically a cover logo via `document_metadata.cover.logo`), drag-and-drop them into the **"Additional assets (optional)"** field. Reference each uploaded file in your YAML as `uploads/<original-filename>` — for example:
+
+    ```yaml
+    document_metadata:
+      cover:
+        logo: uploads/my_logo.png
+    ```
+
+    The workflow downloads each dropped file into `./uploads/` before generation. It parses your YAML to figure out the target filename, so images that GitHub renders as an `<img>` tag with a UUID URL still land at the exact path your config references. Tip: to skip the upload entirely for the DGIWG logo, point at the copy that already ships in this repo: `logo: examples/assets/DGIWG_logo.png`.
+4. Tick "Compile a PDF?" if you also want a Metanorma PDF, then submit.
+5. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days).
 
 The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
 
@@ -366,6 +378,7 @@ abstract_tests: []
 | `processes` | list | no | OGC API Processes to expose in the OpenAPI |
 | `requirements` | list | no | Normative requirements for the AsciiDoc/PDF |
 | `abstract_tests` | list | no | Conformance tests — each must reference a valid requirement `id` |
+| `abstract_tests[].method` | string | no | Optional test method description |
 | `pubsub` | object | no | OGC API - EDR Part 2 PubSub config — generates `asyncapi.yaml` |
 | `collection_examples` | object | no | `{collectionId: {instanceId: "..."}}` — used by `validate-server` |
 | `paging` | object | no | Features `/items` paging — adds a validated `limit` query parameter to the generated OpenAPI (see below) |
@@ -660,6 +673,7 @@ requirements:
 abstract_tests:
   - id: position-coveragejson          # must equal requirement_id
     requirement_id: position-coveragejson
+    method: Manual inspection of the /position response.
     steps:
       - Send GET /collections/{id}/position?coords=POINT(lon lat).
       - Verify Content-Type is application/prs.coverage+json.
@@ -812,7 +826,9 @@ Two `document_metadata` blocks let you rebrand the PDF (e.g. for DGIWG) without
 document_metadata:
   doc_number: "DGIWG 134"
   cover:
-    logo: assets/dgiwg_logo.png    # path relative to the working directory (or absolute)
+    logo: examples/assets/DGIWG_logo.png    # path relative to the working directory (or absolute).
+                                            # From the self-service issue form use uploads/<file>
+                                            # instead and drag-drop the file into "Additional assets".
     tagline: Delivering Military Advantage through multi-national geospatial interoperability
     background: "#FFFFFF"          # optional cover background (default white)
     text_color: "#1F3864"          # optional cover text colour (default black)

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3}/README.md

@@ -1,6 +1,6 @@
 # OGC API Service Profile Builder
 
-Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
+Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.0.0/3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
 
 [![PyPI](https://img.shields.io/pypi/v/oapi-profile-builder)](https://pypi.org/project/oapi-profile-builder/)
 [![License](https://img.shields.io/badge/license-Apache-blue)](LICENSE)
@@ -10,7 +10,9 @@ Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — O
 ## Quick Start
 
 ```bash
-pip install oapi-profile-builder
+# Base install. Adds Pillow (cover image generation) with the [pdf] extra —
+# required whenever your profile sets document_metadata.cover.logo.
+pip install 'oapi-profile-builder[pdf]'
 
 # Copy an example config and edit it
 cp examples/minimal_profile.yaml my_profile.yaml
@@ -23,7 +25,7 @@ That's it. The `output/` directory will contain:
 
 ```
 output/
-├── openapi.yaml          # OpenAPI 3.1.0 — ready for Swagger UI, Redoc, schemathesis
+├── openapi.yaml          # OpenAPI 3.0.0 or 3.1.0 — ready for Swagger UI, Redoc, schemathesis
 ├── profile_config.json   # Round-trip serialized profile
 ├── document.adoc         # Metanorma root document
 ├── sections/             # Abstract, Preface, Scope, Conformance, References, Terms
@@ -139,8 +141,18 @@ OGC API - EDR CITE Results
 Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
 
 1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
-2. Paste your profile YAML into the config field and submit.
-3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+2. Paste your profile YAML into the config field.
+3. If your profile references local files (typically a cover logo via `document_metadata.cover.logo`), drag-and-drop them into the **"Additional assets (optional)"** field. Reference each uploaded file in your YAML as `uploads/<original-filename>` — for example:
+
+    ```yaml
+    document_metadata:
+      cover:
+        logo: uploads/my_logo.png
+    ```
+
+    The workflow downloads each dropped file into `./uploads/` before generation. It parses your YAML to figure out the target filename, so images that GitHub renders as an `<img>` tag with a UUID URL still land at the exact path your config references. Tip: to skip the upload entirely for the DGIWG logo, point at the copy that already ships in this repo: `logo: examples/assets/DGIWG_logo.png`.
+4. Tick "Compile a PDF?" if you also want a Metanorma PDF, then submit.
+5. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days).
 
 The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
 
@@ -319,6 +331,7 @@ abstract_tests: []
 | `processes` | list | no | OGC API Processes to expose in the OpenAPI |
 | `requirements` | list | no | Normative requirements for the AsciiDoc/PDF |
 | `abstract_tests` | list | no | Conformance tests — each must reference a valid requirement `id` |
+| `abstract_tests[].method` | string | no | Optional test method description |
 | `pubsub` | object | no | OGC API - EDR Part 2 PubSub config — generates `asyncapi.yaml` |
 | `collection_examples` | object | no | `{collectionId: {instanceId: "..."}}` — used by `validate-server` |
 | `paging` | object | no | Features `/items` paging — adds a validated `limit` query parameter to the generated OpenAPI (see below) |
@@ -613,6 +626,7 @@ requirements:
 abstract_tests:
   - id: position-coveragejson          # must equal requirement_id
     requirement_id: position-coveragejson
+    method: Manual inspection of the /position response.
     steps:
       - Send GET /collections/{id}/position?coords=POINT(lon lat).
       - Verify Content-Type is application/prs.coverage+json.
@@ -765,7 +779,9 @@ Two `document_metadata` blocks let you rebrand the PDF (e.g. for DGIWG) without
 document_metadata:
   doc_number: "DGIWG 134"
   cover:
-    logo: assets/dgiwg_logo.png    # path relative to the working directory (or absolute)
+    logo: examples/assets/DGIWG_logo.png    # path relative to the working directory (or absolute).
+                                            # From the self-service issue form use uploads/<file>
+                                            # instead and drag-drop the file into "Additional assets".
     tagline: Delivering Military Advantage through multi-national geospatial interoperability
     background: "#FFFFFF"          # optional cover background (default white)
     text_color: "#1F3864"          # optional cover text colour (default black)

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3}/pyproject.toml

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

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3}/src/oapi_profile_builder/cover.py

@@ -43,9 +43,9 @@ _PAGE_H = 1754
 _COVER_FILENAME = "cover.png"
 
 # Default font family (bundled with Pillow, resolved by name).
-_DEFAULT_REGULAR = "DejaVuSans.ttf"
-_DEFAULT_BOLD = "DejaVuSans-Bold.ttf"
-_DEFAULT_ITALIC = "DejaVuSans-Oblique.ttf"
+_DEFAULT_REGULAR = "DejaVuSans"
+_DEFAULT_BOLD = "DejaVuSans-Bold"
+_DEFAULT_ITALIC = "DejaVuSans:style=Oblique"
 
 
 def _resolve_font_file(spec: str | None, *, bold: bool = False, italic: bool = False) -> str | None:
@@ -62,20 +62,40 @@ def _resolve_font_file(spec: str | None, *, bold: bool = False, italic: bool = F
     if p.is_file():
         return str(p)
     if shutil.which("fc-match"):
-        styles = []
-        if bold:
-            styles.append("Bold")
-        if italic:
-            styles.append("Italic")
-        query = spec if not styles else f"{spec}:style={' '.join(styles)}"
+        # If the spec already contains a colon, treat it as a full fontconfig query
+        if ":" in spec:
+            query = spec
+        else:
+            styles = []
+            if bold:
+                styles.append("Bold")
+            if italic:
+                styles.append("Italic")
+            query = spec if not styles else f"{spec}:style={' '.join(styles)}"
+            
         try:
+            # Try the primary query
             out = subprocess.run(
                 ["fc-match", "-f", "%{file}", query],
                 capture_output=True, text=True, timeout=5, check=False,
             )
             path = out.stdout.strip()
             if path and Path(path).is_file():
-                return path
+                # Verify that the result matches the requested style if possible.
+                # If we asked for Italic but got a Regular file, fc-match just fell back.
+                if italic and "Italic" not in path and "Oblique" not in path:
+                    # Try a second attempt explicitly asking for Oblique if Italic failed
+                    if ":" not in spec:
+                        query_oblique = f"{spec}:style=Oblique"
+                        out = subprocess.run(
+                            ["fc-match", "-f", "%{file}", query_oblique],
+                            capture_output=True, text=True, timeout=5, check=False,
+                        )
+                        path = out.stdout.strip()
+                        if path and Path(path).is_file() and ("Italic" in path or "Oblique" in path):
+                            return path
+                else:
+                    return path
         except Exception:
             pass
     return None
@@ -89,22 +109,36 @@ class _FontSet:
     ultimately fall back to the bundled DejaVu family.
     """
 
-    def __init__(self, cover=None):
+    def __init__(self, cover=None, metadata=None):
         self.regular = getattr(cover, "font_regular", None) if cover else None
         self.bold = getattr(cover, "font_bold", None) if cover else None
         self.italic = getattr(cover, "font_italic", None) if cover else None
+        
+        # Fallback to metadata-level font overrides if set
+        if not self.regular and metadata:
+            self.regular = getattr(metadata, "body_font", None)
+        if not self.bold and metadata:
+            self.bold = getattr(metadata, "header_font", None)
 
     def _font(self, size: int, *, bold: bool = False, italic: bool = False):
         from PIL import ImageFont
 
-        # Prefer an explicit per-style spec, else derive from the regular family.
-        explicit = self.bold if bold else (self.italic if italic else self.regular)
-        candidates = [
-            _resolve_font_file(explicit, bold=bold, italic=italic),
-            _resolve_font_file(self.regular, bold=bold, italic=italic),
-        ]
-        default = _DEFAULT_BOLD if bold else (_DEFAULT_ITALIC if italic else _DEFAULT_REGULAR)
-        candidates.append(default)
+        candidates = []
+        # 1. Try explicit style override (path or family name)
+        style_spec = self.bold if bold else (self.italic if italic else None)
+        if style_spec:
+            candidates.append(_resolve_font_file(style_spec, bold=bold, italic=italic))
+
+        # 2. Try deriving from the regular spec if it is a family name
+        if (bold or italic) and self.regular and not Path(self.regular).expanduser().is_file():
+            candidates.append(_resolve_font_file(self.regular, bold=bold, italic=italic))
+
+        # 3. Try standard defaults for the requested style
+        candidates.append(_DEFAULT_BOLD if bold else (_DEFAULT_ITALIC if italic else _DEFAULT_REGULAR))
+
+        # 4. Fallback to the regular font spec (even if not the right style)
+        candidates.append(_resolve_font_file(self.regular))
+
         for cand in candidates:
             if not cand:
                 continue
@@ -160,7 +194,7 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
 
     bg = cover.background or "#FFFFFF"
     fg = cover.text_color or "#000000"
-    fonts = _FontSet(cover)
+    fonts = _FontSet(cover, m)
 
     page = Image.new("RGB", (_PAGE_W, _PAGE_H), bg)
     draw = ImageDraw.Draw(page)
@@ -191,11 +225,18 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
     # --- Tagline (italic) ---
     if cover.tagline:
         tagline_fs = getattr(cover, "tagline_font_size", 30)
-        y = centered(cover.tagline, fonts.italic_font(tagline_fs), y, fg) + 60
+        tagline_font = fonts.italic_font(tagline_fs)
+        for line in _wrap(draw, cover.tagline, tagline_font, _PAGE_W - 240):
+            y = centered(line, tagline_font, y, fg) + 10
+        y += 50
 
     # --- Document number ---
     if m and m.doc_number:
-        y = centered(m.doc_number, fonts.regular_font(46, bold=True), y, fg) + 40
+        doc_num_font = fonts.regular_font(46, bold=True)
+        for line in _wrap(draw, m.doc_number, doc_num_font, _PAGE_W - 240):
+            y = centered(line, doc_num_font, y, fg) + 16
+        y += 24
+
 
     # --- Edition & date ---
     # Per DGIWG feedback these two lines are both bold and set a little smaller

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3}/src/oapi_profile_builder/generate.py

@@ -41,6 +41,16 @@ import yaml
 
 from edr_pydantic.collections import Collection
 from oapi_profile_builder.models import ServiceProfile
+def _const(val, version: str) -> dict:
+    if version == "3.1.0":
+        return {"const": val}
+    return {"enum": [val]}
+
+def _contains(schema: dict, version: str) -> dict:
+    if version == "3.1.0":
+        return {"contains": schema}
+    return {}
+
 
 
 class _NoAliasDumper(yaml.Dumper):
@@ -125,30 +135,30 @@ _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, title: str = "", description: str = "", keywords: list | None = None) -> dict:
+def _landing_page_schema(profile_uri: str, version: str, title: str = "", description: str = "", keywords: list | None = None) -> dict:
     schema_props: dict = {
         "links": {
             "type": "array",
             "items": _LINK_SCHEMA,
-            "contains": {
+            **(_contains({
                 "type": "object",
                 "required": ["href", "rel"],
                 "properties": {
-                    "rel": {"const": "profile"},
-                    "href": {"const": profile_uri},
+                    "rel": _const("profile", version),
+                    "href": _const(profile_uri, version),
                 },
-            },
+            }, version) if version == "3.1.0" else {}),
         },
     }
     if title:
-        schema_props["title"] = {"type": "string", "const": title}
+        schema_props["title"] = {"type": "string", **_const(title, version)}
     if description:
         schema_props["description"] = {"type": "string"}
     if keywords:
         schema_props["keywords"] = {
             "type": "array",
             "items": {"type": "string"},
-            "contains": {"enum": keywords},
+            **(_contains({"enum": keywords}, version) if version == "3.1.0" else {"items": {"type": "string", "enum": keywords}}),
         }
 
     return {
@@ -182,27 +192,30 @@ _R200_CONFORMANCE = {
     }
 }
 _R200_COLLECTION = {"description": "Collection metadata", "content": {"application/json": {"schema": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "title": {"type": "string"}, "description": {"type": "string"}, "links": _LINKS_ARRAY}}}}}
-_R200_FEATURES = {
-    "description": "Feature collection",
-    "content": {
-        "application/json": {
-            "schema": {
-                "type": "object",
-                "properties": {
-                    "type": {"type": "string", "const": "FeatureCollection"},
-                    "features": {
-                        "type": "array",
-                        "items": {"type": "object"},
+def _features_schema(version: str) -> dict:
+    return {
+        "description": "Feature collection",
+        "content": {
+            "application/json": {
+                "schema": {
+                    "type": "object",
+                    "properties": {
+                        "type": {"type": "string", **_const("FeatureCollection", version)},
+                        "features": {
+                            "type": "array",
+                            "items": {"type": "object"},
+                        },
                     },
                 },
             }
-        }
-    },
-}
+        },
+    }
 
 def _locations_response_schema(profile: "ServiceProfile | None") -> dict:
     """Build the 200 response for a /locations query.
 
+    version = profile.openapi_version if profile else "3.0.0"
+
     Per the EDR locations-response requirement (and the MetOcean profile's
     /req/core/locations_query_response_format), the response is a GeoJSON
     FeatureCollection where every feature carries a string ``id`` and a
@@ -210,6 +223,7 @@ def _locations_response_schema(profile: "ServiceProfile | None") -> dict:
     properties named in ``profile.locations_feature_required_properties`` are
     marked required so the generated OpenAPI enforces them.
     """
+    version = profile.openapi_version if profile else "3.0.0"
     required_props = list(getattr(profile, "locations_feature_required_properties", None) or [])
     properties_schema: dict = {
         "type": "object",
@@ -223,7 +237,7 @@ def _locations_response_schema(profile: "ServiceProfile | None") -> dict:
         "type": "object",
         "required": ["type", "id", "properties"],
         "properties": {
-            "type": {"type": "string", "const": "Feature"},
+            "type": {"type": "string", **_const("Feature", version)},
             "id": {"type": "string", "description": "Location identifier usable at /locations/{locId}"},
             "geometry": {"type": "object", "description": "GeoJSON geometry of the location"},
             "properties": properties_schema,
@@ -237,7 +251,7 @@ def _locations_response_schema(profile: "ServiceProfile | None") -> dict:
                     "type": "object",
                     "required": ["type", "features"],
                     "properties": {
-                        "type": {"type": "string", "const": "FeatureCollection"},
+                        "type": {"type": "string", **_const("FeatureCollection", version)},
                         "features": {"type": "array", "items": feature_schema},
                     },
                 }
@@ -267,11 +281,11 @@ def _coverage_response(coll: Collection, profile: "ServiceProfile | None") -> di
                 media_type = "application/prs.coverage+json"
                 # Also accept the newer media type
                 alt_media = "application/vnd.cov+json"
-                schema = (
-                    {"$ref": schema_ref}
-                    if schema_ref
-                    else {"$ref": f"{_EDR}/schemas/coverageJSON.yaml"}
-                )
+                if schema_ref:
+                     schema = {"$ref": schema_ref}
+                else:
+                     # Fallback to an inline object if external ref is problematic
+                     schema = {"type": "object"}
                 content[media_type] = {"schema": schema}
                 content[alt_media] = {"schema": schema}
             elif fmt_name == "GeoJSON":
@@ -517,6 +531,7 @@ def _collection_response_schema(coll: Collection,
     - Full parameter_names objects with all fields
     - parameter_name_pattern as propertyNames constraint
     """
+    version = profile.openapi_version if profile else "3.0.0"
     crs_schema: dict = {"type": "string"}       # extent.spatial.crs
     trs_schema: dict = {"type": "string"}       # extent.temporal.trs
     vrs_schema: dict = {"type": "string"}       # extent.vertical.vrs
@@ -549,13 +564,17 @@ def _collection_response_schema(coll: Collection,
         import copy
         param_item_schema = copy.deepcopy(profile.parameter_schema)
     else:
-        param_item_schema = _parameter_schema()
+        param_item_schema = _parameter_schema(profile.openapi_version)
 
     param_names_schema: dict = {
         "type": "object",
         "additionalProperties": param_item_schema,
     }
-    if profile and profile.parameter_name_pattern:
+    if coll.parameter_names:
+        param_names_schema["properties"] = {
+            name: param_item_schema for name in coll.parameter_names.root
+        }
+    if version == "3.1.0" and profile and profile.parameter_name_pattern:
         param_names_schema["propertyNames"] = {
             "type": "string",
             "pattern": profile.parameter_name_pattern,
@@ -614,7 +633,7 @@ def _collection_response_schema(coll: Collection,
                                 "type": "array",
                                 "items": {
                                     "type": "array",
-                                    "items": {
+                                    "items": {"type": "string", "format": "date-time", "nullable": True} if version == "3.0.0" else {
                                         "oneOf": [
                                             {"type": "string", "format": "date-time"},
                                             {"type": "null"},
@@ -734,13 +753,13 @@ def _collection_response_schema(coll: Collection,
     }
 
 
-def _parameter_schema() -> dict:
+def _parameter_schema(version: str) -> dict:
     """OpenAPI schema for a single EDR Parameter object."""
     return {
         "type": "object",
         "required": ["type", "observedProperty"],
         "properties": {
-            "type": {"type": "string", "const": "Parameter"},
+            "type": {"type": "string", **_const("Parameter", version)},
             "id": {"type": "string"},
             "label": {"type": "string"},
             "description": {"type": "string"},
@@ -930,7 +949,7 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
         "tags": [tag],
         "parameters": items_params,
         "responses": {
-            "200": _R200_FEATURES,
+            "200": _features_schema(profile.openapi_version if profile else "3.0.0"),
             "400": _ERR_400, "404": _ERR_404, "500": _ERR_500,
         },
     }}
@@ -944,7 +963,7 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
             _F, _LANG,
         ],
         "responses": {
-            "200": _R200_FEATURES,
+            "200": _features_schema(profile.openapi_version if profile else "3.0.0"),
             "400": _ERR_400, "404": _ERR_404, "500": _ERR_500,
         },
     }}
@@ -970,7 +989,7 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
                 "tags": [tag],
                 "parameters": [_F],
                 "responses": {
-                    "200": _R200_FEATURES,
+                    "200": _features_schema(profile.openapi_version if profile else "3.0.0"),
                     "400": _ERR_400, "500": _ERR_500,
                 },
             }}
@@ -988,7 +1007,7 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
                 "operationId": _operation_id("getInstance", coll.id),
                 "tags": [tag],
                 "parameters": [instance_id_param, _F],
-                "responses": {"200": _R200_FEATURES},
+                "responses": {"200": _features_schema(profile.openapi_version if profile else "3.0.0")},
             }}
             # instance-level query sub-paths — GET + optional POST
             for sub_qt in (active - {"instances"}):
@@ -1076,8 +1095,9 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
 
 
 def _core_paths(profile: ServiceProfile) -> dict:
+    version = profile.openapi_version
     landing_response = _landing_page_schema(
-        profile.req_uri,
+        profile.req_uri, version,
         title=profile.title,
         description=profile.description or "",
         keywords=profile.keywords or None,
@@ -1086,9 +1106,15 @@ def _core_paths(profile: ServiceProfile) -> dict:
     # Conformance response with required conformance classes
     conformance_response = _R200_CONFORMANCE.copy()
     if profile.required_conformance_classes:
-        conformance_response["content"]["application/json"]["schema"]["properties"]["conformsTo"]["contains"] = {
-            "enum": profile.required_conformance_classes
-        }
+        if version == "3.1.0":
+            conformance_response["content"]["application/json"]["schema"]["properties"]["conformsTo"]["contains"] = {
+                "enum": profile.required_conformance_classes
+            }
+        else:
+            conformance_response["content"]["application/json"]["schema"]["properties"]["conformsTo"]["items"] = {
+                "type": "string",
+                "enum": profile.required_conformance_classes
+            }
     
     return {
         "/": {"get": {
@@ -1305,7 +1331,7 @@ def build_openapi(profile: ServiceProfile) -> dict:
         info["x-default-locale"] = profile.resource_default_locale
 
     return {
-        "openapi": "3.1.0",
+        "openapi": profile.openapi_version,
         "info": info,
         # Per OGC API - EDR Part 3 REQ_publishing: this profile is implementation-independent.
         # The placeholder server URL "/" is required by OpenAPI validators but implementations
@@ -1348,6 +1374,7 @@ def build_openapi(profile: ServiceProfile) -> dict:
 # ---------------------------------------------------------------------------
 
 def build_asyncapi(profile: ServiceProfile) -> dict:
+    version = profile.openapi_version
     if not profile.pubsub:
         raise ValueError("profile has no pubsub configuration")
 
@@ -1392,7 +1419,7 @@ def build_asyncapi(profile: ServiceProfile) -> dict:
                 "type": "object",
                 "required": ["type", "properties"],
                 "properties": {
-                    "type": {"type": "string", "const": "Feature"},
+                    "type": {"type": "string", **_const("Feature", version)},
                     "properties": {
                         "type": "object",
                         "required": ["id", "timestamp"],
@@ -1498,7 +1525,7 @@ def _individual_test_adoc(profile: ServiceProfile, test_id: str) -> str:
         f"identifier:: /conf/{profile.name}/{test.id}",
         f"target:: /req/{profile.name}/{test.requirement_id}",
         f"test-purpose:: Validate that {test.id.replace('-', ' ')} is correctly implemented.",
-        "test-method::",
+        f"test-method:: {test.method or ''}",
     ]
     for step in test.steps:
         lines.append(f"step:: {step}")
@@ -1601,7 +1628,7 @@ def _individual_test_adoc_for(profile: ServiceProfile, cls: str, test) -> str:
         f"identifier:: /conf/{cls}/{test.id}",
         f"target:: /req/{cls}/{test.requirement_id}",
         f"test-purpose:: Validate that {test.id.replace('-', ' ')} is correctly implemented.",
-        "test-method::",
+        f"test-method:: {test.method or ''}",
     ]
     for step in test.steps:
         lines.append(f"step:: {step}")

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3}/src/oapi_profile_builder/models.py

@@ -261,6 +261,7 @@ class AbstractTest(BaseModel):
     id: str  # mirrors the requirement id it tests
     requirement_id: str
     steps: list[str] = Field(min_length=1)
+    method: str | None = Field(default=None, description="Optional test method description")
 
     @model_validator(mode="after")
     def ids_must_match(self) -> AbstractTest:
@@ -848,6 +849,10 @@ class ServiceProfile(BaseModel):
     name: Annotated[str, Field(pattern=r"^[a-z0-9_]+$")]
     title: str
     version: str = "1.0"
+    openapi_version: Literal["3.0.0", "3.1.0"] = Field(
+        default="3.0.0",
+        description="OpenAPI version to generate (3.0.0 for compatibility, 3.1.0 for latest features)"
+    )
     description: str | None = Field(
         default=None,
         description=(

{oapi_profile_builder-3.6.1 → oapi_profile_builder-3.6.3/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.6.1
+Version: 3.6.3
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -47,7 +47,7 @@ Dynamic: license-file
 
 # OGC API Service Profile Builder
 
-Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
+Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — OpenAPI 3.0.0/3.1.0, AsyncAPI, AsciiDoc requirements and conformance tests, and a publication-ready Metanorma PDF with optional custom (e.g. DGIWG) branding.
 
 [![PyPI](https://img.shields.io/pypi/v/oapi-profile-builder)](https://pypi.org/project/oapi-profile-builder/)
 [![License](https://img.shields.io/badge/license-Apache-blue)](LICENSE)
@@ -57,7 +57,9 @@ Generate OGC API - EDR Part 3 Service Profile artifacts from a YAML config — O
 ## Quick Start
 
 ```bash
-pip install oapi-profile-builder
+# Base install. Adds Pillow (cover image generation) with the [pdf] extra —
+# required whenever your profile sets document_metadata.cover.logo.
+pip install 'oapi-profile-builder[pdf]'
 
 # Copy an example config and edit it
 cp examples/minimal_profile.yaml my_profile.yaml
@@ -70,7 +72,7 @@ That's it. The `output/` directory will contain:
 
 ```
 output/
-├── openapi.yaml          # OpenAPI 3.1.0 — ready for Swagger UI, Redoc, schemathesis
+├── openapi.yaml          # OpenAPI 3.0.0 or 3.1.0 — ready for Swagger UI, Redoc, schemathesis
 ├── profile_config.json   # Round-trip serialized profile
 ├── document.adoc         # Metanorma root document
 ├── sections/             # Abstract, Preface, Scope, Conformance, References, Terms
@@ -186,8 +188,18 @@ OGC API - EDR CITE Results
 Anyone with a GitHub account can generate artifacts from their own config without cloning or installing anything:
 
 1. Open a new issue using the **"Generate profile artifacts"** template ([New issue](../../issues/new/choose)).
-2. Paste your profile YAML into the config field and submit.
-3. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days). Optionally tick "Compile a PDF?" to also get a Metanorma PDF.
+2. Paste your profile YAML into the config field.
+3. If your profile references local files (typically a cover logo via `document_metadata.cover.logo`), drag-and-drop them into the **"Additional assets (optional)"** field. Reference each uploaded file in your YAML as `uploads/<original-filename>` — for example:
+
+    ```yaml
+    document_metadata:
+      cover:
+        logo: uploads/my_logo.png
+    ```
+
+    The workflow downloads each dropped file into `./uploads/` before generation. It parses your YAML to figure out the target filename, so images that GitHub renders as an `<img>` tag with a UUID URL still land at the exact path your config references. Tip: to skip the upload entirely for the DGIWG logo, point at the copy that already ships in this repo: `logo: examples/assets/DGIWG_logo.png`.
+4. Tick "Compile a PDF?" if you also want a Metanorma PDF, then submit.
+5. A workflow validates the config, generates the artifacts, and comments on the issue with a link to download them as a zip (retained for 14 days).
 
 The workflow only runs the generator over your declarative config — it never executes user-supplied code — and comments back on both success and failure. Don't paste secrets: the artifacts are attached to a public workflow run.
 
@@ -366,6 +378,7 @@ abstract_tests: []
 | `processes` | list | no | OGC API Processes to expose in the OpenAPI |
 | `requirements` | list | no | Normative requirements for the AsciiDoc/PDF |
 | `abstract_tests` | list | no | Conformance tests — each must reference a valid requirement `id` |
+| `abstract_tests[].method` | string | no | Optional test method description |
 | `pubsub` | object | no | OGC API - EDR Part 2 PubSub config — generates `asyncapi.yaml` |
 | `collection_examples` | object | no | `{collectionId: {instanceId: "..."}}` — used by `validate-server` |
 | `paging` | object | no | Features `/items` paging — adds a validated `limit` query parameter to the generated OpenAPI (see below) |
@@ -660,6 +673,7 @@ requirements:
 abstract_tests:
   - id: position-coveragejson          # must equal requirement_id
     requirement_id: position-coveragejson
+    method: Manual inspection of the /position response.
     steps:
       - Send GET /collections/{id}/position?coords=POINT(lon lat).
       - Verify Content-Type is application/prs.coverage+json.
@@ -812,7 +826,9 @@ Two `document_metadata` blocks let you rebrand the PDF (e.g. for DGIWG) without
 document_metadata:
   doc_number: "DGIWG 134"
   cover:
-    logo: assets/dgiwg_logo.png    # path relative to the working directory (or absolute)
+    logo: examples/assets/DGIWG_logo.png    # path relative to the working directory (or absolute).
+                                            # From the self-service issue form use uploads/<file>
+                                            # instead and drag-drop the file into "Additional assets".
     tagline: Delivering Military Advantage through multi-national geospatial interoperability
     background: "#FFFFFF"          # optional cover background (default white)
     text_color: "#1F3864"          # optional cover text colour (default black)