From f6d51cfe2aa4c1a1f48dab665cc3bebee178e383 Mon Sep 17 00:00:00 2001
From: Matthieu De Beule <matthieu.de@beule.be>
Date: Tue, 12 Nov 2019 14:46:43 +0100
Subject: Fix Ruby and Python REST API examples
The previous examples where wrong, since they used a POST request.
I used the requests library for Python, since that is what most people
would want to use.
I removed the http.verify_mode in the Ruby example since I don't think
it is good practice to tell people to not verify HTTPS requests
---
support/doc/api/openapi.yaml | 30 ++++++++++--------------------
1 file changed, 10 insertions(+), 20 deletions(-)
(limited to 'support/doc/api')
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a13627a78..032d798fc 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -160,35 +160,25 @@ paths:
http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
- lang: Ruby
source: |
- require 'uri'
require 'net/http'
+ require 'json'
- url = URI("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
+ uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
- http = Net::HTTP.new(url.host, url.port)
+ http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
- http.verify_mode = OpenSSL::SSL::VERIFY_NONE
- request = Net::HTTP::Post.new(url)
- request["content-type"] = 'application/json'
- response = http.request(request)
- puts response.read_body
+ response = http.get(uri.request_uri)
+
+ puts JSON.parse(response.read_body)
- lang: Python
source: |
- import http.client
-
- conn = http.client.HTTPSConnection("https://peertube2.cpy.re/api/v1")
-
- headers = {
- 'content-type': "application/json"
- }
-
- conn.request("POST", "/accounts/{name}/videos", None, headers)
+ import requests
- res = conn.getresponse()
- data = res.read()
+ r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
+ json = r.json()
- print(data.decode("utf-8"))
+ print(json)
/accounts:
get:
tags:
--
cgit v1.2.3