#2212 two fixes to our api documentation
Merged 2 months ago by praiskup. Opened 2 months ago by msuchy.
copr/ msuchy/copr apidoc  into  main

@@ -1,7 +1,7 @@ 

  Data structures

  ===============

  

- A data returned from successful API calls are transformed and presented to you as a Munch (it is a subclass of a

+ A data returned from successful API calls are transformed and presented to you as a [Munch](https://github.com/Infinidat/munch) (it is a subclass of a

  ``dict`` with all its features, with an additional support of accessing its attributes like object properties, etc).

  This page shows how to work with the results, how to access the original responses from frontend and what are the

  specifics for lists of results.
@@ -17,7 +17,7 @@ 

      pprint(build)

  

  

- As advertised, the data is represented as a Munch.

+ As advertised, the data is represented as a [Munch](https://github.com/Infinidat/munch).

  

  ::

  

@@ -1,7 +1,7 @@ 

  Error handling

  ==============

  

- All methods from proxy classes return Munch with data only when the API call succeeds. Otherwise, an exception is raised.

+ All methods from proxy classes return [Munch](https://github.com/Infinidat/munch) with data only when the API call succeeds. Otherwise, an exception is raised.

  

  This example code tries to cancel a build. Such thing is possible only when the build is not already finished.

  
@@ -35,7 +35,7 @@ 

  ---------

  

  Sometimes it is useful to dig deeper and examine the failure. Exceptions contain a ``result`` attribute

- returning a Munch with additional information.

+ returning a [Munch](https://github.com/Infinidat/munch) with additional information.

  

  ::

  

@@ -48,7 +48,7 @@ 

  

  .. code-block:: python

  

-     from copr.v3 import next_page

+     from copr.v3.pagination import next_page

  

      package_page = client.package_proxy.get_list("@copr", "copr", pagination={"limit": 3})

      while package_page: