bullet_train-api 1.1.3 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74e01f8b6f3b2eafac8bd31e934ffd26ca0a286c5d38081884089f034f5515e
-  data.tar.gz: 32fe4b66a1d33d9b1754a9978c9b800c18389fda615f681c38a9fb254aa4255c
+  metadata.gz: f474623bb0f011c89b57e3d4b0c6b8dbce5dc388772dfa5373155b2216a39b8e
+  data.tar.gz: cc167320a1f660301b3beab289db2fd29c2c6b72361d47c5276fe24a28f27eec
 SHA512:
-  metadata.gz: 5e5fe1616498933e0c55258cae6a4bd4f17c33bbf7ff5c15595a807fd103fcde3e648a600e7f71833874271dcae75b366d8cdc209b11d2a88003992f84373369
-  data.tar.gz: b5b543622985e9d25dcf91b05839a0af7dc7740751e0b2d4a1adbb16ec09babcd3482dddadee8d2fa9834cf69b31d749f929860954af4fac27433d67a9f0572d
+  metadata.gz: cf49807aecaa0e1814fce504b214c41b6606f36dbd69814b520c45eb5ad7bf75af2b593befd2617cff8198572d0a0b3c8256f38aba78dcc5874cbae021939db5
+  data.tar.gz: 1ba92be181ff6faa0bbcfb0e480105e31222076d48bd213710200772403328492391a0247023cb0eff6f4c2b2e1d54f40a1dd8427d57d256ba2d5f91467bebff

data/app/controllers/api/open_api_controller.rb

@@ -0,0 +1,59 @@
+module OpenApiHelper
+  def indent(string, count)
+    lines = string.lines
+    first_line = lines.shift
+    lines = lines.map { |line| ("  " * count).to_s + line }
+    lines.unshift(first_line).join.html_safe
+  end
+
+  def components_for(model)
+    for_model model do
+      indent(render("api/#{@version}/open_api/#{model.name.underscore.pluralize}/components"), 2)
+    end
+  end
+
+  def current_model
+    @model_stack.last
+  end
+
+  def for_model(model)
+    @model_stack ||= []
+    @model_stack << model
+    result = yield
+    @model_stack.pop
+    result
+  end
+
+  def paths_for(model)
+    for_model model do
+      indent(render("api/#{@version}/open_api/#{model.name.underscore.pluralize}/paths"), 1)
+    end
+  end
+
+  def attribute(attribute)
+    heading = t("#{current_model.name.underscore.pluralize}.fields.#{attribute}.heading")
+    # TODO A lot of logic to be done here.
+    indent("#{attribute}:\n  description: \"#{heading}\"\n  type: string", 2)
+  end
+
+  def parameter(attribute)
+    heading = t("#{current_model.name.underscore.pluralize}.fields.#{attribute}.heading")
+    # TODO A lot of logic to be done here.
+    indent("#{attribute}:\n  description: \"#{heading}\"\n  type: string", 2)
+  end
+end
+
+class Api::OpenApiController < ApplicationController
+  helper :open_api
+
+  def set_default_response_format
+    request.format = :yaml
+  end
+
+  before_action :set_default_response_format
+
+  def index
+    @version = params[:version]
+    render "api/#{@version}/open_api/index", layout: nil, format: :text
+  end
+end

data/app/views/api/v1/open_api/index.yaml.erb

@@ -0,0 +1,29 @@
+openapi: 3.1.0
+info:
+  title: Bullet Train API
+  description: |
+    The baseline API of a new Bullet Train application.
+  license: 
+    name: MIT
+    url: https://opensource.org/licenses/MIT
+  version: "<%= @version.upcase %>"
+servers:
+  - url: <%= ENV["BASE_URL"] %>/api/<%= @version %>
+components:
+  schemas:
+    <%= components_for Team %>
+    <%= components_for User %>
+    <%= components_for Scaffolding::CompletelyConcrete::TangibleThing unless scaffolding_things_disabled? %>
+    <%# 🚅 super scaffolding will insert new components above this line. %>
+  parameters:
+    id:
+      name: id
+      in: path
+      required: true
+      schema:
+        type: string
+paths:
+  <%= paths_for Team %>
+  <%= paths_for User %>
+  <%= paths_for Scaffolding::CompletelyConcrete::TangibleThing unless scaffolding_things_disabled? %>
+  <%# 🚅 super scaffolding will insert new paths above this line. %>

data/app/views/api/v1/open_api/teams/_paths.yaml.erb

@@ -0,0 +1,55 @@
+/teams:
+  get:
+    tags:
+      - Teams
+    summary: "List Teams"
+    operationId: listTeams
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: array
+                  items: 
+                    $ref: "#/components/schemas/Team::Attributes"
+                has_more:
+                  type: boolean
+/teams/{id}:
+  get:
+    tags:
+      - Teams
+    summary: "Fetch Team"
+    operationId: fetchTeam
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Team::Attributes"
+  put:
+    tags:
+      - Teams
+    summary: "Update Team"
+    operationId: updateTeam
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Team::Parameters"

data/app/views/api/v1/open_api/users/_paths.yaml.erb

@@ -0,0 +1,55 @@
+/users:
+  get:
+    tags:
+      - Users
+    summary: "List Users"
+    operationId: listUsers
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: array
+                  items: 
+                    $ref: "#/components/schemas/User::Attributes"
+                has_more:
+                  type: boolean
+/users/{id}:
+  get:
+    tags:
+      - Users
+    summary: "Fetch User"
+    operationId: fetchUser
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/User::Attributes"
+  put:
+    tags:
+      - Users
+    summary: "Update User"
+    operationId: updateUser
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/User::Parameters"

data/config/routes.rb

@@ -18,6 +18,8 @@ Rails.application.routes.draw do
   end
 
   namespace :api do
+    match "*version/openapi.yaml" => "open_api#index", :via => :get
+
     namespace :v1 do
       shallow do
         resources :users

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.1.3"
+    VERSION = "1.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.6
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -122,6 +122,7 @@ files:
 - app/assets/config/bullet_train_api_manifest.js
 - app/controllers/account/platform/access_tokens_controller.rb
 - app/controllers/account/platform/applications_controller.rb
+- app/controllers/api/open_api_controller.rb
 - app/controllers/api/v1/platform/access_tokens_controller.rb
 - app/controllers/concerns/api/controllers/base.rb
 - app/controllers/concerns/api/v1/teams/controller_base.rb
@@ -147,6 +148,9 @@ files:
 - app/views/account/platform/applications/new.html.erb
 - app/views/account/platform/applications/show.html.erb
 - app/views/account/platform/applications/show.json.jbuilder
+- app/views/api/v1/open_api/index.yaml.erb
+- app/views/api/v1/open_api/teams/_paths.yaml.erb
+- app/views/api/v1/open_api/users/_paths.yaml.erb
 - app/views/api/v1/platform/access_tokens/_access_token.json.jbuilder
 - app/views/api/v1/platform/access_tokens/index.json.jbuilder
 - app/views/api/v1/platform/access_tokens/show.json.jbuilder