moonbitstack/moonctl/doc

README
U
Bind
U
Command
U
Config
U
DataSource
U
DataSourceError
U
DdlColumn
U
DdlTable
U
Diagnostic
U
DocVersion
U
Field
U
FuncFn
U
GatewayRoute
U
GenFile
U
Group
U
Label
U
Lang
U
PgTarget
U
Plugin
U
Proto
U
ProtoEnum
U
ProtoEnumValue
U
ProtoField
U
ProtoMessage
U
ProtoOneof
U
ProtoService
U
Range
U
ReflectedColumn
U
Regen
U
Route
U
Rpc
U
Severity
U
Spec
U
SpecError
U
Style
U
StyleError
U
Template
U
TemplateEntry
U
TemplateError
U
TreeFile
U
TypeDef
U
Value
V
bug_report
V
cache_file_name
V
client_file
V
client_file_name
V
command_names
V
commands
V
completion
V
config_get
V
config_keys
V
config_set
V
config_text
V
default_config
V
default_routes
V
deps
V
env_report
V
find_template
V
format
V
gateway_file_name
V
gen_files_to_json
V
generate
V
generate_agent
V
generate_cached
V
generate_client
V
generate_crud
V
generate_crud_from_ddl
V
generate_crud_from_reflection
V
generate_doc
V
generate_gateway
V
generate_gql
V
generate_gql_tree
V
generate_grpc
V
generate_markdown
V
generate_mcp_tree
V
generate_migrations
V
generate_model
V
generate_mongo
V
generate_rpc_tree
V
generate_tree
V
generate_with
V
has_errors
V
has_method
V
markdown_file_name
V
migrate_config
V
migrate_file_name
V
mod_pins
V
mongo_file_name
V
openapi_document
V
parse
V
parse_all
V
parse_config
V
parse_ddl
V
parse_dsn
V
parse_gen_files
V
parse_lenient
V
parse_proto
V
parse_route_map
V
pin_module
V
pinned_version
V
pins
V
plugin_argv
V
plugin_from_json
V
plugin_plan
V
plugin_request
V
port
V
proto_reserved_conflicts
V
render
V
resolve_import
V
safe_path
V
scaffold_api
V
scaffold_docker
V
scaffold_gql
V
scaffold_kube
V
scaffold_mcp
V
scaffold_model
V
scaffold_rpc
V
spec_from_json
V
spec_to_json
V
spec_to_value
V
subcommands
V
swagger_ui_stub
V
tables_from_reflection
V
template_detail
V
template_table
V
templates
V
templates_of
V
tree_plan
V
upgrade_pins
V
usage_text
V
validate
V
validate_files
V
validate_source

moonbitstack/moonctl/doc does not have a README file

DocVersion

pub(all) enum DocVersion {
  Swagger20
  OpenApi30
  OpenApi31
} derive(Eq)

Target OpenAPI / Swagger document version. mctl emits every mainstream version from one .api spec — the same shape moonapi's runtime emitter takes, so a generated service and a hand-built moonapi app document the same way.

DocVersion::equal

source

fn DocVersion::equal(DocVersion, DocVersion) -> Bool

DocVersion::not_equal

source

fn DocVersion::not_equal(x : DocVersion, y : DocVersion) -> Bool

generate_doc

source

fn generate_doc(spec : @moonbitstack/moonctl/api.Spec
Spec, version? : DocVersion, title? : String, api_version? : String) -> String

Generate an OpenAPI / Swagger document from spec, stringified with two-space indentation. version picks the dialect (Swagger 2.0 / OpenAPI 3.0 / 3.1).

generate_markdown

source

fn generate_markdown(spec : @moonbitstack/moonctl/api.Spec
Spec, title? : String) -> String

The whole reference: the service, a route table, then a table per type. title replaces the service name in the heading for a reader who wants the document to say what the service is for.

markdown_file_name

source

fn markdown_file_name(service : String) -> String

The file name a Markdown reference lands in: greet → greet_api.md.

openapi_document

source

fn openapi_document(spec : @moonbitstack/moonctl/api.Spec
Spec, version? : DocVersion, title? : String, api_version? : String) -> Json

Build the OpenAPI / Swagger document for spec as a Json value. Routes fold into paths → HTTP method → operation (with operationId, any :name path parameters, and a 200 response); every type block becomes a component schema (definitions in 2.0, components/schemas in 3.x). version selects the document dialect; title/api_version fill the info block.

swagger_ui_stub

source

fn swagger_ui_stub(spec_url? : String, title? : String) -> String

A self-contained Swagger UI page for the document served at spec_url. The same stub moonapi ships, so a generated service and a live app render alike.