import type { RuntimeTranslator } from '@/i18n/runtime'; import { type PolicySection } from './types'; import { CodeBlock } from '@/components/ui/code-block'; import { DocsTable, DocsTableBody, DocsTableCell, DocsTableHead, DocsTableHeader, DocsTableRow, } from '@/components/ui/docs-table'; export const DOCS_LAST_UPDATED = '2026-06-07'; /** * ------------------------------------------------------------------ * API 文档 * ------------------------------------------------------------------ */ export function createApiSections(rt: RuntimeTranslator): PolicySection[] { return [ { value: 'api-specs', title: rt('1_api_conventions_and_authentication_e6d4df61'), content: (
{rt( 'standard_api_request_conventions_and_developer_access_39eb956e', )}
{rt('all_api_endpoints_use_a_standard_json_87c92fb0')}
{rt('successful_response_example_8917e853')}
{rt('failed_response_example_eae899e1')}
{rt( 'protected_endpoints_require_credentials_except_public_endpoints_1fa0a24c', )}
{rt('use_either_of_the_following_request_headers_1e03b04b')}
Authorization: Bearer at_xxx
X-Access-Token: at_xxx
{rt('endpoint_79a2369a')} POST{' '}
/api/v1/user/register
{rt('description_3e633a20')}{' '} {rt('register_a_local_account_when_registration_is_938891dc')}
{rt('endpoint_79a2369a')} POST{' '}
/api/v1/user/login
{rt('description_3e633a20')}{' '} {rt( 'authenticate_with_a_username_and_password_establishing_a38ff252', )}
{rt('endpoint_79a2369a')} GET{' '}
/api/v1/user/logout
{rt('description_3e633a20')}{' '} {rt('delete_the_current_session_cookie_and_sign_c213ffd9')}
{rt('endpoint_79a2369a')} GET{' '}
/api/v1/user/self
{rt('description_3e633a20')}{' '} {rt('get_the_signed_in_account_s_basic_b0eb8cfa')}
{rt('access_token_management_requires_a_session_login_42d91543')}
{rt('endpoint_79a2369a')} GET{' '}
/api/v1/user/access-tokens
{rt('description_3e633a20')}{' '} {rt('list_the_current_user_s_tokens_with_c34d2210')}
{rt('endpoint_79a2369a')} POST{' '}
/api/v1/user/access-tokens
{rt('parameters_ba89685c')} {rt('ui_jsonBody')}{' '}
{rt.raw('name_token_name_is_admin_false_4f3e4868')}
{rt('description_3e633a20')}{' '} {rt('generate_an_access_token_the_response_includes_70552390')}
is_admin
{rt('optional_default_210b9d8f')}{' '}
false
{rt('grant_administrator_privileges_to_the_token_only_2292cad8')}{' '}
/admin/**{' '}
{rt('endpoints_815c88e5')}
{rt('successful_response_example_7783a39c')}
{rt('endpoint_79a2369a')} DELETE{' '}
/api/v1/user/access-tokens/:id
{rt('description_3e633a20')}{' '} {rt('permanently_delete_a_token_by_id_immediately_145287f6')}
{rt('endpoint_79a2369a')} POST{' '}
/api/v1/user/access-tokens/:id/rotate
{rt('description_3e633a20')}{' '} {rt('replace_a_token_s_secret_and_return_d2caca89')}
{rt('endpoint_79a2369a')} GET{' '}
/api/v1/config/public
{rt('description_3e633a20')}{' '} {rt('get_publicly_visible_configuration_keys_and_values_bc7bff66')}
{rt('response_example_d3087445')}
{rt('description_3e633a20')}{' '} {rt( 'manage_system_configs_dynamically_through_an_administrator_acdcdb99', )}
/api/v1/admin/system-configs?type=system
/api/v1/admin/system-configs
/api/v1/admin/system-configs/:key
/api/v1/admin/system-configs/:key