1 # Kotlin API client for {{appName}}
16 First, create the gradle wrapper script:
26 ./gradlew check assemble
29 This runs all tests and packages the library.
31 ## Features/Implementation Notes
34 <a name="documentation-for-api-endpoints"></a>
35 ## Documentation for API Endpoints
37 All URIs are relative to *{{{basePath}}}*. Change it when instanciating `ApiClient(basePath)`.
39 Class | Method | HTTP request | Description
40 ------------ | ------------- | ------------- | -------------
41 {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
42 {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
45 {{#generateModelDocs}}
46 <a name="documentation-for-models"></a>
47 ## Documentation for Models
50 {{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
54 No model defined in this package
56 {{/generateModelDocs}}
58 <a name="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
59 ## Documentation for Authorization
62 All endpoints do not require authorization.
66 Authentication schemes defined for the API:
70 <a name="{{name}}"></a>
73 {{#isApiKey}}- **Type**: API key
74 - **API key parameter name**: {{keyParamName}}
75 - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
77 {{#isBasic}}- **Type**: HTTP basic authentication
79 {{#isOAuth}}- **Type**: OAuth
81 - **Authorization URL**: {{authorizationUrl}}
82 - **Scopes**: {{^scopes}}N/A{{/scopes}}
83 {{#scopes}} - {{scope}}: {{description}}
91 Copyright (C) 2015-2020 PeerTube Contributors
93 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
95 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
97 You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses.