aboutsummaryrefslogtreecommitdiff
path: root/docs/requester.pod6
diff options
context:
space:
mode:
authorMatias Linares <matiaslina@gmail.com>2019-01-06 21:07:03 -0300
committerMatias Linares <matiaslina@gmail.com>2019-01-06 21:07:03 -0300
commit2d54d1357deacf23c53bde9b521d464fc2fcb15e (patch)
tree513fc1ca27e6b57a5b5b013a86a40b4dc1c5d1f0 /docs/requester.pod6
parent9e392def5355bdec60b17f7a3c86a6928e94a453 (diff)
downloadperl6-matrix-client-2d54d1357deacf23c53bde9b521d464fc2fcb15e.tar.gz
Update pods for doc generation
Diffstat (limited to 'docs/requester.pod6')
-rw-r--r--docs/requester.pod620
1 files changed, 8 insertions, 12 deletions
diff --git a/docs/requester.pod6 b/docs/requester.pod6
index 21e0f33..6710948 100644
--- a/docs/requester.pod6
+++ b/docs/requester.pod6
@@ -4,8 +4,8 @@
=SUBTITLE Role for HTTP requests
-=for code
-role Matrix::Requester { }
+
+ role Matrix::Client::Requester { }
Role that gives the base API for objects that interacts to the matrix server. The
attributes that can be set can be:
@@ -28,8 +28,7 @@ Prefix to all the paths used in the methods.
=head2 get
-=for code
-method get(Str $path, :$media = False, *%data)
+ method get(Str $path, :$media = False, *%data)
Do a GET to C<$path>.
@@ -37,23 +36,21 @@ All the C<*%data> is used to build the query params for the url.
=head2 post
-=for code
-multi method post(Str $path, Str $params, :$media = False)
-multi method post(Str $path, :$media = False, *%params)
+ multi method post(Str $path, Str $params, :$media = False)
+ multi method post(Str $path, :$media = False, *%params)
Do a POST to C<$path> with C<$params> as JSON body. With the
named C<*%params>, those are parameters are converted into JSON.
=head2 post-bin
-=for code
-method post-bin(Str $path, Buf $buf, :$content-type)
+ method post-bin(Str $path, Buf $buf, :$content-type)
Do a POST to C<$path> with binary data in the body.
=head2 put
-=for code
+
multi method put(Str $path, Str $params)
multi method put(Str $path, *%params)
@@ -62,8 +59,7 @@ C<*%params>, those parameters are converted into JSON.
=head2 delete
-=for code
-method delete(Str $path)
+ method delete(Str $path)
Do a DELETE to C<$path>.