..
    Copyright 2017-2023 - Swiss Data Science Center (SDSC)
    A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
    Eidgenössische Technische Hochschule Zürich (ETHZ).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

Renku Core Service Errors
=========================

Here is a list of the possible service errors, including the reference code, the
user and developer messages, and a longer description of the error.

Errors are split in 3 major categories.


User generated errors
---------------------

*Error codes: from 1000 to 1999*

This category includes all the errors generated by user input. There is no unexpected
error nor bug here. The user should be able to address these issues.
An example could be a wrong parameter (E.G. trying to access a non-existing repository,
or a private repository without proper permissions).


Programming errors
------------------

*Error codes: from 2000 to 2999*

The programming errors are bugs or unexpected cases. In the first case, they should lead
to creating a new GitHub issue; in the latter, it may be necessary to handle the specific
error to provide the user a precise explanation.


Intermittent errors
-------------------

*Error codes: from 3000 to 3999*

This category includes errors that may temporarily affect the user, but they don't
necessarily depend on a wrong input nor can they be classified as a bug. Repeating the same
action after some time may be enough to solve the problem.
An example could be a temporarily unavailable backend service (E.G. the GitLab instance)
or a transient network problem.


List of available errors
------------------------

.. automodule:: renku.ui.service.errors
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource