blockadeio.yaml

openapi: 3.0.1

info:
    title: Blockade.io
    description: Block suspicious and malicious indicators in participating browsers
    version: "v1"

servers:
    - url: https://api.blockade.io/

paths:
    /get-indicators:
        get:
            operationId: blockadeIoGetIndicators
            summary: Get indicators from blockade.io
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/blockadeIoGetIndicatorsResponse"
    /admin/add-indicators:
        post:
            operationId: blockadeIoAddIndicators
            summary: Add indicators to blockade.io
            requestBody: 
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/blockadeIoAddIndicatorsRequest"
            
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/blockadeIoGetIndicatorsResponse"
                
components:
    schemas:
        blockadeIoGetIndicatorsResponse:
            type: object
            properties:
                indicators:
                    type: array
                    items:
                        type: string
                    description: List of indicators
                indicatorCount:
                    type: number
                    description: Total number of indicators
                success:
                    type: boolean
                    description: Request status
                    
        blockadeIoAddIndicatorsRequest:
            type: object
            required:
                - email
                - api_key
                - indicators
            properties:
                email:
                    type: string
                    description: Email of the user
                    required: true
                api_key:
                    type: string
                    description: API key of the user
                    required: true
                indicators:
                    type: array
                    description: List of indicators
                    items:
                        type: string
                    required: true