Commit 346b6304 authored by Rigel Kent's avatar Rigel Kent
Browse files

Minor update kotlin

parent 0d970f44
......@@ -155,7 +155,7 @@ Configure OAuth2:
<a name="usersGet"></a>
# **usersGet**
> kotlin.Array&lt;User&gt; usersGet(start, count, sort)
> kotlin.Array&lt;User&gt; usersGet(search, blocked, start, count, sort)
List users
......@@ -166,11 +166,13 @@ List users
//import org.peertube.client.models.*
val apiInstance = UsersApi()
val search : kotlin.String = search_example // kotlin.String | Plain text search that will match with user usernames or emails
val blocked : kotlin.Boolean = true // kotlin.Boolean | Filter results down to (un)banned users
val start : kotlin.Int = 56 // kotlin.Int | Offset used to paginate results
val count : kotlin.Int = 56 // kotlin.Int | Number of items to return
val sort : kotlin.String = sort_example // kotlin.String | Sort users by criteria
try {
val result : kotlin.Array<User> = apiInstance.usersGet(start, count, sort)
val result : kotlin.Array<User> = apiInstance.usersGet(search, blocked, start, count, sort)
println(result)
} catch (e: ClientException) {
println("4xx response calling UsersApi#usersGet")
......@@ -185,6 +187,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | **kotlin.String**| Plain text search that will match with user usernames or emails | [optional]
**blocked** | **kotlin.Boolean**| Filter results down to (un)banned users | [optional]
**start** | **kotlin.Int**| Offset used to paginate results | [optional]
**count** | **kotlin.Int**| Number of items to return | [optional] [default to 15]
**sort** | **kotlin.String**| Sort users by criteria | [optional] [enum: -id, -username, -createdAt]
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......@@ -162,6 +162,8 @@ class UsersApi(basePath: kotlin.String = defaultBasePath) : ApiClient(basePath)
/**
* List users
*
* @param search Plain text search that will match with user usernames or emails (optional)
* @param blocked Filter results down to (un)banned users (optional)
* @param start Offset used to paginate results (optional)
* @param count Number of items to return (optional, default to 15)
* @param sort Sort users by criteria (optional)
......@@ -172,10 +174,16 @@ class UsersApi(basePath: kotlin.String = defaultBasePath) : ApiClient(basePath)
*/
@Suppress("UNCHECKED_CAST")
@Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
fun usersGet(start: kotlin.Int?, count: kotlin.Int?, sort: kotlin.String?) : kotlin.Array<User> {
fun usersGet(search: kotlin.String?, blocked: kotlin.Boolean?, start: kotlin.Int?, count: kotlin.Int?, sort: kotlin.String?) : kotlin.Array<User> {
val localVariableBody: kotlin.Any? = null
val localVariableQuery: MultiValueMap = mutableMapOf<kotlin.String, List<kotlin.String>>()
.apply {
if (search != null) {
put("search", listOf(search.toString()))
}
if (blocked != null) {
put("blocked", listOf(blocked.toString()))
}
if (start != null) {
put("start", listOf(start.toString()))
}
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
......@@ -2,7 +2,7 @@
* PeerTube
* # Introduction The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API. # Authentication When you sign up for an account, you are given the possibility to generate sessions, and authenticate using this session token. One session token can currently be used at a time. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format. ``` { \"code\": \"unauthorized_request\", // example inner error code \"error\": \"Token is invalid.\" // example exposed error message } ```
*
* The version of the OpenAPI document: 2.2.0
* The version of the OpenAPI document: 2.3.0-rc.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment