rails_routes_to_openapi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f635db74e81f21519eb968fa4de1e487b1f146f871441537c0b417998835eeb8
-  data.tar.gz: c8a396566e35bbb28ed024070718b44cc1f05da0c187252ee05c21d34dfb7022
+  metadata.gz: 4563b8b80ce8a8552e65f69921ba983f1b1d37ae7ab79f99fbe698c098b966dc
+  data.tar.gz: e41335c9d4337ce20117a17191c2da5b0aaae15527ed26992c1ffcc02e2f01fc
 SHA512:
-  metadata.gz: ccb4397122144ad2a59518f92f125cae291ee52f89a3fbcfbf6a1f45dd64e845719eba47ac612275b6749e1997145b0904fc2c1798652129e8bc8fe523dcc329
-  data.tar.gz: f4170add03708b44d2877e2cbc9e2ef8dfc52518e9a37b1b80b0f094fb1c44b8799920789ba7f0e35e2065b0356588db52945f6caab5ca20e66de0e836ad00d2
+  metadata.gz: 9ec8476c18ec6b77fdd400615fdc5903e8714cab4e9bcdd4ed53b54cbb12d015ba9856fcdf137d1780a0b7134fbd0f0c88c0e3381ee45fc73127df95211bf41c
+  data.tar.gz: 5131e6b31ba09cd5623972159b24c134b3c97716f90e77ce069750eac0671946c8a1724acd09ca92e8fa6f138c4a04874ca845c0b5f522ffe87de8d732f2dd7b

data/README.md

@@ -1,6 +1,6 @@
-# Converting a Rails Routes Output into a Postman Collection
+# Converting Rails Routes Output into OpenAPI v3.1
 
-In an effort to learn a little bit about Ruby and Rails, I decided a fun project would be to attempt generating a YAML file that aligns with the OpenAPI v3.1.0 specification. This file can then be imported into Postman so you can test Rails routes without manually using the Rails console or the consuming frontend application.
+In an effort to learn a little bit about Ruby and Rails, I decided a fun project would be to attempt generating a YAML file that aligns with the [OpenAPI v3.1.0 specification](https://spec.openapis.org/oas/v3.1.1.html). This file can then be imported into [Postman](https://www.postman.com/) so you can test Rails routes without manually using the Rails console or the consuming frontend application.
 
 ## Quick Start
 
@@ -24,7 +24,8 @@ bundle exec rake routes_to_openapi:convert
 
 This task will internally run `rails routes` on your Rails application and generate an OpenAPI YAML file named similar to `openapi_v3.1_YYYYMMDDHHMMSS.yml` in the project root.
 
-> [!WARNING] > **Tip:** Ensure you run the task within a Rails project context so that it can properly pull the routes.
+> [!WARNING]
+> **Tip:** Ensure you run the task within a Rails project context so that it can properly pull the routes.
 
 ## Workflow Overview
 
@@ -53,7 +54,7 @@ Below is an abbreviated snippet of what the output might look like:
 openapi: 3.1.0
 info:
   title: Rails Routes to OpenAPI
-  description: Generate an OpenAPI v3.1 YAML file for Postman import
+  description: Generate an OpenAPI v3.1 YAML file
   version: "1.1.0"
 servers:
   - url: "https://api.example.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_routes_to_openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Camel Chang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-23 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem to convert Rails routes to OpenAPI YAML for Postman import
+description: A gem to convert Rails routes to OpenAPI v3.1 YAML
 email:
 - a556622821@gmail.com
 executables: []