Checkpoint

Author: qwuide

docs/playground/lib/example_generator.rb

@@ -55,7 +55,7 @@ def swap_output(temp_public, temp_examples)
   end
 
   def generated_dirs
-    Apiwork::API.all.map do |api_class|
+    Apiwork::API.values.map do |api_class|
       api_class.path.delete_prefix('/').underscore.dasherize
     end
   end
@@ -76,7 +76,7 @@ def eager_load_schemas
   end
 
   def each_api
-    Apiwork::API.all.sort_by(&:path).each do |api_class|
+    Apiwork::API.values.sort_by(&:path).each do |api_class|
       namespace = api_class.path.delete_prefix('/').underscore
       metadata = metadata_for(namespace)
       yield api_class, namespace, metadata

docs/reference/adapter-render-state.md

@@ -29,7 +29,7 @@ end
 
 ```ruby
 def render_collection(collection, schema_class, state)
-  response = { data: collection.map { |r| serialize(r) } }
+  response = { data: collection.map { |record| serialize(record) } }
   response[:cache] = true if state.action.get?
   response
 end

docs/reference/contract-request.md

@@ -10,15 +10,15 @@ next: false
 
 Defines query params and body for a request.
 
-Returns [Object](object) via `query` and `body`.
+Returns [Contract::Object](contract-object) via `query` and `body`.
 
 ## Instance Methods
 
 ### #body
 
 `#body(&block)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/request.rb#L59)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/request.rb#L57)
 
 Defines the request body for this request.
 
@@ -47,7 +47,7 @@ end
 
 `#query(&block)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/request.rb#L35)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/request.rb#L33)
 
 Defines query parameters for this request.
 

docs/reference/contract-response.md

@@ -18,7 +18,7 @@ Returns [Object](object) via `body`.
 
 `#body(&block)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L65)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L64)
 
 Defines the response body for this response.
 
@@ -48,7 +48,7 @@ end
 
 `#no_content!`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L47)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L46)
 
 Declares this action returns 204 No Content.
 
@@ -77,7 +77,7 @@ end
 
 `#no_content?`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L28)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/contract/response.rb#L27)
 
 Returns true if this response is 204 No Content.
 

docs/reference/export-base.md

@@ -49,7 +49,7 @@ Apiwork::Export.register(ProtobufExport)
 
 `.export_name(name = nil)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L43)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L51)
 
 The export name.
 
@@ -69,7 +69,7 @@ The export name.
 
 `.file_extension(value = nil)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L85)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L88)
 
 The file extension for string exports.
 
@@ -144,7 +144,7 @@ end
 
 `.output(type = nil)`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L52)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L60)
 
 Declares the output type for this export.
 
@@ -162,7 +162,7 @@ Declares the output type for this export.
 
 `#data`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L262)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L242)
 
 The API introspection facade.
 
@@ -182,7 +182,7 @@ This is the primary interface for accessing introspection data in export generat
 
 `#generate`
 
-[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L206)
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L186)
 
 Generates the export output.
 
@@ -199,3 +199,37 @@ to types, enums, resources, actions, and other introspection data.
 - [Introspection::API](introspection-api)
 
 ---
+
+### #key_format
+
+`#key_format`
+
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L250)
+
+The key format for this export.
+
+**Returns**
+
+`Symbol`
+
+---
+
+### #transform_key
+
+`#transform_key(key)`
+
+[GitHub](https://github.com/skiftle/apiwork/blob/main/lib/apiwork/export/base.rb#L259)
+
+Transforms a key according to the configured key format.
+
+**Parameters**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `key` | `String, Symbol` | the key to transform |
+
+**Returns**
+
+`String`
+
+---

lib/apiwork/adapter/base.rb

@@ -66,7 +66,7 @@ def register_api(registrar, capabilities)
       #       if action.collection?
       #         definition.request do
       #           query do
-      #             integer :page, optional: true
+      #             integer? :page
       #           end
       #         end
       #       end

lib/apiwork/contract/action.rb

@@ -163,7 +163,7 @@ def raises(*error_code_keys)
       #   action :create do
       #     request do
       #       query do
-      #         boolean :dry_run, optional: true
+      #         boolean? :dry_run
       #       end
       #       body do
       #         string :title

lib/apiwork/contract/base.rb

@@ -313,7 +313,7 @@ def import(contract_class, as:)
         #     action :show do
         #       request do
         #         query do
-        #           string :include, optional: true
+        #           string? :include
         #         end
         #       end
         #       response do

lib/apiwork/contract/request.rb

@@ -5,7 +5,7 @@ module Contract
     # @api public
     # Defines query params and body for a request.
     #
-    # Returns {Object} via `query` and `body`.
+    # Returns {Contract::Object} via `query` and `body`.
     class Request
       attr_reader :action_name,
                   :contract_class
@@ -27,8 +27,8 @@ def initialize(contract_class, action_name)
       #
       # @example
       #   query do
-      #     integer :page, optional: true
-      #     string :status, enum: :status, optional: true
+      #     integer? :page
+      #     string? :status, enum: :status
       #   end
       def query(&block)
         if block