openapi: 3.0.3
info:
  title: Alibaba Sentinel Dashboard Authority Rules Degrade Rules API
  description: REST API for the Sentinel Dashboard providing management of flow rules, degrade rules, system rules, and authority rules for resources.
  version: 1.8.0
  contact:
    name: Alibaba Sentinel
    url: https://github.com/alibaba/Sentinel
servers:
- url: http://localhost:8080
  description: Default Sentinel Dashboard
tags:
- name: Degrade Rules
paths:
  /v1/degrade/rules:
    get:
      operationId: getDegradeRules
      summary: Get degrade (circuit breaker) rules
      tags:
      - Degrade Rules
      parameters:
      - name: app
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of degrade rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
  /v1/degrade/rule:
    post:
      operationId: createDegradeRule
      summary: Create a degrade rule
      tags:
      - Degrade Rules
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DegradeRuleRequest'
      responses:
        '200':
          description: Degrade rule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
    delete:
      operationId: deleteDegradeRule
      summary: Delete a degrade rule
      tags:
      - Degrade Rules
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: integer
      - name: app
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Degrade rule deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResult'
components:
  schemas:
    ApiResult:
      type: object
      properties:
        code:
          type: integer
          description: Response code (200 for success)
        msg:
          type: string
          description: Response message
        data:
          description: Response data payload
    DegradeRuleRequest:
      type: object
      required:
      - app
      - resource
      - count
      - grade
      - timeWindow
      properties:
        id:
          type: integer
        app:
          type: string
        resource:
          type: string
        limitApp:
          type: string
          default: default
        grade:
          type: integer
          enum:
          - 0
          - 1
          - 2
        count:
          type: number
        timeWindow:
          type: integer
        minRequestAmount:
          type: integer
          default: 5
        statIntervalMs:
          type: integer
          default: 1000