gdscript.README.handlebars Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
The newest version!
# {{{openAPI.info.title}}} GDScript Client

{{#if appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/if}}

This *Godot 4* addon was automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

{{#if servers}}
− Servers:
{{#each servers}}
    - [{{#if this.description}}{{this.description}}{{else}}{{this.url}}{{/if}}]({{this.url}})
{{/each}}
{{/if}}
- API version: {{appVersion}}
{{#unless hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/unless}}
- Build package: {{generatorClass}}
{{#if infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}).
{{/if}}


## Requirements.

Godot `4.x`.


## Installation & Usage

Copy the files into the `addon` directory of your Godot project.

Then, enable the addon in your project settings.

You can now use it anywhere in your code:

{{#with apiInfo}}
{{#each apis}}
{{#if @first}}
{{#with operations}}
{{#each operation}}
{{#if @first}}
{{>api_doc_example}}
{{/if}}
{{/each}}
{{/with}}
{{/if}}
{{/each}}
{{/with}}


## Customization

You can [override the templates](https://openapi-generator.tech/docs/templating/).

> 1. Grab templates with `openapi-generator author template -g gdscript --library gdscript`
> 2. Hack around
> 3. Regenerate using `--template ` to target your custom templates dir


## Documentation for API Endpoints

All URIs are relative to *{{basePath}}*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
{{#with apiInfo}}
{{#each apis}}
{{#with operations}}
{{#each operation}}*{{classname}}* | [**{{operationIdSnakeCase}}**]({{apiDocPath}}{{classname}}.md#{{operationIdSnakeCase}}) | **{{httpMethod}}** {{path}} | {{#if summary}}{{summary}}{{/if}}
{{/each}}
{{/with}}
{{/each}}
{{/with}}


## Documentation For Models

{{#each models}}
{{#with model}}
- [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
{{/with}}
{{/each}}


## Documentation For Authorization

{{#unless authMethods}}
 All endpoints do not require authorization.
{{/unless}}
{{#each authMethods}}
{{#if @last}} Authentication schemes defined for the API:{{/if}}
## {{{name}}}

{{#if isApiKey}}
- **Type**: API key
- **API key parameter name**: {{{keyParamName}}}
- **Location**: {{#if isKeyInQuery}}URL query string{{/if}}{{#if isKeyInHeader}}HTTP header{{/if}}
{{/if}}
{{#if isBasic}}
{{#if isBasicBasic}}
- **Type**: HTTP basic authentication
{{/if}}
{{#if isBasicBearer}}
- **Type**: Bearer authentication{{#if bearerFormat}} ({{{bearerFormat}}}){{/if}}
{{/if}}
{{#if isHttpSignature}}
- **Type**: HTTP signature authentication
{{/if}}
{{/if}}
{{#if isOAuth}}
- **Type**: OAuth
- **Flow**: {{{flow}}}
- **Authorization URL**: {{{authorizationUrl}}}
- **Scopes**: {{#unless scopes}}N/A{{/unless}}
{{#each scopes}}  - **{{{scope}}}**: {{#if description}}{{{description}}}{{/if}}
{{/each}}
{{/if}}

{{/each}}


## Troubleshooting

### `TLS handshake error: -9984`

https://github.com/godotengine/godot/issues/59080#issuecomment-1065973210