# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================

from django.urls import path
from application.example import views

"""
案例模块路由配置
=============================================================

URL端点概览：
------------------------------------------------------------------------
| 功能说明         | 请求方法 | URL路径                     | 视图类                  |
|-----------------|----------|-----------------------------|-------------------------|
| 分页查询        | GET      | /example/page        | ExamplePageView    |
| 列表查询        | GET      | /example/list        | ExampleListView    |
| 详情查询        | GET      | /example/detail/<id> | ExampleDetailView  |
| 添加案例        | POST     | /example/add         | ExampleAddView     |
| 更新案例        | PUT      | /example/update      | ExampleUpdateView  |
| 删除案例        | DELETE   | /example/delete/<ids>| ExampleDeleteView  |
| 设置状态        | PUT      | /example/status      | ExampleStatusView  |
| 获取列表        | GET      | /example/data        | ExampleDataView |
------------------------------------------------------------------------

URL参数说明：
- id: int类型，案例ID（用于查询详情）
- id: str类型，逗号分隔的案例ID字符串（用于批量删除）

使用示例：
1. 分页查询：GET /api/example/page?pageNo=1&pageSize=10
2. 列表查询：GET /api/example/list
3. 详情查询：GET /api/example/detail/5
4. 添加案例：POST /api/example/add
5. 更新案例：PUT /api/example/update
6. 删除案例：DELETE /api/example/delete/1,2,3
7. 设置状态：PUT /api/example/status
8. 获取列表：GET /api/example/data
"""

# 案例模块路由配置
urlpatterns = [
    # 查询案例分页列表
    # URL: /example/page
    # 请求方法: GET
    # 功能: 获取案例分页数据，支持按案例名称、案例类型：1-类型1 2-类型2 3-类型3 4-类型4、案例状态：1-正常 2-禁用等条件筛选
    path('page', views.ExamplePageView.as_view()),

    # 查询案例数据列表（支持筛选）
    # URL: /example/list
    # 请求方法: GET
    # 功能: 获取所有案例的列表数据，支持按条件筛选，用于下拉选择等前端组件
    path('list', views.ExampleListView.as_view()),

    # 查询案例详情
    # URL: /example/detail/<int:id>
    # 请求方法: GET
    # URL参数: id - 案例ID（整数类型）
    # 功能: 根据ID获取指定案例的详细信息
    path('detail/<int:id>', views.ExampleDetailView.as_view()),

    # 添加案例
    # URL: /example/add
    # 请求方法: POST
    # 功能: 创建新的案例记录，请求体需包含案例信息（name、avatar、type、status、sort等）
    path('add', views.ExampleAddView.as_view()),

    # 更新案例
    # URL: /example/update
    # 请求方法: PUT
    # 功能: 更新现有案例信息，请求体需包含案例ID和更新内容
    path('update', views.ExampleUpdateView.as_view()),

    # 删除案例
    # URL: /example/delete/<str:id>
    # 请求方法: DELETE
    # URL参数: id - 案例ID字符串，支持单个ID或逗号分隔的多个ID（如 "1,2,3"）
    # 功能: 删除指定案例（逻辑删除，设置is_delete=True）
    path('delete/<str:id>', views.ExampleDeleteView.as_view()),

    # 设置案例状态
    # URL: /example/status
    # 请求方法: PUT
    # 功能: 更新案例的启用/禁用状态
    path('status', views.ExampleStatusView.as_view()),

    # 查询案例数据列表
    # URL: /example/list
    # 请求方法: GET
    # 功能: 获取所有启用案例的列表数据，用于下拉选择等前端组件
    path('list', views.ExampleDataView.as_view()),
]