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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.4.1
+Version: 3.6.1
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License
@@ -181,6 +181,20 @@ OGC API - EDR CITE Results
 
 ## GitHub Actions
 
+### Self-service: generate artifacts from an issue (no fork, no install)
+
+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.
+
+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.
+
+> Maintainers: create a `profile-request` label so requests are easy to filter (the workflow gates on a marker in the issue body, so it works even before the label exists).
+
+### Use the action in your own workflow
+
 No local install needed. Add this to any workflow to generate profile artifacts from a config file:
 
 ```yaml
@@ -239,7 +253,7 @@ Everything about the document — cover, title-page metadata, legal page, footer
 | PDF colours (titles, tables, cover, backgrounds) | `document_metadata.colors` | `:presentation-metadata-color-*:` |
 | Page-ii legal text (copyright / license / notice) | `document_metadata.boilerplate` | `:boilerplate-authority:` |
 | Footer organisation name | `document_metadata.copyright_holder` | `:copyright-holder:` |
-| Cover layout (logo size/position, tagline/title size, bold edition) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, bold_edition}` | Generated cover image |
+| Cover layout (logo size/position, tagline/title/edition-date size, bold edition+date) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, edition_date_font_size, bold_edition}` | Generated cover image |
 | Cover date | `document_metadata.doc_pub_date` | Long-format date on the generated cover + `:published-date:` |
 | Remove the OGC logo from the legal page | `document_metadata.suppress_flavor_logo` | targeted `:pdf-stylesheet-override:` |
 | Remove OGC design (crossing lines, circled numbers, rules, navy divider pages) | `document_metadata.suppress_design_elements` (or the individual `suppress_crossing_lines` / `plain_section_numbers` / `suppress_title_underlines`) | `:pdf-stylesheet-override:` + colour attributes |
@@ -342,6 +356,13 @@ abstract_tests: []
 | `spec_uri_base` | string | no | Base URI for the requirements/conformance class identifiers. Defaults to the OGC EDR Part 3 namespace; override to publish under another SDO namespace (e.g. DGIWG) |
 | `parameter_name_pattern` | string | no | Regex all `parameter_names` keys must match |
 | `parameter_schema` | object | no | JSON Schema for parameter objects — replaces the default schema in the generated OpenAPI (see below) |
+| `collection_title_max_length` | int | no | When set, every collection title must be present and within this many characters (MetOcean `/req/core/collection_title`) |
+| `require_license_link` | bool | no | When `true`, every collection must declare a `rel='license'` link (MetOcean `/req/core/collection_license`). Defaults to `false` |
+| `license_link_type` | string | no | Expected media type of the `rel='license'` link when `require_license_link` is set. Defaults to `text/html`; set to null to accept any type |
+| `required_data_queries` | list | no | Data-query types every collection must define (e.g. `[locations, area, radius]`) — enforces the mandatory data-query sets |
+| `radius_within_units_required` | list | no | Unit tokens each radius query's `within_units` must contain (e.g. `[m]`) (MetOcean `/req/core/collection_radius_data_query`) |
+| `locations_feature_required_properties` | list | no | Feature properties (e.g. `[name]`) marked required in the generated `/locations` GeoJSON response schema, in addition to the always-required string `id` |
+| `conformance_class_requirements` | object | no | Map of conformance-class short name → constraints (`required_data_queries`, `radius_within_units_required`) applied only to collections that declare the class. Lets one profile document model several EDR Part 3 requirements classes (see below) |
 | `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` |
@@ -381,6 +402,8 @@ Uses the [edr-pydantic](https://github.com/KNMI/edr-pydantic) `Collection` model
 | `output_formats` | no | Format names this collection supports (e.g. `[CoverageJSON, GeoJSON]`) |
 | `data_queries` | no | EDR query types: `position`, `area`, `radius`, `cube`, `trajectory`, `corridor`, `locations`, `items`, `instances` |
 | `parameter_names` | no | Map of parameter id → Parameter object. All parameters must have `unit` and `observedProperty` |
+| `conformance_classes` | no | Profile conformance-class short names this collection implements (e.g. `[core, insitu-observations]`). Selects which `conformance_class_requirements` are enforced; surfaced as `x-conformance-classes` in the OpenAPI |
+| `parameter_schema` | no | Per-collection JSON Schema for parameter objects, overriding the profile-level `parameter_schema` for this collection only (precedence: collection → profile → default) |
 
 #### `data_queries` example
 
@@ -513,6 +536,38 @@ extent_requirements:
 
 ---
 
+### Multiple conformance classes in one profile
+
+OGC API - EDR Part 3 profiles are modular: a single profile document can define several requirements/conformance classes, and different collections in the same service may implement different classes. The MetOcean EDR Profile is a good example — Core applies everywhere, but only in-situ collections must offer `locations`/`area`/`radius` while NWP collections must offer `position`/`cube`.
+
+Model this with `conformance_class_requirements` (profile level) plus `conformance_classes` (per collection):
+
+```yaml
+# Core-level rules apply to every collection:
+collection_title_max_length: 50
+require_license_link: true
+
+# Class-scoped rules apply only where a collection opts in:
+conformance_class_requirements:
+  insitu-observations:
+    required_data_queries: [locations, area, radius]
+    radius_within_units_required: [m]
+  nwp:
+    required_data_queries: [position, cube]
+
+collections:
+  - id: insitu-observations
+    conformance_classes: [core, insitu-observations]   # must have locations/area/radius
+    # ...
+  - id: nwp-forecast
+    conformance_classes: [core, nwp]                    # must have position/cube
+    # ...
+```
+
+The flat `required_data_queries` / `radius_within_units_required` fields still apply to *every* collection (the Core-applies-to-all shorthand); class-scoped rules are additive. See `examples/metocean_profile.yaml` for a full worked profile spanning all four MetOcean classes.
+
+---
+
 ### `output_formats`
 
 Maps format names (referenced by `collections[].output_formats` and `data_queries.*.variables.output_formats`) to a media type and, optionally, a schema reference. The `schema_ref` flows into the generated OpenAPI response `content` for that format — use it to point a format at a specific schema (e.g. a DGIWG-published schema for GeoTIFF or CoverageJSON) instead of the tool's built-in default.
@@ -654,7 +709,7 @@ When present, generates `asyncapi.yaml` alongside `openapi.yaml`.
 pubsub:
   broker_host: my-broker.example.com
   broker_port: 5672
-  protocol: amqp          # amqp | mqtt | kafka
+  protocol: amqp          # amqp | amqp1 | mqtt | kafka
   collections:
     - my_collection
   filters:
@@ -663,6 +718,40 @@ pubsub:
       type: string
 ```
 
+`broker_host`/`broker_port`/`protocol` synthesise a single implicit
+`production` AsyncAPI server. To describe an exact transport topology instead —
+e.g. a native WebSocket `/ws` endpoint plus AMQP 1.0 and MQTT brokers, as the
+`nws_connect_profile.yaml` example does — list them explicitly under `servers`.
+When `servers` is set, the implicit `production` server is **not** emitted:
+
+```yaml
+pubsub:
+  broker_host: edr-broker
+  broker_port: 5672
+  protocol: amqp1         # AMQP 1.0 (e.g. RabbitMQ 4.x native)
+  collections: [water_gauge, wwa]
+  servers:
+    - name: websocket_secure
+      description: Native WebSocket live map (production)
+      host: ''
+      protocol: wss       # amqp | amqp1 | mqtt | kafka | ws | wss
+      pathname: /ws
+    - name: amqp
+      description: AMQP 1.0 broker (RabbitMQ 4.x native AMQP 1.0)
+      host: 'edr-broker:5672'
+      protocol: amqp1
+    - name: mqtt
+      description: MQTT broker (RabbitMQ MQTT plugin)
+      host: 'edr-broker:1883'
+      protocol: mqtt
+  collection_filters:     # per-collection filter overrides
+    water_gauge:
+      filters:
+        - name: flood_stages
+          description: Alert for selected flood stages
+          type: array
+```
+
 ---
 
 ### `document_metadata`
@@ -732,11 +821,12 @@ document_metadata:
     font_italic: "Source Sans Pro"  # optional italic face for the tagline
     watermark: "DRAFT"             # optional diagonal watermark stamped on the cover
     # --- cover layout (all optional) ---
-    logo_width: 200                # target logo width in px (default 420)
+    logo_width: 300                # target logo width in px (default 420)
     logo_y: 100                    # logo vertical offset from top in px (default 180)
     tagline_font_size: 20          # tagline point size (default 30)
     title_font_size: 40            # title point size (default 54)
-    bold_edition: true             # render the "Edition X" line in bold (default false)
+    edition_date_font_size: 22     # edition/date point size (default 24)
+    bold_edition: true             # render the "Edition X" and "Dated ..." lines in bold (default false)
   colors:
     text: "#000000"                # body text
     cover_text: "#1F3864"          # cover text / section numbers / ToC
@@ -898,6 +988,12 @@ The tool enforces these rules at build time. Violations produce clear error mess
 | Parameters need `unit` + `observedProperty` | Required by OGC API - EDR Part 3 |
 | `parameter_name_pattern` enforced | All `parameter_names` keys must match if set |
 | `collection_id_pattern` enforced | All collection IDs must match if set |
+| `collection_title_max_length` enforced | If set, every collection title must be present and within the limit |
+| `require_license_link` enforced | If set, every collection must have a `rel='license'` link (of `license_link_type` when specified) |
+| `required_data_queries` enforced | If set, every collection with `data_queries` must define each listed query type |
+| `radius_within_units_required` enforced | If set, each radius query's `within_units` must contain every listed unit token |
+| `conformance_class_requirements` enforced | Class-scoped `required_data_queries` / `radius_within_units_required` applied to collections whose `conformance_classes` include the class key |
+| `conformance_classes` references known class | When `conformance_class_requirements` is set, a collection's `conformance_classes` may only use `core` or a defined class key (catches typos) |
 | Abstract test IDs match requirements | `requirement_id` must reference an existing requirement |
 | Requirement IDs | Must match `^[a-z0-9][a-z0-9\-]*$`, no trailing hyphen |
 

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

@@ -134,6 +134,20 @@ OGC API - EDR CITE Results
 
 ## GitHub Actions
 
+### Self-service: generate artifacts from an issue (no fork, no install)
+
+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.
+
+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.
+
+> Maintainers: create a `profile-request` label so requests are easy to filter (the workflow gates on a marker in the issue body, so it works even before the label exists).
+
+### Use the action in your own workflow
+
 No local install needed. Add this to any workflow to generate profile artifacts from a config file:
 
 ```yaml
@@ -192,7 +206,7 @@ Everything about the document — cover, title-page metadata, legal page, footer
 | PDF colours (titles, tables, cover, backgrounds) | `document_metadata.colors` | `:presentation-metadata-color-*:` |
 | Page-ii legal text (copyright / license / notice) | `document_metadata.boilerplate` | `:boilerplate-authority:` |
 | Footer organisation name | `document_metadata.copyright_holder` | `:copyright-holder:` |
-| Cover layout (logo size/position, tagline/title size, bold edition) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, bold_edition}` | Generated cover image |
+| Cover layout (logo size/position, tagline/title/edition-date size, bold edition+date) | `document_metadata.cover.{logo_width, logo_y, tagline_font_size, title_font_size, edition_date_font_size, bold_edition}` | Generated cover image |
 | Cover date | `document_metadata.doc_pub_date` | Long-format date on the generated cover + `:published-date:` |
 | Remove the OGC logo from the legal page | `document_metadata.suppress_flavor_logo` | targeted `:pdf-stylesheet-override:` |
 | Remove OGC design (crossing lines, circled numbers, rules, navy divider pages) | `document_metadata.suppress_design_elements` (or the individual `suppress_crossing_lines` / `plain_section_numbers` / `suppress_title_underlines`) | `:pdf-stylesheet-override:` + colour attributes |
@@ -295,6 +309,13 @@ abstract_tests: []
 | `spec_uri_base` | string | no | Base URI for the requirements/conformance class identifiers. Defaults to the OGC EDR Part 3 namespace; override to publish under another SDO namespace (e.g. DGIWG) |
 | `parameter_name_pattern` | string | no | Regex all `parameter_names` keys must match |
 | `parameter_schema` | object | no | JSON Schema for parameter objects — replaces the default schema in the generated OpenAPI (see below) |
+| `collection_title_max_length` | int | no | When set, every collection title must be present and within this many characters (MetOcean `/req/core/collection_title`) |
+| `require_license_link` | bool | no | When `true`, every collection must declare a `rel='license'` link (MetOcean `/req/core/collection_license`). Defaults to `false` |
+| `license_link_type` | string | no | Expected media type of the `rel='license'` link when `require_license_link` is set. Defaults to `text/html`; set to null to accept any type |
+| `required_data_queries` | list | no | Data-query types every collection must define (e.g. `[locations, area, radius]`) — enforces the mandatory data-query sets |
+| `radius_within_units_required` | list | no | Unit tokens each radius query's `within_units` must contain (e.g. `[m]`) (MetOcean `/req/core/collection_radius_data_query`) |
+| `locations_feature_required_properties` | list | no | Feature properties (e.g. `[name]`) marked required in the generated `/locations` GeoJSON response schema, in addition to the always-required string `id` |
+| `conformance_class_requirements` | object | no | Map of conformance-class short name → constraints (`required_data_queries`, `radius_within_units_required`) applied only to collections that declare the class. Lets one profile document model several EDR Part 3 requirements classes (see below) |
 | `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` |
@@ -334,6 +355,8 @@ Uses the [edr-pydantic](https://github.com/KNMI/edr-pydantic) `Collection` model
 | `output_formats` | no | Format names this collection supports (e.g. `[CoverageJSON, GeoJSON]`) |
 | `data_queries` | no | EDR query types: `position`, `area`, `radius`, `cube`, `trajectory`, `corridor`, `locations`, `items`, `instances` |
 | `parameter_names` | no | Map of parameter id → Parameter object. All parameters must have `unit` and `observedProperty` |
+| `conformance_classes` | no | Profile conformance-class short names this collection implements (e.g. `[core, insitu-observations]`). Selects which `conformance_class_requirements` are enforced; surfaced as `x-conformance-classes` in the OpenAPI |
+| `parameter_schema` | no | Per-collection JSON Schema for parameter objects, overriding the profile-level `parameter_schema` for this collection only (precedence: collection → profile → default) |
 
 #### `data_queries` example
 
@@ -466,6 +489,38 @@ extent_requirements:
 
 ---
 
+### Multiple conformance classes in one profile
+
+OGC API - EDR Part 3 profiles are modular: a single profile document can define several requirements/conformance classes, and different collections in the same service may implement different classes. The MetOcean EDR Profile is a good example — Core applies everywhere, but only in-situ collections must offer `locations`/`area`/`radius` while NWP collections must offer `position`/`cube`.
+
+Model this with `conformance_class_requirements` (profile level) plus `conformance_classes` (per collection):
+
+```yaml
+# Core-level rules apply to every collection:
+collection_title_max_length: 50
+require_license_link: true
+
+# Class-scoped rules apply only where a collection opts in:
+conformance_class_requirements:
+  insitu-observations:
+    required_data_queries: [locations, area, radius]
+    radius_within_units_required: [m]
+  nwp:
+    required_data_queries: [position, cube]
+
+collections:
+  - id: insitu-observations
+    conformance_classes: [core, insitu-observations]   # must have locations/area/radius
+    # ...
+  - id: nwp-forecast
+    conformance_classes: [core, nwp]                    # must have position/cube
+    # ...
+```
+
+The flat `required_data_queries` / `radius_within_units_required` fields still apply to *every* collection (the Core-applies-to-all shorthand); class-scoped rules are additive. See `examples/metocean_profile.yaml` for a full worked profile spanning all four MetOcean classes.
+
+---
+
 ### `output_formats`
 
 Maps format names (referenced by `collections[].output_formats` and `data_queries.*.variables.output_formats`) to a media type and, optionally, a schema reference. The `schema_ref` flows into the generated OpenAPI response `content` for that format — use it to point a format at a specific schema (e.g. a DGIWG-published schema for GeoTIFF or CoverageJSON) instead of the tool's built-in default.
@@ -607,7 +662,7 @@ When present, generates `asyncapi.yaml` alongside `openapi.yaml`.
 pubsub:
   broker_host: my-broker.example.com
   broker_port: 5672
-  protocol: amqp          # amqp | mqtt | kafka
+  protocol: amqp          # amqp | amqp1 | mqtt | kafka
   collections:
     - my_collection
   filters:
@@ -616,6 +671,40 @@ pubsub:
       type: string
 ```
 
+`broker_host`/`broker_port`/`protocol` synthesise a single implicit
+`production` AsyncAPI server. To describe an exact transport topology instead —
+e.g. a native WebSocket `/ws` endpoint plus AMQP 1.0 and MQTT brokers, as the
+`nws_connect_profile.yaml` example does — list them explicitly under `servers`.
+When `servers` is set, the implicit `production` server is **not** emitted:
+
+```yaml
+pubsub:
+  broker_host: edr-broker
+  broker_port: 5672
+  protocol: amqp1         # AMQP 1.0 (e.g. RabbitMQ 4.x native)
+  collections: [water_gauge, wwa]
+  servers:
+    - name: websocket_secure
+      description: Native WebSocket live map (production)
+      host: ''
+      protocol: wss       # amqp | amqp1 | mqtt | kafka | ws | wss
+      pathname: /ws
+    - name: amqp
+      description: AMQP 1.0 broker (RabbitMQ 4.x native AMQP 1.0)
+      host: 'edr-broker:5672'
+      protocol: amqp1
+    - name: mqtt
+      description: MQTT broker (RabbitMQ MQTT plugin)
+      host: 'edr-broker:1883'
+      protocol: mqtt
+  collection_filters:     # per-collection filter overrides
+    water_gauge:
+      filters:
+        - name: flood_stages
+          description: Alert for selected flood stages
+          type: array
+```
+
 ---
 
 ### `document_metadata`
@@ -685,11 +774,12 @@ document_metadata:
     font_italic: "Source Sans Pro"  # optional italic face for the tagline
     watermark: "DRAFT"             # optional diagonal watermark stamped on the cover
     # --- cover layout (all optional) ---
-    logo_width: 200                # target logo width in px (default 420)
+    logo_width: 300                # target logo width in px (default 420)
     logo_y: 100                    # logo vertical offset from top in px (default 180)
     tagline_font_size: 20          # tagline point size (default 30)
     title_font_size: 40            # title point size (default 54)
-    bold_edition: true             # render the "Edition X" line in bold (default false)
+    edition_date_font_size: 22     # edition/date point size (default 24)
+    bold_edition: true             # render the "Edition X" and "Dated ..." lines in bold (default false)
   colors:
     text: "#000000"                # body text
     cover_text: "#1F3864"          # cover text / section numbers / ToC
@@ -851,6 +941,12 @@ The tool enforces these rules at build time. Violations produce clear error mess
 | Parameters need `unit` + `observedProperty` | Required by OGC API - EDR Part 3 |
 | `parameter_name_pattern` enforced | All `parameter_names` keys must match if set |
 | `collection_id_pattern` enforced | All collection IDs must match if set |
+| `collection_title_max_length` enforced | If set, every collection title must be present and within the limit |
+| `require_license_link` enforced | If set, every collection must have a `rel='license'` link (of `license_link_type` when specified) |
+| `required_data_queries` enforced | If set, every collection with `data_queries` must define each listed query type |
+| `radius_within_units_required` enforced | If set, each radius query's `within_units` must contain every listed unit token |
+| `conformance_class_requirements` enforced | Class-scoped `required_data_queries` / `radius_within_units_required` applied to collections whose `conformance_classes` include the class key |
+| `conformance_classes` references known class | When `conformance_class_requirements` is set, a collection's `conformance_classes` may only use `core` or a defined class key (catches typos) |
 | Abstract test IDs match requirements | `requirement_id` must reference an existing requirement |
 | Requirement IDs | Must match `^[a-z0-9][a-z0-9\-]*$`, no trailing hyphen |
 

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

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

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

@@ -197,17 +197,20 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
     if m and m.doc_number:
         y = centered(m.doc_number, fonts.regular_font(46, bold=True), y, fg) + 40
 
-    # --- Edition ---
+    # --- Edition & date ---
+    # Per DGIWG feedback these two lines are both bold and set a little smaller
+    # than the document number so they read as a compact sub-heading.
+    ed_date_fs = getattr(cover, "edition_date_font_size", 24)
+    bold_ed = bool(getattr(cover, "bold_edition", False))
+
     edition = getattr(profile, "version", None)
     if edition:
-        bold_ed = bool(getattr(cover, "bold_edition", False))
-        y = centered(f"Edition {edition}", fonts.regular_font(28, bold=bold_ed), y, fg) + 24
+        y = centered(f"Edition {edition}", fonts.regular_font(ed_date_fs, bold=bold_ed), y, fg) + 20
 
-    # --- Date ---
     pub_date = (m.doc_pub_date or m.publication_date) if m else None
     date_str = _format_date(pub_date)
     if date_str:
-        y = centered(f"Dated {date_str}", fonts.regular_font(28), y, fg) + 80
+        y = centered(f"Dated {date_str}", fonts.regular_font(ed_date_fs, bold=bold_ed), y, fg) + 80
 
     # --- Title (large, bold, wrapped) ---
     title = getattr(profile, "title", "") or ""