class Metadata

Overview

description of the welcome klass

Defined in:

controllers/metadata.cr

Constant Summary

HUMAN_NAME = App::NAME.gsub(/\-|\_/, ' ')
MODEL_NAME = App::NAME.gsub(/\-/, '_')
OPENAPI = File.exists?("openapi.yml") ? YAML.parse(File.read("openapi.yml")) : ActionController::OpenAPI.generate_open_api_docs(title: HUMAN_NAME, version: App::VERSION, description: App::DESCRIPTION || "OpenAPI docs for ChatGPT plugin")

this file is built as part of the docker build

PARSER_LIST = ["application/json"]

description of the welcome klass

RESPONDER_LIST = ["application/json"]

description of the welcome klass

Class Method Summary

Instance Method Summary

Instance methods inherited from class Application

bad_media_type(error) : AC::Error::ContentResponse bad_media_type, invalid_param(error) : AC::Error::ParameterResponse invalid_param, resource_not_found(error) : AC::Error::CommonResponse resource_not_found, set_cors_headers set_cors_headers, set_request_id set_request_id

Class Method Detail

def self.ai_plugin_json(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts) #

Helper methods for performing redirect_to calls


def self.base_route #

Helper for obtaining base route


Instance Method Detail

def ai_plugin_json #

The manifest file that defines the plugin it's using the macro DSL so it is not included in the OpenAPI docs that are provided to ChatGPT https://platform.openai.com/docs/plugins/getting-started/plugin-manifest


[View source]
def base_route(*args, **options) #

Helper for obtaining base route


def base_route(*args, **options, &) #

Helper for obtaining base route


def openapi_json #

returns the OpenAPI representation of this service in JSON format https://platform.openai.com/docs/plugins/getting-started/openapi-definition


[View source]
def openapi_yaml #

returns the OpenAPI representation of this service in YAML format https://platform.openai.com/docs/plugins/getting-started/openapi-definition


[View source]