mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-09-14 11:06:13 +05:00
f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Build Debian package / build (amd64) (push) Waiting to run
Build Debian package / build (arm64) (push) Waiting to run
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Build Debian package / release (push) Blocked by required conditions
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Run linters / lint (push) Waiting to run
Build Pip package / build (push) Waiting to run
Release State / release-state (push) Waiting to run
Parallel Tests / Discover test files (push) Waiting to run
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Run tests / docker_tests (push) Waiting to run
Clean rebuild of docs/apidocs/archivebox/ via autodoc2: - Removes 19 stale module pages whose source files no longer exist (cli_utils, host_utils, schedule_utils — renamed to *_util; actors, ideas, debugging, folders, legacy, progress_layout, tests_piping, config_tags, personas.runtime/views, orchestrator*, worker, tasks). - Adds 29 new module pages for code that was added since the previous generation but not yet documented. - Updates 100 existing pages to reflect API surface changes (e.g. ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed, default bumped to 50, etc.). 156 source modules <-> 156 apidoc files (zero drift). Build clean under sphinx-build -W --keep-going. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3.0 KiB
3.0 KiB
{py:mod}archivebox.api.v1_auth
:allowtitles:
Module Contents
Classes
:class: autosummary longtable
:align: left
* - {py:obj}`PasswordAuthSchema <archivebox.api.v1_auth.PasswordAuthSchema>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema
:summary:
```
* - {py:obj}`TokenAuthSchema <archivebox.api.v1_auth.TokenAuthSchema>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema
:summary:
```
Functions
:class: autosummary longtable
:align: left
* - {py:obj}`get_api_token <archivebox.api.v1_auth.get_api_token>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.get_api_token
:summary:
```
* - {py:obj}`check_api_token <archivebox.api.v1_auth.check_api_token>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.check_api_token
:summary:
```
Data
:class: autosummary longtable
:align: left
* - {py:obj}`router <archivebox.api.v1_auth.router>`
- ```{autodoc2-docstring} archivebox.api.v1_auth.router
:summary:
```
API
:canonical: archivebox.api.v1_auth.router
:value: >
'Router(...)'
```{autodoc2-docstring} archivebox.api.v1_auth.router
```
:canonical: archivebox.api.v1_auth.PasswordAuthSchema
Bases: {py:obj}`ninja.Schema`
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.__init__
```
````{py:attribute} username
:canonical: archivebox.api.v1_auth.PasswordAuthSchema.username
:type: str | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.username
```
````
````{py:attribute} password
:canonical: archivebox.api.v1_auth.PasswordAuthSchema.password
:type: str | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.PasswordAuthSchema.password
```
````
:canonical: archivebox.api.v1_auth.get_api_token
```{autodoc2-docstring} archivebox.api.v1_auth.get_api_token
```
:canonical: archivebox.api.v1_auth.TokenAuthSchema
Bases: {py:obj}`ninja.Schema`
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema.__init__
```
````{py:attribute} token
:canonical: archivebox.api.v1_auth.TokenAuthSchema.token
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_auth.TokenAuthSchema.token
```
````
:canonical: archivebox.api.v1_auth.check_api_token
```{autodoc2-docstring} archivebox.api.v1_auth.check_api_token
```