Antoine Goutenoir 959cf1c3c9
[GdScript] Templates for GdScript (Godot 4) (#19267)
* feat(gdscript): sketch implementation of gdscript target language

This does not really work yet, but it's a start.
Results are not denormalized, no support for enums nor datetimes,
and thousands of other features are missing.

I still don't know how we are going to denormalize JSON+LD
without writing a whole GDScript lib for it…

* feat: add an exhaustive list of keywords reserved in GDScript

I've also provided the small python script I used to generate the list.

* refacto(gdscript): start using partials in templates

Whilst I'm racking my brains trying to figure out integration testing…

* test(gdscript): prepare a demo and integration testing

* fix(gdscript): do not use subclasses, use plain POGO

(plain ol' godot object)

One: I don't know how they work under-the-hood.
Two: I'm very confused over-the-hood.
Tri: We do not need them.

* refacto(gdscript): move demo files to their own directory

I know I'm making a lot of commits for not much,
but now I'm opening the sample files with Godot as well,
and doing unholy things with filesystems,
so I'm not taking any chances.

It's all going to be squashed anyway.  :)

* fix(gdscript): sample as a Godot project

It works !  I can now write integration tests in GDScript.
The real work starts now.

/spend 25h

* feat(gdscript): serialize and send body params

The test suite is now past its first hurdle, the 415 HTTP status code,
and went straight into an unexpected error 500.

I suspect the server does not like me trying to set the pet id at 0,
because that's what we're trying to do right now.

Godot is crashing a lot, mostly because I don't know how to make Callable.NOOP
and my current solution hints at optional on_success and on_failure,
yet if we omit them the engine will ragequit.

* feat(gdscript): check request body for required yet missing properties

Now we'll get a nice error when we forget to set a required property.

The demo is now able to:
- connect
- create a user
- login as that user
- create a pet

* feat(gdscript): namespace core classes as well with apiPrefixName

This makes our usage of `class_name` a little more acceptable.

* feat(gdscript): support prefixes and suffixes for class names

This will crutch namespacing well enough for most uses.

* feat(gdscript): handle enums, naively

* feat(gdscript): support basic API endpoint param constraints

- minLength
- maxLength
- minItems
- maxItems
- minimum
- maximum
- pattern (no flags)

* feat(gdscript): handle header params and header customization

We also support serializing to application/x-www-form-urlencoded now.

Next up: DateTimes !

* feat(gdscript): handle Date and DateTime like Strings

There's no timezone support in Godot for DateTimes.

* feat(gdscript): support plain text responses

* feat(gdscript): support collections of models

Those are Arrays, not custom collection objects.

* feat(gdscript): configure default host from OAS

* feat(gdscript): some documentation and better config

We don't need no factories nor singletons ; config is enough.

* docs(gdscript): document usage a little

* feat(gdscript): add more reserved words, skip jsonld models and configure features

We can now generate a client for an OAS server running ApiPlatform (PHP).

* feat(gdscript): improve logging with a configurable log level

* feat(gdscript): add support for Basic Bearer and Header ApiKey

(but I can't find the `description` template handler)

* fix(gdscript)

Too late to amend >.<

* fix(gdscript)

dangsarnit

* chore(gdscript): clean up a sprint artifact

* fix: don't forget the HTTP error code when relevant

* feat: use Resource as base class for models

* fix. Default string values now with "quotes"

* temporary remove settings as godot api have changed

* kick ci

* docs: review gdscript java class

* feat: support for TLS, some refacto, some review

There's still a lot of holes, TODOs and FIXMEs.

* feat: experimental support of Request inline objects

The inline response objects are still not supported.

* feat(gdscript): support inline request and response objects

* chore(gdscript): review the templates

* fix(gdscript): unexpected nulls in default values

{{#if defaultValue}} evaluates to true for null if we call super here.

* refacto(gdscript): replace "bee" prefix by "bzz", use a constructor

Now we pass the config and the client via the constructor.
This reduces the area of the public surface a bit, for the better I think.
This commit also cleans up the class name shenanigans.

* fix(gdscript): add missing file

* test(gdscript): refactor the test project to use the generated lib as addon

Since there is no singleton in the generated client, the addon need not be enabled in the project configuration to be usable.

The --headless mode is broken for now, as things changed in Godot 4 since the beta.

* docs(gdscript): document petstore server ADR

* test(gdscript): add GUT and an integration test

We used the latest stable GUT, but a feature we're going to need was merged today, so we'll need to update it either to master or to the next release at some point.

* refacto(gdscript, breaking): use an ApiResponse object in success callbacks

/spent 6d since the beginning

* test(gdscript): update integration tests

/spend 2h

* docs(gdscript): explain the new ApiResponse

Also moving core templates to their own subdir, for clarity.

/spend 10m

* chore(gdscript): review, document, clean up

/spend 2h

* test(gdscript): test the delete operation as well

/spend 7m

* feat(gdscript): update GUT and exit with appropriate code

/spend 2h

* docs(gdscript): add Gdscript's PI

Hire me while I'm available !  :D
I'd rather code than make a CV.

* feat(gdscript): support reserved keywords

Also adding some more assertions,
and using our own OAS file now.

/spend 3h

* refacto(gdscript): use "base" instead of "bee"

/spend 1h

* feat(gdscript): improve descriptions

/spend 1h

* fix(gdscript): await before polling

Contributed by @jchu231

* docs(gdscript): review the template files

* docs(gdscript): review and generate docs

---------

Co-authored-by: Bagrat <b.saatsazov@gmail.com>
2024-11-17 10:48:19 +08:00

44 KiB

title
Documentation for the gdscript Generator

METADATA

Property Value Notes
generator name gdscript pass this to the generate command after -g
generator stability STABLE
generator type CLIENT
generator language Java
generator default templating engine handlebars
helpTxt Generates a GDScript client (Godot 4+).

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
anticollisionPrefix Prefix added at the beginning of reserved words some_
anticollisionSuffix Suffix added at the ending of reserved words
coreNamePrefix PascalCase prefix added to all core classes
coreNameSuffix PascalCase suffix added to all core classes
disallowAdditionalPropertiesIfNotPresent If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
enumUnknownDefaultCase If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
legacyDiscriminatorBehavior Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

RESERVED WORDS

  • _bzz_client
  • _bzz_config
  • _bzz_connect_client_if_needed
  • _bzz_convert_http_method
  • _bzz_do_request_text
  • _bzz_escape_path_param
  • _bzz_format_error_response
  • _bzz_get_content_type
  • _bzz_name
  • _bzz_next_loop_iteration
  • _bzz_request
  • _bzz_request_text
  • _bzz_urlize_path_param
  • aabb
  • abs
  • absf
  • absi
  • acceptdialog
  • acos
  • aescontext
  • and
  • animatablebody2d
  • animatablebody3d
  • animatedsprite2d
  • animatedsprite3d
  • animatedtexture
  • animation
  • animationlibrary
  • animationnode
  • animationnodeadd2
  • animationnodeadd3
  • animationnodeanimation
  • animationnodeblend2
  • animationnodeblend3
  • animationnodeblendspace1d
  • animationnodeblendspace2d
  • animationnodeblendtree
  • animationnodeoneshot
  • animationnodeoutput
  • animationnodestatemachine
  • animationnodestatemachineplayback
  • animationnodestatemachinetransition
  • animationnodesync
  • animationnodetimescale
  • animationnodetimeseek
  • animationnodetransition
  • animationplayer
  • animationrootnode
  • animationtrackeditplugin
  • animationtree
  • area2d
  • area3d
  • arraymesh
  • arrayoccluder3d
  • as
  • asin
  • aspectratiocontainer
  • assert
  • astar2d
  • astar3d
  • astargrid2d
  • atan
  • atan2
  • atlastexture
  • audiobuslayout
  • audioeffect
  • audioeffectamplify
  • audioeffectbandlimitfilter
  • audioeffectbandpassfilter
  • audioeffectcapture
  • audioeffectchorus
  • audioeffectcompressor
  • audioeffectdelay
  • audioeffectdistortion
  • audioeffecteq
  • audioeffecteq10
  • audioeffecteq21
  • audioeffecteq6
  • audioeffectfilter
  • audioeffecthighpassfilter
  • audioeffecthighshelffilter
  • audioeffectinstance
  • audioeffectlimiter
  • audioeffectlowpassfilter
  • audioeffectlowshelffilter
  • audioeffectnotchfilter
  • audioeffectpanner
  • audioeffectphaser
  • audioeffectpitchshift
  • audioeffectrecord
  • audioeffectreverb
  • audioeffectspectrumanalyzer
  • audioeffectspectrumanalyzerinstance
  • audioeffectstereoenhance
  • audiolistener2d
  • audiolistener3d
  • audioserver
  • audiostream
  • audiostreamgenerator
  • audiostreamgeneratorplayback
  • audiostreammicrophone
  • audiostreamplayback
  • audiostreamplaybackresampled
  • audiostreamplayer
  • audiostreamplayer2d
  • audiostreamplayer3d
  • audiostreamrandomizer
  • audiostreamwav
  • await
  • backbuffercopy
  • basebutton
  • basematerial3d
  • basis
  • bezier_interpolate
  • bitmap
  • bone2d
  • boneattachment3d
  • bonemap
  • bool
  • boxcontainer
  • boxmesh
  • boxoccluder3d
  • boxshape3d
  • break
  • breakpoint
  • button
  • buttongroup
  • bytes_to_var
  • bytes_to_var_with_objects
  • bzz_code
  • bzz_error
  • bzz_headers
  • bzz_method
  • bzz_path
  • bzz_query
  • bzz_result
  • callable
  • callbacktweener
  • camera2d
  • camera3d
  • cameraattributes
  • cameraattributesphysical
  • cameraattributespractical
  • camerafeed
  • cameraserver
  • cameratexture
  • canvasgroup
  • canvasitem
  • canvasitemmaterial
  • canvaslayer
  • canvasmodulate
  • canvastexture
  • capsulemesh
  • capsuleshape2d
  • capsuleshape3d
  • ceil
  • ceilf
  • ceili
  • centercontainer
  • characterbody2d
  • characterbody3d
  • charfxtransform
  • checkbox
  • checkbutton
  • circleshape2d
  • clamp
  • clampf
  • clampi
  • class
  • class_name
  • classdb
  • clockwise
  • codeedit
  • codehighlighter
  • collisionobject2d
  • collisionobject3d
  • collisionpolygon2d
  • collisionpolygon3d
  • collisionshape2d
  • collisionshape3d
  • color
  • colorpicker
  • colorpickerbutton
  • colorrect
  • compressedcubemap
  • compressedcubemaparray
  • compressedtexture2d
  • compressedtexture2darray
  • compressedtexture3d
  • compressedtexturelayered
  • concavepolygonshape2d
  • concavepolygonshape3d
  • conetwistjoint3d
  • configfile
  • confirmationdialog
  • const
  • container
  • continue
  • control
  • convexpolygonshape2d
  • convexpolygonshape3d
  • corner_bottom_left
  • corner_bottom_right
  • corner_top_left
  • corner_top_right
  • cos
  • cosh
  • counterclockwise
  • cpuparticles2d
  • cpuparticles3d
  • crypto
  • cryptokey
  • cubemap
  • cubemaparray
  • cubic_interpolate
  • cubic_interpolate_angle
  • cubic_interpolate_angle_in_time
  • cubic_interpolate_in_time
  • curve
  • curve2d
  • curve3d
  • curvetexture
  • curvexyztexture
  • cylindermesh
  • cylindershape3d
  • dampedspringjoint2d
  • db_to_linear
  • decal
  • deg_to_rad
  • dictionary
  • diraccess
  • directionallight2d
  • directionallight3d
  • displayserver
  • dtlsserver
  • ease
  • editorcommandpalette
  • editordebuggerplugin
  • editorexportplatform
  • editorexportplugin
  • editorfeatureprofile
  • editorfiledialog
  • editorfilesystem
  • editorfilesystemdirectory
  • editorfilesystemimportformatsupportquery
  • editorimportplugin
  • editorinspector
  • editorinspectorplugin
  • editorinterface
  • editornode3dgizmo
  • editornode3dgizmoplugin
  • editorpaths
  • editorplugin
  • editorproperty
  • editorresourceconversionplugin
  • editorresourcepicker
  • editorresourcepreview
  • editorresourcepreviewgenerator
  • editorsceneformatimporter
  • editorscenepostimport
  • editorscenepostimportplugin
  • editorscript
  • editorscriptpicker
  • editorselection
  • editorsettings
  • editorspinslider
  • editorsyntaxhighlighter
  • editortranslationparserplugin
  • editorundoredomanager
  • editorvcsinterface
  • elif
  • else
  • encodedobjectasid
  • engine
  • enginedebugger
  • engineprofiler
  • enum
  • environment
  • err_already_exists
  • err_already_in_use
  • err_bug
  • err_busy
  • err_cant_acquire_resource
  • err_cant_connect
  • err_cant_create
  • err_cant_fork
  • err_cant_open
  • err_cant_resolve
  • err_compilation_failed
  • err_connection_error
  • err_cyclic_link
  • err_database_cant_read
  • err_database_cant_write
  • err_does_not_exist
  • err_duplicate_symbol
  • err_file_already_in_use
  • err_file_bad_drive
  • err_file_bad_path
  • err_file_cant_open
  • err_file_cant_read
  • err_file_cant_write
  • err_file_corrupt
  • err_file_eof
  • err_file_missing_dependencies
  • err_file_no_permission
  • err_file_not_found
  • err_file_unrecognized
  • err_help
  • err_invalid_data
  • err_invalid_declaration
  • err_invalid_parameter
  • err_link_failed
  • err_locked
  • err_method_not_found
  • err_out_of_memory
  • err_parameter_range_error
  • err_parse_error
  • err_printer_on_fire
  • err_query_failed
  • err_script_failed
  • err_skip
  • err_timeout
  • err_unauthorized
  • err_unavailable
  • err_unconfigured
  • error_string
  • exp
  • expression
  • extends
  • failed
  • fileaccess
  • filedialog
  • filesystemdock
  • float
  • floor
  • floorf
  • floori
  • flowcontainer
  • fmod
  • fogmaterial
  • fogvolume
  • font
  • fontfile
  • fontvariation
  • for
  • fposmod
  • func
  • generic6dofjoint3d
  • geometry2d
  • geometry3d
  • geometryinstance3d
  • godotsharp
  • gpuparticles2d
  • gpuparticles3d
  • gpuparticlesattractor3d
  • gpuparticlesattractorbox3d
  • gpuparticlesattractorsphere3d
  • gpuparticlesattractorvectorfield3d
  • gpuparticlescollision3d
  • gpuparticlescollisionbox3d
  • gpuparticlescollisionheightfield3d
  • gpuparticlescollisionsdf3d
  • gpuparticlescollisionsphere3d
  • gradient
  • gradienttexture1d
  • gradienttexture2d
  • graphedit
  • graphnode
  • gridcontainer
  • groovejoint2d
  • hash
  • hashingcontext
  • hboxcontainer
  • heightmapshape3d
  • hflowcontainer
  • hingejoint3d
  • hmaccontext
  • horizontal
  • horizontal_alignment_center
  • horizontal_alignment_fill
  • horizontal_alignment_left
  • horizontal_alignment_right
  • hscrollbar
  • hseparator
  • hslider
  • hsplitcontainer
  • httpclient
  • httprequest
  • if
  • image
  • imageformatloader
  • imageformatloaderextension
  • imagetexture
  • imagetexture3d
  • imagetexturelayered
  • immediatemesh
  • importermesh
  • importermeshinstance3d
  • in
  • inf
  • inline_alignment_bottom
  • inline_alignment_bottom_to
  • inline_alignment_center
  • inline_alignment_center_to
  • inline_alignment_image_mask
  • inline_alignment_text_mask
  • inline_alignment_to_baseline
  • inline_alignment_to_bottom
  • inline_alignment_to_center
  • inline_alignment_to_top
  • inline_alignment_top
  • inline_alignment_top_to
  • input
  • inputevent
  • inputeventaction
  • inputeventfromwindow
  • inputeventgesture
  • inputeventjoypadbutton
  • inputeventjoypadmotion
  • inputeventkey
  • inputeventmagnifygesture
  • inputeventmidi
  • inputeventmouse
  • inputeventmousebutton
  • inputeventmousemotion
  • inputeventpangesture
  • inputeventscreendrag
  • inputeventscreentouch
  • inputeventshortcut
  • inputeventwithmodifiers
  • inputmap
  • instance_from_id
  • instanceplaceholder
  • int
  • intervaltweener
  • inverse_lerp
  • ip
  • is
  • is_equal_approx
  • is_finite
  • is_inf
  • is_instance_id_valid
  • is_instance_valid
  • is_nan
  • is_zero_approx
  • itemlist
  • javaclass
  • javaclasswrapper
  • javascriptbridge
  • javascriptobject
  • jnisingleton
  • joint2d
  • joint3d
  • joy_axis_invalid
  • joy_axis_left_x
  • joy_axis_left_y
  • joy_axis_max
  • joy_axis_right_x
  • joy_axis_right_y
  • joy_axis_sdl_max
  • joy_axis_trigger_left
  • joy_axis_trigger_right
  • joy_button_a
  • joy_button_b
  • joy_button_back
  • joy_button_dpad_down
  • joy_button_dpad_left
  • joy_button_dpad_right
  • joy_button_dpad_up
  • joy_button_guide
  • joy_button_invalid
  • joy_button_left_shoulder
  • joy_button_left_stick
  • joy_button_max
  • joy_button_misc1
  • joy_button_paddle1
  • joy_button_paddle2
  • joy_button_paddle3
  • joy_button_paddle4
  • joy_button_right_shoulder
  • joy_button_right_stick
  • joy_button_sdl_max
  • joy_button_start
  • joy_button_touchpad
  • joy_button_x
  • joy_button_y
  • json
  • jsonrpc
  • key_0
  • key_1
  • key_2
  • key_3
  • key_4
  • key_5
  • key_6
  • key_7
  • key_8
  • key_9
  • key_a
  • key_aacute
  • key_acircumflex
  • key_acute
  • key_adiaeresis
  • key_ae
  • key_agrave
  • key_alt
  • key_ampersand
  • key_apostrophe
  • key_aring
  • key_asciicircum
  • key_asciitilde
  • key_asterisk
  • key_at
  • key_atilde
  • key_b
  • key_back
  • key_backslash
  • key_backspace
  • key_backtab
  • key_bar
  • key_bassboost
  • key_bassdown
  • key_bassup
  • key_braceleft
  • key_braceright
  • key_bracketleft
  • key_bracketright
  • key_brokenbar
  • key_c
  • key_capslock
  • key_ccedilla
  • key_cedilla
  • key_cent
  • key_clear
  • key_code_mask
  • key_colon
  • key_comma
  • key_copyright
  • key_ctrl
  • key_currency
  • key_d
  • key_degree
  • key_delete
  • key_diaeresis
  • key_direction_l
  • key_direction_r
  • key_division
  • key_dollar
  • key_down
  • key_e
  • key_eacute
  • key_ecircumflex
  • key_ediaeresis
  • key_egrave
  • key_end
  • key_enter
  • key_equal
  • key_escape
  • key_eth
  • key_exclam
  • key_exclamdown
  • key_f
  • key_f1
  • key_f10
  • key_f11
  • key_f12
  • key_f13
  • key_f14
  • key_f15
  • key_f16
  • key_f17
  • key_f18
  • key_f19
  • key_f2
  • key_f20
  • key_f21
  • key_f22
  • key_f23
  • key_f24
  • key_f25
  • key_f26
  • key_f27
  • key_f28
  • key_f29
  • key_f3
  • key_f30
  • key_f31
  • key_f32
  • key_f33
  • key_f34
  • key_f35
  • key_f4
  • key_f5
  • key_f6
  • key_f7
  • key_f8
  • key_f9
  • key_favorites
  • key_forward
  • key_g
  • key_greater
  • key_guillemotleft
  • key_guillemotright
  • key_h
  • key_help
  • key_home
  • key_homepage
  • key_hyper_l
  • key_hyper_r
  • key_hyphen
  • key_i
  • key_iacute
  • key_icircumflex
  • key_idiaeresis
  • key_igrave
  • key_insert
  • key_j
  • key_k
  • key_kp_0
  • key_kp_1
  • key_kp_2
  • key_kp_3
  • key_kp_4
  • key_kp_5
  • key_kp_6
  • key_kp_7
  • key_kp_8
  • key_kp_9
  • key_kp_add
  • key_kp_divide
  • key_kp_enter
  • key_kp_multiply
  • key_kp_period
  • key_kp_subtract
  • key_l
  • key_launch0
  • key_launch1
  • key_launch2
  • key_launch3
  • key_launch4
  • key_launch5
  • key_launch6
  • key_launch7
  • key_launch8
  • key_launch9
  • key_launcha
  • key_launchb
  • key_launchc
  • key_launchd
  • key_launche
  • key_launchf
  • key_launchmail
  • key_launchmedia
  • key_left
  • key_less
  • key_m
  • key_macron
  • key_masculine
  • key_mask_alt
  • key_mask_cmd_or_ctrl
  • key_mask_ctrl
  • key_mask_group_switch
  • key_mask_kpad
  • key_mask_meta
  • key_mask_shift
  • key_medianext
  • key_mediaplay
  • key_mediaprevious
  • key_mediarecord
  • key_mediastop
  • key_menu
  • key_meta
  • key_minus
  • key_modifier_mask
  • key_mu
  • key_multiply
  • key_n
  • key_nobreakspace
  • key_none
  • key_notsign
  • key_ntilde
  • key_numbersign
  • key_numlock
  • key_o
  • key_oacute
  • key_ocircumflex
  • key_odiaeresis
  • key_ograve
  • key_onehalf
  • key_onequarter
  • key_onesuperior
  • key_ooblique
  • key_openurl
  • key_ordfeminine
  • key_otilde
  • key_p
  • key_pagedown
  • key_pageup
  • key_paragraph
  • key_parenleft
  • key_parenright
  • key_pause
  • key_percent
  • key_period
  • key_periodcentered
  • key_plus
  • key_plusminus
  • key_print
  • key_q
  • key_question
  • key_questiondown
  • key_quotedbl
  • key_quoteleft
  • key_r
  • key_refresh
  • key_registered
  • key_right
  • key_s
  • key_scrolllock
  • key_search
  • key_section
  • key_semicolon
  • key_shift
  • key_slash
  • key_space
  • key_special
  • key_ssharp
  • key_standby
  • key_sterling
  • key_stop
  • key_super_l
  • key_super_r
  • key_sysreq
  • key_t
  • key_tab
  • key_thorn
  • key_threequarters
  • key_threesuperior
  • key_trebledown
  • key_trebleup
  • key_twosuperior
  • key_u
  • key_uacute
  • key_ucircumflex
  • key_udiaeresis
  • key_ugrave
  • key_underscore
  • key_unknown
  • key_up
  • key_v
  • key_volumedown
  • key_volumemute
  • key_volumeup
  • key_w
  • key_x
  • key_y
  • key_yacute
  • key_ydiaeresis
  • key_yen
  • key_z
  • kinematiccollision2d
  • kinematiccollision3d
  • label
  • label3d
  • labelsettings
  • lerp
  • lerp_angle
  • lerpf
  • light2d
  • light3d
  • lightmapgi
  • lightmapgidata
  • lightmapper
  • lightmapperrd
  • lightmapprobe
  • lightoccluder2d
  • line2d
  • linear_to_db
  • lineedit
  • linkbutton
  • log
  • mainloop
  • margincontainer
  • marker2d
  • marker3d
  • marshalls
  • match
  • material
  • max
  • maxf
  • maxi
  • menubar
  • menubutton
  • mesh
  • meshdatatool
  • meshinstance2d
  • meshinstance3d
  • meshlibrary
  • meshtexture
  • method_flag_const
  • method_flag_editor
  • method_flag_normal
  • method_flag_object_core
  • method_flag_static
  • method_flag_vararg
  • method_flag_virtual
  • method_flags_default
  • methodtweener
  • midi_message_active_sensing
  • midi_message_aftertouch
  • midi_message_channel_pressure
  • midi_message_continue
  • midi_message_control_change
  • midi_message_none
  • midi_message_note_off
  • midi_message_note_on
  • midi_message_pitch_bend
  • midi_message_program_change
  • midi_message_quarter_frame
  • midi_message_song_position_pointer
  • midi_message_song_select
  • midi_message_start
  • midi_message_stop
  • midi_message_system_exclusive
  • midi_message_system_reset
  • midi_message_timing_clock
  • midi_message_tune_request
  • min
  • minf
  • mini
  • missingnode
  • missingresource
  • mouse_button_left
  • mouse_button_mask_left
  • mouse_button_mask_middle
  • mouse_button_mask_right
  • mouse_button_mask_xbutton1
  • mouse_button_mask_xbutton2
  • mouse_button_middle
  • mouse_button_none
  • mouse_button_right
  • mouse_button_wheel_down
  • mouse_button_wheel_left
  • mouse_button_wheel_right
  • mouse_button_wheel_up
  • mouse_button_xbutton1
  • mouse_button_xbutton2
  • move_toward
  • moviewriter
  • multimesh
  • multimeshinstance2d
  • multimeshinstance3d
  • multiplayerapi
  • multiplayerapiextension
  • multiplayerpeer
  • multiplayerpeerextension
  • mutex
  • namespace
  • nan
  • nativeextension
  • nativeextensionmanager
  • navigationagent2d
  • navigationagent3d
  • navigationlink2d
  • navigationlink3d
  • navigationmesh
  • navigationmeshgenerator
  • navigationobstacle2d
  • navigationobstacle3d
  • navigationpathqueryparameters2d
  • navigationpathqueryparameters3d
  • navigationpathqueryresult2d
  • navigationpathqueryresult3d
  • navigationpolygon
  • navigationregion2d
  • navigationregion3d
  • navigationserver2d
  • navigationserver3d
  • nearest_po2
  • ninepatchrect
  • node
  • node2d
  • node3d
  • node3dgizmo
  • nodepath
  • not
  • object
  • occluder3d
  • occluderinstance3d
  • occluderpolygon2d
  • ok
  • omnilight3d
  • on_failure
  • on_success
  • op_add
  • op_and
  • op_bit_and
  • op_bit_negate
  • op_bit_or
  • op_bit_xor
  • op_divide
  • op_equal
  • op_greater
  • op_greater_equal
  • op_in
  • op_less
  • op_less_equal
  • op_max
  • op_module
  • op_multiply
  • op_negate
  • op_not
  • op_not_equal
  • op_or
  • op_positive
  • op_power
  • op_shift_left
  • op_shift_right
  • op_subtract
  • op_xor
  • optimizedtranslation
  • optionbutton
  • or
  • ormmaterial3d
  • os
  • packedbytearray
  • packedcolorarray
  • packeddatacontainer
  • packeddatacontainerref
  • packedfloat32array
  • packedfloat64array
  • packedint32array
  • packedint64array
  • packedscene
  • packedstringarray
  • packedvector2array
  • packedvector3array
  • packetpeer
  • packetpeerdtls
  • packetpeerextension
  • packetpeerstream
  • packetpeerudp
  • panel
  • panelcontainer
  • panoramaskymaterial
  • parallaxbackground
  • parallaxlayer
  • particleprocessmaterial
  • pass
  • path2d
  • path3d
  • pathfollow2d
  • pathfollow3d
  • pckpacker
  • performance
  • physicalbone2d
  • physicalbone3d
  • physicalskymaterial
  • physicsbody2d
  • physicsbody3d
  • physicsdirectbodystate2d
  • physicsdirectbodystate2dextension
  • physicsdirectbodystate3d
  • physicsdirectbodystate3dextension
  • physicsdirectspacestate2d
  • physicsdirectspacestate2dextension
  • physicsdirectspacestate3d
  • physicsdirectspacestate3dextension
  • physicsmaterial
  • physicspointqueryparameters2d
  • physicspointqueryparameters3d
  • physicsrayqueryparameters2d
  • physicsrayqueryparameters3d
  • physicsserver2d
  • physicsserver2dextension
  • physicsserver2dmanager
  • physicsserver3d
  • physicsserver3dextension
  • physicsserver3dmanager
  • physicsserver3drenderingserverhandler
  • physicsshapequeryparameters2d
  • physicsshapequeryparameters3d
  • physicstestmotionparameters2d
  • physicstestmotionparameters3d
  • physicstestmotionresult2d
  • physicstestmotionresult3d
  • pi
  • pingpong
  • pinjoint2d
  • pinjoint3d
  • placeholdercubemap
  • placeholdercubemaparray
  • placeholdermaterial
  • placeholdermesh
  • placeholdertexture2d
  • placeholdertexture2darray
  • placeholdertexture3d
  • placeholdertexturelayered
  • plane
  • planemesh
  • pointlight2d
  • pointmesh
  • polygon2d
  • polygonoccluder3d
  • polygonpathfinder
  • popup
  • popupmenu
  • popuppanel
  • portablecompressedtexture2d
  • posmod
  • pow
  • preload
  • primitivemesh
  • print
  • print_rich
  • print_verbose
  • printerr
  • printraw
  • prints
  • printt
  • prismmesh
  • proceduralskymaterial
  • progressbar
  • projection
  • projectsettings
  • property_hint_array_type
  • property_hint_color_no_alpha
  • property_hint_dir
  • property_hint_enum
  • property_hint_enum_suggestion
  • property_hint_exp_easing
  • property_hint_expression
  • property_hint_file
  • property_hint_flags
  • property_hint_global_dir
  • property_hint_global_file
  • property_hint_global_save_file
  • property_hint_hide_quaternion_edit
  • property_hint_image_compress_lossless
  • property_hint_image_compress_lossy
  • property_hint_int_is_objectid
  • property_hint_int_is_pointer
  • property_hint_layers_2d_navigation
  • property_hint_layers_2d_physics
  • property_hint_layers_2d_render
  • property_hint_layers_3d_navigation
  • property_hint_layers_3d_physics
  • property_hint_layers_3d_render
  • property_hint_link
  • property_hint_locale_id
  • property_hint_localizable_string
  • property_hint_max
  • property_hint_method_of_base_type
  • property_hint_method_of_instance
  • property_hint_method_of_script
  • property_hint_method_of_variant_type
  • property_hint_multiline_text
  • property_hint_node_path_to_edited_node
  • property_hint_node_path_valid_types
  • property_hint_node_type
  • property_hint_none
  • property_hint_object_id
  • property_hint_object_too_big
  • property_hint_password
  • property_hint_placeholder_text
  • property_hint_property_of_base_type
  • property_hint_property_of_instance
  • property_hint_property_of_script
  • property_hint_property_of_variant_type
  • property_hint_range
  • property_hint_resource_type
  • property_hint_save_file
  • property_hint_type_string
  • property_usage_animate_as_trigger
  • property_usage_array
  • property_usage_category
  • property_usage_checkable
  • property_usage_checked
  • property_usage_class_is_bitfield
  • property_usage_class_is_enum
  • property_usage_default
  • property_usage_default_intl
  • property_usage_deferred_set_resource
  • property_usage_do_not_share_on_duplicate
  • property_usage_editor
  • property_usage_editor_basic_setting
  • property_usage_editor_instantiate_object
  • property_usage_group
  • property_usage_high_end_gfx
  • property_usage_internal
  • property_usage_internationalized
  • property_usage_keying_increments
  • property_usage_nil_is_variant
  • property_usage_no_editor
  • property_usage_no_instance_state
  • property_usage_node_path_from_scene_root
  • property_usage_none
  • property_usage_read_only
  • property_usage_resource_not_persistent
  • property_usage_restart_if_changed
  • property_usage_script_default_value
  • property_usage_script_variable
  • property_usage_storage
  • property_usage_store_if_null
  • property_usage_subgroup
  • property_usage_update_all_if_modified
  • propertytweener
  • push_error
  • push_warning
  • quadmesh
  • quadoccluder3d
  • quaternion
  • rad_to_deg
  • rand_from_seed
  • randf
  • randf_range
  • randfn
  • randi
  • randi_range
  • randomize
  • randomnumbergenerator
  • range
  • raycast2d
  • raycast3d
  • rdattachmentformat
  • rdframebufferpass
  • rdpipelinecolorblendstate
  • rdpipelinecolorblendstateattachment
  • rdpipelinedepthstencilstate
  • rdpipelinemultisamplestate
  • rdpipelinerasterizationstate
  • rdpipelinespecializationconstant
  • rdsamplerstate
  • rdshaderfile
  • rdshadersource
  • rdshaderspirv
  • rdtextureformat
  • rdtextureview
  • rduniform
  • rdvertexattribute
  • rect2
  • rect2i
  • rectangleshape2d
  • refcounted
  • referencerect
  • reflectionprobe
  • remap
  • remotetransform2d
  • remotetransform3d
  • renderingdevice
  • renderingserver
  • resource
  • resourceformatloader
  • resourceformatsaver
  • resourceimporter
  • resourceloader
  • resourcepreloader
  • resourcesaver
  • resourceuid
  • return
  • ribbontrailmesh
  • richtexteffect
  • richtextlabel
  • rid
  • rid_allocate_id
  • rid_from_int64
  • rigidbody2d
  • rigidbody3d
  • rootmotionview
  • round
  • roundf
  • roundi
  • scenestate
  • scenetree
  • scenetreetimer
  • script
  • scriptcreatedialog
  • scripteditor
  • scripteditorbase
  • scriptextension
  • scriptlanguage
  • scriptlanguageextension
  • scrollbar
  • scrollcontainer
  • seed
  • segmentshape2d
  • self
  • semaphore
  • separationrayshape2d
  • separationrayshape3d
  • separator
  • shader
  • shaderglobalsoverride
  • shaderinclude
  • shadermaterial
  • shape2d
  • shape3d
  • shapecast2d
  • shapecast3d
  • shortcut
  • side_bottom
  • side_left
  • side_right
  • side_top
  • sign
  • signal
  • signf
  • signi
  • sin
  • sinh
  • skeleton2d
  • skeleton3d
  • skeletonik3d
  • skeletonmodification2d
  • skeletonmodification2dccdik
  • skeletonmodification2dfabrik
  • skeletonmodification2djiggle
  • skeletonmodification2dlookat
  • skeletonmodification2dphysicalbones
  • skeletonmodification2dstackholder
  • skeletonmodification2dtwoboneik
  • skeletonmodification3d
  • skeletonmodification3dccdik
  • skeletonmodification3dfabrik
  • skeletonmodification3djiggle
  • skeletonmodification3dlookat
  • skeletonmodification3dstackholder
  • skeletonmodification3dtwoboneik
  • skeletonmodificationstack2d
  • skeletonmodificationstack3d
  • skeletonprofile
  • skeletonprofilehumanoid
  • skin
  • skinreference
  • sky
  • slider
  • sliderjoint3d
  • smoothstep
  • snapped
  • softbody3d
  • spheremesh
  • sphereoccluder3d
  • sphereshape3d
  • spinbox
  • splitcontainer
  • spotlight3d
  • springarm3d
  • sprite2d
  • sprite3d
  • spritebase3d
  • spriteframes
  • sqrt
  • standardmaterial3d
  • static
  • staticbody2d
  • staticbody3d
  • step_decimals
  • str
  • str_to_var
  • streampeer
  • streampeerbuffer
  • streampeerextension
  • streampeergzip
  • streampeertcp
  • streampeertls
  • string
  • stringname
  • stylebox
  • styleboxempty
  • styleboxflat
  • styleboxline
  • styleboxtexture
  • subviewport
  • subviewportcontainer
  • super
  • surfacetool
  • syntaxhighlighter
  • systemfont
  • tabbar
  • tabcontainer
  • tan
  • tanh
  • tau
  • tcpserver
  • textedit
  • textline
  • textmesh
  • textparagraph
  • textserver
  • textserverdummy
  • textserverextension
  • textservermanager
  • texture
  • texture2d
  • texture2darray
  • texture3d
  • texturebutton
  • texturelayered
  • textureprogressbar
  • texturerect
  • theme
  • themedb
  • thread
  • tiledata
  • tilemap
  • tilemappattern
  • tileset
  • tilesetatlassource
  • tilesetscenescollectionsource
  • tilesetsource
  • time
  • timer
  • torusmesh
  • touchscreenbutton
  • trait
  • transform2d
  • transform3d
  • translation
  • translationserver
  • tree
  • treeitem
  • trianglemesh
  • tubetrailmesh
  • tween
  • tweener
  • type_aabb
  • type_array
  • type_basis
  • type_bool
  • type_callable
  • type_color
  • type_dictionary
  • type_float
  • type_int
  • type_max
  • type_nil
  • type_node_path
  • type_object
  • type_packed_byte_array
  • type_packed_color_array
  • type_packed_float32_array
  • type_packed_float64_array
  • type_packed_int32_array
  • type_packed_int64_array
  • type_packed_string_array
  • type_packed_vector2_array
  • type_packed_vector3_array
  • type_plane
  • type_projection
  • type_quaternion
  • type_rect2
  • type_rect2i
  • type_rid
  • type_signal
  • type_string
  • type_string_name
  • type_transform2d
  • type_transform3d
  • type_vector2
  • type_vector2i
  • type_vector3
  • type_vector3i
  • type_vector4
  • type_vector4i
  • typeof
  • udpserver
  • undoredo
  • var
  • var_to_bytes
  • var_to_bytes_with_objects
  • var_to_str
  • variant
  • vboxcontainer
  • vector2
  • vector2i
  • vector3
  • vector3i
  • vector4
  • vector4i
  • vehiclebody3d
  • vehiclewheel3d
  • vertical
  • vertical_alignment_bottom
  • vertical_alignment_center
  • vertical_alignment_fill
  • vertical_alignment_top
  • vflowcontainer
  • videostream
  • videostreamplayer
  • viewport
  • viewporttexture
  • visibleonscreenenabler2d
  • visibleonscreenenabler3d
  • visibleonscreennotifier2d
  • visibleonscreennotifier3d
  • visualinstance3d
  • visualshader
  • visualshadernode
  • visualshadernodebillboard
  • visualshadernodebooleanconstant
  • visualshadernodebooleanparameter
  • visualshadernodeclamp
  • visualshadernodecolorconstant
  • visualshadernodecolorfunc
  • visualshadernodecolorop
  • visualshadernodecolorparameter
  • visualshadernodecomment
  • visualshadernodecompare
  • visualshadernodeconstant
  • visualshadernodecubemap
  • visualshadernodecubemapparameter
  • visualshadernodecurvetexture
  • visualshadernodecurvexyztexture
  • visualshadernodecustom
  • visualshadernodederivativefunc
  • visualshadernodedeterminant
  • visualshadernodedistancefade
  • visualshadernodedotproduct
  • visualshadernodeexpression
  • visualshadernodefaceforward
  • visualshadernodefloatconstant
  • visualshadernodefloatfunc
  • visualshadernodefloatop
  • visualshadernodefloatparameter
  • visualshadernodefresnel
  • visualshadernodeglobalexpression
  • visualshadernodegroupbase
  • visualshadernodeif
  • visualshadernodeinput
  • visualshadernodeintconstant
  • visualshadernodeintfunc
  • visualshadernodeintop
  • visualshadernodeintparameter
  • visualshadernodeis
  • visualshadernodelinearscenedepth
  • visualshadernodemix
  • visualshadernodemultiplyadd
  • visualshadernodeouterproduct
  • visualshadernodeoutput
  • visualshadernodeparameter
  • visualshadernodeparameterref
  • visualshadernodeparticleaccelerator
  • visualshadernodeparticleboxemitter
  • visualshadernodeparticleconevelocity
  • visualshadernodeparticleemit
  • visualshadernodeparticleemitter
  • visualshadernodeparticlemeshemitter
  • visualshadernodeparticlemultiplybyaxisangle
  • visualshadernodeparticleoutput
  • visualshadernodeparticlerandomness
  • visualshadernodeparticleringemitter
  • visualshadernodeparticlesphereemitter
  • visualshadernodeproximityfade
  • visualshadernoderandomrange
  • visualshadernoderemap
  • visualshadernoderesizablebase
  • visualshadernodesample3d
  • visualshadernodescreenuvtosdf
  • visualshadernodesdfraymarch
  • visualshadernodesdftoscreenuv
  • visualshadernodesmoothstep
  • visualshadernodestep
  • visualshadernodeswitch
  • visualshadernodetexture
  • visualshadernodetexture2darray
  • visualshadernodetexture2darrayparameter
  • visualshadernodetexture2dparameter
  • visualshadernodetexture3d
  • visualshadernodetexture3dparameter
  • visualshadernodetextureparameter
  • visualshadernodetextureparametertriplanar
  • visualshadernodetexturesdf
  • visualshadernodetexturesdfnormal
  • visualshadernodetransformcompose
  • visualshadernodetransformconstant
  • visualshadernodetransformdecompose
  • visualshadernodetransformfunc
  • visualshadernodetransformop
  • visualshadernodetransformparameter
  • visualshadernodetransformvecmult
  • visualshadernodeuvfunc
  • visualshadernodeuvpolarcoord
  • visualshadernodevarying
  • visualshadernodevaryinggetter
  • visualshadernodevaryingsetter
  • visualshadernodevec2constant
  • visualshadernodevec2parameter
  • visualshadernodevec3constant
  • visualshadernodevec3parameter
  • visualshadernodevec4constant
  • visualshadernodevec4parameter
  • visualshadernodevectorbase
  • visualshadernodevectorcompose
  • visualshadernodevectordecompose
  • visualshadernodevectordistance
  • visualshadernodevectorfunc
  • visualshadernodevectorlen
  • visualshadernodevectorop
  • visualshadernodevectorrefract
  • void
  • voxelgi
  • voxelgidata
  • vscrollbar
  • vseparator
  • vslider
  • vsplitcontainer
  • weakref
  • while
  • window
  • workerthreadpool
  • world2d
  • world3d
  • worldboundaryshape2d
  • worldboundaryshape3d
  • worldenvironment
  • wrap
  • wrapf
  • wrapi
  • x509certificate
  • xmlparser
  • xranchor3d
  • xrcamera3d
  • xrcontroller3d
  • xrinterface
  • xrinterfaceextension
  • xrnode3d
  • xrorigin3d
  • xrpose
  • xrpositionaltracker
  • xrserver
  • yield

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ToolingExtension
Authorizations ToolingExtension
UserAgent ToolingExtension
MockServer ToolingExtension

Data Type Feature

Name Supported Defined By
Custom OAS2,OAS3
Int32 OAS2,OAS3
Int64 OAS2,OAS3
Float OAS2,OAS3
Double OAS2,OAS3
Decimal ToolingExtension
String OAS2,OAS3
Byte OAS2,OAS3
Binary OAS2,OAS3
Boolean OAS2,OAS3
Date OAS2,OAS3
DateTime OAS2,OAS3
Password OAS2,OAS3
File OAS2
Uuid
Array OAS2,OAS3
Null OAS3
AnyType OAS2,OAS3
Object OAS2,OAS3
Maps ToolingExtension
CollectionFormat OAS2
CollectionFormatMulti OAS2
Enum OAS2,OAS3
ArrayOfEnum ToolingExtension
ArrayOfModel ToolingExtension
ArrayOfCollectionOfPrimitives ToolingExtension
ArrayOfCollectionOfModel ToolingExtension
ArrayOfCollectionOfEnum ToolingExtension
MapOfEnum ToolingExtension
MapOfModel ToolingExtension
MapOfCollectionOfPrimitives ToolingExtension
MapOfCollectionOfModel ToolingExtension
MapOfCollectionOfEnum ToolingExtension

Documentation Feature

Name Supported Defined By
Readme ToolingExtension
Model ToolingExtension
Api ToolingExtension

Global Feature

Name Supported Defined By
Host OAS2,OAS3
BasePath OAS2,OAS3
Info OAS2,OAS3
Schemes OAS2,OAS3
PartialSchemes OAS2,OAS3
Consumes OAS2
Produces OAS2
ExternalDocumentation OAS2,OAS3
Examples OAS2,OAS3
XMLStructureDefinitions OAS2,OAS3
MultiServer OAS3
ParameterizedServer OAS3
ParameterStyling OAS3
Callbacks OAS3
LinkObjects OAS3

Parameter Feature

Name Supported Defined By
Path OAS2,OAS3
Query OAS2,OAS3
Header OAS2,OAS3
Body OAS2
FormUnencoded OAS2
FormMultipart OAS2
Cookie OAS3

Schema Support Feature

Name Supported Defined By
Simple OAS2,OAS3
Composite OAS2,OAS3
Polymorphism OAS2,OAS3
Union OAS3
allOf OAS2,OAS3
anyOf OAS3
oneOf OAS3
not OAS3

Security Feature

Name Supported Defined By
BasicAuth OAS2,OAS3
ApiKey OAS2,OAS3
OpenIDConnect OAS3
BearerToken OAS3
OAuth2_Implicit OAS2,OAS3
OAuth2_Password OAS2,OAS3
OAuth2_ClientCredentials OAS2,OAS3
OAuth2_AuthorizationCode OAS2,OAS3
SignatureAuth OAS3
AWSV4Signature ToolingExtension

Wire Format Feature

Name Supported Defined By
JSON OAS2,OAS3
XML OAS2,OAS3
PROTOBUF ToolingExtension
Custom OAS2,OAS3