openapi_kit 0.1.0.pre.2 → 0.1.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d304ba17a6fa760d97ee15f5755e8986723bb44761bb4508413d84da2c45925
-  data.tar.gz: e428d43ce8dce01bbb48f9929b0173de72b2bd2789e5e1df8dfaf402b1a17a8a
+  metadata.gz: 613a75911e2ca7e79f0eaf2efaf73e8fb5010b80ee1198e80fb7e2d364015d11
+  data.tar.gz: 2ecbfb34c60742a6b98e3c1cd29cf235f8a8bacd0ae8d647d952dc4ddce60ac8
 SHA512:
-  metadata.gz: 4d24fd4aa84db299e0eeaab6869c51305243e35c3d682824cdb72d4c80777f6125f6165a259ecfb290c61fa2de6d703c3e84b7b81b2871d2ef1d70e61221bc76
-  data.tar.gz: e24da0aa1ce7b436160f00da9f407c506a0ee1f391e53d3d0408a12db7dba42ec6672ed3a9b2f930fc0142c780ec937bda156efa359e3d4daaad8662fe355dbd
+  metadata.gz: b50ef496efb12a30f02420d7c7f0624b34fb4bcae6ccb84883fb34fa69cb0cb7c033c23da45189458b432dcefa30f946172497dfa24e257f4f52ce33132b1efa
+  data.tar.gz: ce716d3ace4b5710b3ff8eb8be23b7dc42387208649b2fd398ef1bda64c328405e6acc32cbf5450761f539ba4df779915694d15402447ac6cd6c5eda19112063

data/README.md

@@ -28,7 +28,7 @@ end
 ```yaml
 # openapi_kit.yml
 spec: openapi/petstore.yaml
-output: app/api
+output: app/api/petstore/v1
 modules: [Petstore, V1]
 controller_base: Api::BaseController
 principal: "::Petstore::Principal"
@@ -37,8 +37,8 @@ principal: "::Petstore::Principal"
 | Option | Meaning |
 | --- | --- |
 | `spec` | root OpenAPI document, resolved relative to this file |
-| `output` | directory the tree is written to, which openapi_kit owns |
-| `modules` | namespace for every generated constant, so `Petstore::V1::Types::Pet` |
+| `output` | directory the tree is written into, which openapi_kit owns |
+| `modules` | namespace every generated constant is declared in, so `Petstore::V1::Types::Pet` |
 | `controller_base` | class the generated controllers inherit from |
 | `principal` | the class a successful authentication produces |
 | `type_mappings` | your Ruby type for a `type:format` pair |
@@ -57,13 +57,16 @@ app/api/petstore/v1/registry.rb
 app/api/petstore/v1/routes.rb
 ```
 
-One constant per file at the path that constant implies, so Rails autoloads it. Each run
-wipes `output`, but only after checking openapi_kit generated every `.rb` in it.
+Nothing is written outside `output`, and `modules` decides only what the files declare. One
+constant per file at the path that constant implies, counting from `output`, so laying the
+directory out to match the namespace is what lets Rails autoload it. Each run wipes
+`output`, but only after checking openapi_kit generated every `.rb` in it.
 
 ## Integrating with Rails
 
-**Autoload the output**, if it is not already under `app/`. An acronym in `modules`
-becomes a directory, so it needs an inflection like any other acronym constant.
+**Autoload the tree**, if it is not already under `app/`. The root is the directory
+`modules` counts from, not `output` itself. An acronym in `modules` is a directory like any
+other, so it needs an inflection.
 
 ```ruby
 # config/application.rb
@@ -125,15 +128,15 @@ module Api
 end
 ```
 
-**Assign the registry.** openapi_kit generates a `Registry` struct with one slot per handler and
-authenticator, and controllers read it from `Petstore::V1.registry`. Rails instantiates
-controllers itself, so they cannot be handed one. Omit a slot, or pass something that does
-not implement its interface, and it does not compile.
+**Assign the registry.** openapi_kit generates a `Registry` struct with one slot per handler
+and authenticator, and controllers read the one you assigned. Rails instantiates controllers
+itself, so they cannot be handed one. Omit a slot, or pass something that does not
+implement its interface, and it does not compile.
 
 ```ruby
 # config/initializers/openapi_kit.rb
 Rails.application.config.to_prepare do
-  Petstore::V1.registry = Petstore::V1::Registry.new(
+  Petstore::V1::Registry.instance = Petstore::V1::Registry.new(
     pets: PetsHandler.new(repo: PetRepo.new),
     system: SystemHandler.new,
     bearer_auth: BearerAuthenticator.new(decoder: TokenDecoder.new)

data/lib/openapi_kit/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module OpenAPIKit
-  VERSION = "0.1.0.pre.2"
+  VERSION = "0.1.0.pre.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.2
+  version: 0.1.0.pre.3
 platform: ruby
 authors:
 - Jack Robertson