RSS Search Process - openapi-functions.yaml

swagger: '2.0'
info:
  title: RSS Search Process
  description: This API triggers an RSS search process
  version: 1.0.0
host: [GENERATED SERVICE HOSTNAME]
schemes:
  - https

paths:
  /rsssearchprocess/start:
    post:
      summary: Starts Rss Search Process
      operationId: startRSSSearchProcess
      consumes:
        - application/json
      security:
        - api_key: []
      parameters:
        - in: body
          name: search
          schema:
            type: object
            required:
              - url
              - source
              - keyword
            properties:
              source:
                type: string
                description: "Describes the rss feed source. It is used to create a storage folder by source "
              url:
                type: string
                description: RSS Feed URL. Must be a full url containing the searched keyword

              keyword:
                type: string
                description: Searched keyword used in the url
              limit:
                type: integer  
                minimum: 1
                description: Limits the number of articles to be processed. usefull when testing an RSS feed wihtou process all the articles.
          
      x-google-backend:
        address: https://us-central1-[YOUR GCP PROJECT ID].cloudfunctions.net/publish_rss_feed_search_message
      responses:
        '200':
          description: A successful response
          schema:
            type: string          
securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"