aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/requester.pod620
-rw-r--r--docs/responses.pod632
-rw-r--r--docs/x-matrix-response.pod64
3 files changed, 26 insertions, 30 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>.
diff --git a/docs/responses.pod6 b/docs/responses.pod6
index 59d59b1..7515d39 100644
--- a/docs/responses.pod6
+++ b/docs/responses.pod6
@@ -6,8 +6,8 @@
=head1 Event
-=for code
-class Matrix::Response::Event { }
+
+ class Matrix::Response::Event { }
Common contents of a response.
@@ -18,8 +18,8 @@ Common contents of a response.
=head1 RoomEvent
-=for code
-class Matrix::Response::RoomEvent is Matrix::Response::Event { }
+
+ class Matrix::Response::RoomEvent is Matrix::Response::Event { }
A single event for a room
@@ -53,8 +53,8 @@ returns the room_id
=head1 StateEvent
-=for code
-class Matrix::Response::StateEvent is Matrix::Response::RoomEvent { }
+
+ class Matrix::Response::StateEvent is Matrix::Response::RoomEvent { }
=head2 Mapped keys
@@ -63,8 +63,8 @@ class Matrix::Response::StateEvent is Matrix::Response::RoomEvent { }
=head1 Timeline
-=for code
-class Matrix::Response::Timeline { }
+
+ class Matrix::Response::Timeline { }
=head2 Mapped keys
@@ -75,8 +75,8 @@ class Matrix::Response::Timeline { }
=head1 RoomInfo
-=for code
-class Matrix::Response::RoomInfo { }
+
+ class Matrix::Response::RoomInfo { }
=head2 Mapped keys
@@ -86,8 +86,8 @@ class Matrix::Response::RoomInfo { }
=head1 InviteInfo
-=for code
-class Matrix::Response::InviteInfo { }
+
+ class Matrix::Response::InviteInfo { }
=head2 Mapped keys
@@ -96,8 +96,8 @@ class Matrix::Response::InviteInfo { }
=head1 Sync
-=for code
-class Matrix::Response::Sync { }
+
+ class Matrix::Response::Sync { }
=head2 Mapped keys
@@ -109,8 +109,8 @@ class Matrix::Response::Sync { }
=head1 Presence
-=for code
-class Matrix::Response::Presence { }
+
+ class Matrix::Response::Presence { }
=head2 Mapped keys
diff --git a/docs/x-matrix-response.pod6 b/docs/x-matrix-response.pod6
index 18515db..d93c263 100644
--- a/docs/x-matrix-response.pod6
+++ b/docs/x-matrix-response.pod6
@@ -4,8 +4,8 @@
=SUBTITLE Error querying the matrix server
-=for code
-class X::Matrix::Response is Exception {}
+
+ class X::Matrix::Response is Exception {}
Error class when the matrix server returns an error code (4XX).