metanorma-plugin-openapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e24aac3a9834450d38c598a2fb5fe97f7fb9c72360dd15ccdf9a53e8659cb511
-  data.tar.gz: 3604d75b940bf467aa2c12dd985a5b075528c7a512e36983b97ebe9643adebd4
+  metadata.gz: 42d3ee8a020d3ea33aaf1259d38beee0578edc6eb0cbd3e15adfd1c6e8bfb3ee
+  data.tar.gz: f9803b8deb664d9c183df067aa7dd4853709ef8c561b8ba9551a659637681b7c
 SHA512:
-  metadata.gz: e76a0c1ed23c61b5b6f1e08776392c049adaa8f579eca12d588c9d5bbe4659b2281fec42fd47f4b4937700d58531cd5d2411629e152ff5024f0c71da0d610f47
-  data.tar.gz: 84fc464660f03dd22ecd87cfbf80cf88de6863caf4c543d651a13985247609df0a21a49bb4e40ec268df5aa11d3e92d96d4e47db3a5adfc7cbe5484320aa6fd5
+  metadata.gz: 21c95c754c239c753cc1bca268fe1c6ef234aa86ee5a85f6d7e32bdcc81974f2bda9db9b071f22d46dc129d68264f7f0417db8df3cb626ac0dcbf63638e8977f
+  data.tar.gz: 5fbe6ab4c1806c7818081e53b3a64c49f2a670bd8435339a55f34f5beea9fe71c6bbab4d676b3de9b56003ea5b628215dc73b7232860ad1e420925100e1a77cc

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## [0.1.1] - 2026-10-26
+
+### Fixed
+
+- The coradoc monorepo is an optional enhancement: soft-require it and pass CommonMark descriptions through with only the link bridge when absent (metanorma-plugin-lutaml pins coradoc ~> 1.1.8, excluding the 2.0 hub from metanorma-cli bundles).
+- Resolve `Lutaml::Openapi` against the top level — metanorma-plugin-lutaml's namespace lexically shadowed the lookup, crashing every metanorma-cli bundle.
+
+### Changed
+
+- Splice rendered sections through an Asciidoctor **preprocessor** instead of a block: the preprocessor is the only mechanism that yields real sections (numbering, TOC); the renderer's preface drops to `==` level.
+- Render operation **summaries** as well as descriptions (most corpora carry summary alone).
+
+## [0.1.0] - 2026-10-24
+
+### Added
+
+- First release: the `[openapi,path=...]` block, the AsyncAPI-style preprocessor splice and the section renderer over lutaml-openapi.

data/LICENSE.md

@@ -0,0 +1,33 @@
+Licenses & Copyright
+====================
+
+This license file adheres to the formatting guidelines of
+[readable-licenses](https://github.com/nevir/readable-licenses).
+
+
+Ribose's BSD 2-Clause License
+-----------------------------
+
+Copyright (c) 2026, [Ribose Inc](https://www.ribose.com).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,19 @@
+# metanorma-plugin-openapi
+
+Renders [OpenAPI](https://spec.openapis.org) documents as normative
+Metanorma sections — the `[openapi,path=...]` preprocessor and renderer
+over [lutaml-openapi](https://github.com/lutaml/lutaml-openapi).
+
+```adoc
+[openapi,path=openapi.yaml]
+--
+--
+```
+
+The splice runs as an Asciidoctor preprocessor, so the rendered
+schemas, operations and property tables become real numbered sections
+of the document (TOC and cross-references included).
+
+CommonMark descriptions are converted to AsciiDoc through the coradoc
+monorepo when present; otherwise they pass through with the inline
+link bridge applied.

data/lib/metanorma/plugin/openapi/renderer.rb

@@ -62,7 +62,32 @@ module Metanorma
             lines << to_asciidoc(desc) << ""
           end
           lines << "Type: `#{schema.type}`" << "" if schema.type
-          lines
+          lines.concat(property_table(schema, name))
+        end
+
+        def property_table(schema, name)
+          entries = schema.property_entries
+          return [] if entries.nil? || entries.empty?
+
+          rows = entries.sort_by(&:name).map { |entry| property_row(entry) }
+          [".Properties of #{name}",
+           "[cols=\"2,1,7\",options=\"header\"]",
+           "|===",
+           "|Name |Type |Description",
+           *rows,
+           "|===",
+           ""]
+        end
+
+        def property_row(entry)
+          schema = entry.schema
+          "|#{entry.name} |`#{schema&.type}` |#{cell(schema&.description)}"
+        end
+
+        # table cells take plain text: escape the cell delimiter and
+        # flatten the (CommonMark) description to one line
+        def cell(text)
+          (text || "").gsub("|", "\\|").gsub(/\s+/, " ").strip
         end
 
         def paths_section

data/lib/metanorma/plugin/openapi/version.rb

@@ -3,7 +3,7 @@
 module Metanorma
   module Plugin
     module Openapi
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ribose Inc.
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -60,9 +61,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE
+- LICENSE.md
 - README.adoc
+- README.md
 - Rakefile
 - examples/ogcapi-features-1.adoc
 - lib/metanorma/plugin/openapi.rb
@@ -74,6 +78,7 @@ licenses:
 - BSD-2-Clause
 metadata:
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,7 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Metanorma plugin for OpenAPI
 test_files: []