class WarpEngine::Api::ServiceController

The public service descriptor a client reads before anything else.

Public Instance Methods

Source

# File app/controllers/warp_engine/api/service_controller.rb, line 64
def show
  render json: {
    engine:  "warp_engine",
    version: WarpEngine::VERSION,
    api: {
      version: WarpEngine::API_VERSION,
      catalog: {
        pageSize:    WarpEngine.config.catalog_page_size.to_i,
        maxPageSize: WarpEngine.config.catalog_max_page_size.to_i
      }
    },
    catalog: { gated: !WarpEngine::AccessPolicy.open? },
    auth:    auth_descriptor,
    admin:   admin_descriptor,
    shelves: WarpEngine::Shelves.descriptors
  }
end

GET /api/service.

Renders what this deployment offers: the engine name and version, the API shape version and catalog paging limits, whether the catalog is gated, the device sign-in endpoints (auth, null without client identity), the Admin API addresses (admin, null while it is off) and the shelf descriptors. Needs no credential.