Changeset View
Changeset View
Standalone View
Standalone View
docs/faq/index.rst
Show First 20 Lines • Show All 199 Lines • ▼ Show 20 Lines | |||||
How do I generate API usage credentials? | How do I generate API usage credentials? | ||||
---------------------------------------- | ---------------------------------------- | ||||
See the :ref:`Authentication guide <swh-web-client-auth>`. | See the :ref:`Authentication guide <swh-web-client-auth>`. | ||||
Is there a page where I can see all the API endpoints? | Is there a page where I can see all the API endpoints? | ||||
------------------------------------------------------ | ------------------------------------------------------ | ||||
See the `API endpoint listing page <API>`_. | See the `API endpoint listing page`_. | ||||
What are the usage limits for SWH APIs? | What are the usage limits for SWH APIs? | ||||
--------------------------------------- | --------------------------------------- | ||||
Maximum number of permitted requests per hour: | Maximum number of permitted requests per hour: | ||||
* 120 for anonymous users | * 120 for anonymous users | ||||
* 1200 for authenticated users | * 1200 for authenticated users | ||||
It's described in the `rate limit documentation page <API-rate-limit>`_. | It's described in the `rate limit documentation page`_. | ||||
.. It's temporarily here but it should be moved into its own sphinx instance at some | .. It's temporarily here but it should be moved into its own sphinx instance at some | ||||
point in the future. | point in the future. | ||||
.. _faq_sysadm: | .. _faq_sysadm: | ||||
System Administration | System Administration | ||||
===================== | ===================== | ||||
Show All 13 Lines | |||||
tagged. The tag is pushed. This triggers a packaging build process. When the package is | tagged. The tag is pushed. This triggers a packaging build process. When the package is | ||||
ready, depending on the module [1], sysadms deploy the package with the help of puppet. | ready, depending on the module [1], sysadms deploy the package with the help of puppet. | ||||
[1] swh-web module is mostly automatic. Other modules are not yet automatic as some | [1] swh-web module is mostly automatic. Other modules are not yet automatic as some | ||||
internal state migration (dbs) often enters the release cycle and due to the data | internal state migration (dbs) often enters the release cycle and due to the data | ||||
volume, that may need human intervention. | volume, that may need human intervention. | ||||
.. _API: https://archive.softwareheritage.org/api/1/ | .. _API endpoint listing page: https://archive.softwareheritage.org/api/1/ | ||||
.. _API-rate-limit: https://archive.softwareheritage.org/api/#rate-limiting | .. _rate limit documentation page: https://archive.softwareheritage.org/api/#rate-limiting | ||||
.. _bug tracking system: https://forge.softwareheritage.org/ | .. _bug tracking system: https://forge.softwareheritage.org/ | ||||
.. _contact form: https://www.softwareheritage.org/contact/ | .. _contact form: https://www.softwareheritage.org/contact/ | ||||
.. _contact us: https://www.softwareheritage.org/contact/ | .. _contact us: https://www.softwareheritage.org/contact/ | ||||
.. _development channels: https://www.softwareheritage.org/community/developers/ | .. _development channels: https://www.softwareheritage.org/community/developers/ | ||||
.. _internships: https://wiki.softwareheritage.org/wiki/Internships | .. _internships: https://wiki.softwareheritage.org/wiki/Internships |