product-recommendations-v1-oas.yaml

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
openapi: 3.0.3
info:
  version: 0.0.1
  title: Product Recommendations
  description: |
    Provides product recommendations based on user activities on ecommerce site.
servers:
  - url: 'https://xapi-test.kurtkanaskie.net/v1/recommendations'
security:
  - ApiKeyAuth: []
paths:
  /products:
    get:
      summary: List `Product` objects.
      description: Retrieve a List of products recommended for an user
      operationId: getPersons
      parameters:
        - $ref: '#/components/parameters/x-userid'
        - $ref: '#/components/parameters/cache-control'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListOfProducts'
components:
  securitySchemes:
    ApiKeyAuth:        # arbitrary name for the security scheme
      type: apiKey
      in: header
      name: X-APIKey
  parameters:
    x-userid:
      in: header
      name: x-userid
      description: The user identifier (defaults to 000170187170673177-6)
      required: false
      schema:
        type: string
    cache-control:
      in: header
      name: cache-control
      description: Control caching (default to allow-cache).
      required: false
      schema:
        type: string
        enum: [allow-cache, no-cache]
  schemas:
    ListOfProducts:
      title: List of Products
      type: array
      items:
        $ref: '#/components/schemas/Product'
    Product:
      title: Product
      type: object
      properties:
        productid:
          description: Product ID
          type: string
        name:
          description: Product Name
          type: string
        description:
          description: Product Description
          type: string
        price:
          description: Product Price
          type: number
        image:
          description: Product image URL
          type: string