|
|
@@ -1,12 +1,12 @@
|
|
|
|
|
|
-Sami Markdown Extension
|
|
|
+Gogs PHP API Client
|
|
|
===
|
|
|
|
|
|
# Table of content
|
|
|
1. [Gogs](#gogs "Gogs")
|
|
|
1. [API](#gogsapi "Gogs\API")
|
|
|
1. [Request](#gogsapirequest "Gogs\API\Request")
|
|
|
- 1. [Base](#base-gogsapirequest "Gogs\API\Request\Base") `@deprecated` Base class for request types.
|
|
|
+ 1. [Base](#base-gogsapirequest "Gogs\API\Request\Base") Base class for request types.
|
|
|
2. [Collection](#collection-gogsapirequest "Gogs\API\Request\Collection") Collection is a collection of data of one type.
|
|
|
3. [Exception](#gogsapirequestexception "Gogs\API\Request\Exception")
|
|
|
1. [InvalidMethodRequestException](#invalidmethodrequestexception-gogsapirequestexception "Gogs\API\Request\Exception\InvalidMethodRequestException") Thrown whenever a class that inherits the base-classis used wrong (e.g tries to create on a loaded object)
|
|
|
@@ -20,7 +20,7 @@ Sami Markdown Extension
|
|
|
8. [RequestInterface](#requestinterface-gogsapirequest "Gogs\API\Request\RequestInterface") Request interface, used by any kind of request object.
|
|
|
9. [User](#user-gogsapirequest "Gogs\API\Request\User") Stores user data and methods related to a single user.
|
|
|
10. [Users](#users-gogsapirequest "Gogs\API\Request\Users") Returns one or more users in the Gogs installation,depending on the called method.
|
|
|
- 2. [Client](#client-gogsapi "Gogs\API\Client") `@deprecated` Gogs API client.
|
|
|
+ 2. [Client](#client-gogsapi "Gogs\API\Client") Gogs API client.
|
|
|
2. [Lib](#gogslib "Gogs\Lib")
|
|
|
1. [Curl](#gogslibcurl "Gogs\Lib\Curl")
|
|
|
1. [Client](#client-gogslibcurl "Gogs\Lib\Curl\Client") A trait used for every class referencing the api-url and token.
|
|
|
@@ -51,7 +51,6 @@ Documentation
|
|
|
### Client `Gogs\API`
|
|
|
|
|
|
|
|
|
-* `@deprecated`:
|
|
|
* Class uses [Gogs\Lib\Curl\Client](#client-gogslibcurl)
|
|
|
|
|
|
Gogs API client.
|
|
|
@@ -140,7 +139,6 @@ Returns: [Repos](#repos-gogsapirequest)
|
|
|
### Base `Gogs\API\Request`
|
|
|
|
|
|
|
|
|
-* `@deprecated`: since 0.1, to be removed in 3.0
|
|
|
* Class implements[Gogs\API\Request\RequestInterface](#requestinterface-gogsapirequest)
|
|
|
* Class uses [Gogs\Lib\Curl\Client](#client-gogslibcurl)
|
|
|
|
