Fix Ruby and Python REST API examples
authorMatthieu De Beule <matthieu.de@beule.be>
Tue, 12 Nov 2019 13:46:43 +0000 (14:46 +0100)
committerMatthieu De Beule <matthieu.de@beule.be>
Tue, 12 Nov 2019 13:46:43 +0000 (14:46 +0100)
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

index a13627a78dcdeea2db1f4143985bc5011324ae77..032d798fc42cea6288147183b18adeac356e7368 100644 (file)
@@ -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: