openapi: 3.2.0
info:
  title: Opoint Safefeeds API
  version: 1.0.0
  description: 'Operations tagged safefeeds across 2 of this provider''s published API definitions: opoint-openapi-original.yml, opoint-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.opoint.com
tags:
- name: safefeeds
paths:
  /safefeeds/:
    get:
      operationId: safefeeds_list
      description: 'Lists available SafeFeeds.


        A user will have access to certain SafeFeeds, which contain their access_key, id,

        and id_list to a connected PredefinedDBList. This has an id_list name.'
      summary: List available safefeeds
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Safefeed'
          description: ''
    servers:
    - url: https://api.opoint.com
  /safefeeds/{id}/:
    get:
      operationId: safefeeds_retrieve
      description: Retrieves a single Safefeed
      summary: Retrieve a safefeed
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Safefeed'
          description: ''
    patch:
      operationId: safefeeds_partial_update
      description: Update a safefeed
      summary: Partially update a safefeed
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - safefeeds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSafefeed'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSafefeed'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSafefeed'
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
    servers:
    - url: https://api.opoint.com
  /safefeeds/{id}/feed/:
    get:
      operationId: safefeeds_feed_retrieve
      summary: Retrieve articles from the safefeed
      parameters:
      - in: query
        name: doc_format
        schema:
          type: string
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - xml
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: lastid
        schema:
          type: string
      - in: query
        name: num_art
        schema:
          type: integer
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/SearchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
          description: ''
    servers:
    - url: https://api.opoint.com
  /safefeeds/{id}/lastids/:
    get:
      operationId: safefeeds_lastids_list
      description: Get named last ids for a specific safefeed
      summary: Retrieve named lastids for the safefeed
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SafefeedLastId'
          description: ''
    servers:
    - url: https://api.opoint.com
  /safefeeds/{id}/logs/:
    get:
      operationId: safefeeds_logs_retrieve
      description: 'Get logs for a specific safefeed with timestamp filtering.

        Required query parameters:

        - start_time: Unix timestamp (seconds since epoch)

        - end_time: Unix timestamp (seconds since epoch)

        Optional query parameters:

        - limit: Maximum number of records to return (default: 100)

        - offset: Number of records to skip (default: 0)'
      summary: Retrieve request logs for the safefeed
      parameters:
      - in: query
        name: end_time
        schema:
          type: integer
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: offset
        schema:
          type: integer
      - in: query
        name: start_time
        schema:
          type: integer
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafefeedLogResponse'
          description: ''
    servers:
    - url: https://api.opoint.com
  /safefeeds/{id}/stats/:
    get:
      operationId: safefeeds_stats_retrieve
      description: 'Get statistics for a specific safefeed with timestamp filtering.

        Required query parameters:

        - start_time: Unix timestamp (seconds since epoch)

        - end_time: Unix timestamp (seconds since epoch)'
      summary: Retrieve request logs statistics for the safefeed
      parameters:
      - in: query
        name: end_time
        schema:
          type: integer
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: start_time
        schema:
          type: integer
      tags:
      - safefeeds
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafefeedStats'
          description: ''
    servers:
    - url: https://api.opoint.com
components:
  schemas:
    SafefeedLastId:
      type: object
      properties:
        name:
          type: string
        lastid:
          type: integer
      required:
      - lastid
      - name
    Language:
      type: object
      properties:
        encoding:
          type: string
        text:
          type: string
      required:
      - encoding
      - text
    SafefeedRequestLog:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        request_time:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
        response_time:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        searchd_time:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        ip:
          type:
          - string
          - 'null'
          maxLength: 32
        articles_requested:
          type: integer
        articles_returned:
          type: integer
          maximum: 65535
          minimum: 0
        doc_format:
          type:
          - string
          - 'null'
          maxLength: 32
        dry_run:
          type: boolean
      required:
      - articles_requested
      - id
      - response_time
      - searchd_time
    SiteRank:
      type: object
      properties:
        rank_global:
          type: integer
        rank_country:
          type: integer
      required:
      - rank_country
      - rank_global
    ArticleFeature:
      type: object
      properties:
        matches:
          type: boolean
        text:
          type: string
      required:
      - matches
      - text
    SearchDocuemnt:
      type: object
      properties:
        id_site:
          type: integer
        id_article:
          type: integer
        hidden:
          type: boolean
        position:
          type: integer
        equalgroup:
          type: integer
        icon:
          type: string
        countrycode:
          type: string
        countryname:
          type: string
        similarweb:
          $ref: '#/components/schemas/SimilarWeb'
        site_rank:
          $ref: '#/components/schemas/SiteRank'
        unix_timestamp:
          type: integer
        reach:
          type: integer
        circulation:
          type: integer
        stimestamp:
          type: integer
        stimestamp_index:
          type: integer
        internal_serach_reply:
          $ref: '#/components/schemas/InternalSearchReply'
        local_time:
          $ref: '#/components/schemas/LocalTime'
        local_rcf822_time:
          $ref: '#/components/schemas/LocalRcf822Time'
        distribute_conditions:
          type: string
        language:
          $ref: '#/components/schemas/Language'
        word_count:
          type: integer
        first_source:
          $ref: '#/components/schemas/FirstSource'
        header:
          $ref: '#/components/schemas/ArticleFeature'
        summary:
          $ref: '#/components/schemas/ArticleFeature'
        body:
          $ref: '#/components/schemas/ArticleFeature'
        articleImages:
          $ref: '#/components/schemas/ArticleImages'
        caption:
          $ref: '#/components/schemas/Caption'
        quotes:
          type: array
          items:
            $ref: '#/components/schemas/ArticleFeature'
        url:
          type: string
        orig_url:
          type: string
        url_common:
          type: string
        topics:
          type: array
          items:
            $ref: '#/components/schemas/DocumentTopic'
        author:
          type: string
        exist_inbasket:
          type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - articleImages
      - author
      - body
      - caption
      - countrycode
      - countryname
      - distribute_conditions
      - exist_inbasket
      - first_source
      - header
      - hidden
      - id_article
      - id_site
      - internal_serach_reply
      - language
      - local_rcf822_time
      - local_time
      - orig_url
      - position
      - quotes
      - site_rank
      - stimestamp
      - stimestamp_index
      - summary
      - tags
      - topics
      - unix_timestamp
      - url
      - url_common
      - word_count
    FirstSource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sitename:
          type: string
        url:
          type: string
        siteurl:
          type: string
      required:
      - id
      - name
      - sitename
      - siteurl
      - url
    PatchedSafefeed:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        access_key:
          type: string
          maxLength: 255
        list:
          type: integer
        name:
          type: string
          readOnly: true
        user:
          type: integer
        playback:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        client_name:
          type: string
          maxLength: 255
        extra_searchd_options:
          type:
          - string
          - 'null'
          maxLength: 255
        filters:
          type:
          - string
          - 'null'
          maxLength: 255
        transform_file:
          type: string
          maxLength: 255
        postprocess_file:
          type:
          - string
          - 'null'
          maxLength: 255
        sleep:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        id_log:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        expected_rate:
          type:
          - number
          - 'null'
          format: double
        rate_limit:
          type:
          - string
          - 'null'
          maxLength: 255
        active:
          type:
          - boolean
          - 'null'
    Caption:
      type: object
      properties:
        text:
          type: string
      required:
      - text
    SafefeedLogResponse:
      type: object
      properties:
        count:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/SafefeedRequestLog'
      required:
      - count
      - results
    LocalTime:
      type: object
      properties:
        text:
          type: string
        GMT:
          type: integer
      required:
      - GMT
      - text
    SafefeedStats:
      type: object
      properties:
        requests:
          type: integer
        articles_requested:
          type: integer
        articles_returned:
          type: integer
        last_pulled:
          type: integer
        last_available:
          type: integer
      required:
      - articles_requested
      - articles_returned
      - last_available
      - last_pulled
      - requests
    Tag:
      type: object
      properties:
        id:
          type: integer
        is_owner:
          type: integer
        weight:
          type: integer
        sent:
          type: integer
        set:
          type: integer
        equal_sent:
          type: integer
      required:
      - equal_sent
      - id
      - is_owner
      - sent
      - set
      - weight
    SearchResult:
      type: object
      properties:
        documents:
          type: integer
        first_timestamp:
          type: integer
        last_timestamp:
          type: integer
        search_start:
          type: integer
        ontext:
          type: string
        count:
          type: integer
        range_count:
          type: integer
        range_start:
          type: integer
        range_end:
          type: integer
        range_id:
          type: string
        watch_id:
          type: integer
        cacheage:
          type: integer
        cputime:
          type: integer
        host:
          type: string
        compiledate:
          type: string
        branch:
          type: string
        notimeout:
          type: boolean
        currency:
          type: string
        netsprintindextimer:
          type: integer
        document:
          type: array
          items:
            $ref: '#/components/schemas/SearchDocuemnt'
      required:
      - branch
      - cacheage
      - compiledate
      - count
      - cputime
      - currency
      - document
      - documents
      - first_timestamp
      - host
      - last_timestamp
      - netsprintindextimer
      - notimeout
      - ontext
      - range_count
      - range_end
      - range_id
      - range_start
      - search_start
      - watch_id
    ArticleImage:
      type: object
      properties:
        url:
          type: string
      required:
      - url
    LocalRcf822Time:
      type: object
      properties:
        text:
          type: string
      required:
      - text
    ArticleImages:
      type: object
      properties:
        count:
          type: integer
        articleimage:
          type: array
          items:
            $ref: '#/components/schemas/ArticleImage'
      required:
      - articleimage
      - count
    Safefeed:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        access_key:
          type: string
          maxLength: 255
        list:
          type: integer
        name:
          type: string
          readOnly: true
        user:
          type: integer
        playback:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        client_name:
          type: string
          maxLength: 255
        extra_searchd_options:
          type:
          - string
          - 'null'
          maxLength: 255
        filters:
          type:
          - string
          - 'null'
          maxLength: 255
        transform_file:
          type: string
          maxLength: 255
        postprocess_file:
          type:
          - string
          - 'null'
          maxLength: 255
        sleep:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        id_log:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        expected_rate:
          type:
          - number
          - 'null'
          format: double
        rate_limit:
          type:
          - string
          - 'null'
          maxLength: 255
        active:
          type:
          - boolean
          - 'null'
      required:
      - client_name
      - id
      - list
      - name
      - playback
      - transform_file
      - user
    InternalSearchReply:
      type: object
      properties:
        id_site:
          type: integer
        id_article:
          type: integer
        text:
          type: string
      required:
      - id_article
      - id_site
      - text
    SimilarWeb:
      type: object
      properties:
        domain:
          type: string
      required:
      - domain
    SearchResponse:
      type: object
      properties:
        searchresult:
          $ref: '#/components/schemas/SearchResult'
      required:
      - searchresult
    DocumentTopic:
      type: object
      properties:
        id:
          type: integer
        linktype_max:
          type: integer
        linktype_now:
          type: integer
        metacat:
          type: integer
        metacat_level:
          type: integer
        text:
          type: string
      required:
      - id
      - linktype_max
      - linktype_now
      - metacat
      - metacat_level
      - text
  securitySchemes:
    JWT:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "JWT"
    cookieAuth:
      type: apiKey
      in: cookie
      name: PHPSESSID
    ephmeralId:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Ephemeral"
    staticToken:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- opoint-openapi-original.yml
- opoint-openapi.yml