Update response samples

Signed-off-by: Christopher Guindon chris.guindon@eclipse-foundation.org

spec/openapi.yaml

@@ -29,20 +29,18 @@ paths:
summary: Listing list
description: Returns a list of marketplace listings that match the given parameters, filtering out solutions that don't match the filters.
parameters:
-        - $ref: "#/components/parameters/product_version"
-        - $ref: "#/components/parameters/runtime_version"
+        - $ref: "#/components/parameters/platform_version"
- $ref: "#/components/parameters/java_version"
- $ref: "#/components/parameters/os"
-        - $ref: "#/components/parameters/locale"
- $ref: "#/components/parameters/page"
-        - $ref: "#/components/parameters/page_size"
-        - name: marketID
+        - $ref: "#/components/parameters/limit"
+        - name: market_id
in: query
description: "The ID of the market to search in for listings"
required: false
schema:
$ref: "#/components/schemas/ObjectID"
-        - name: categoryID
+        - name: category_id
in: query
description: "The ID of the category to search in for listings"
required: false
@@ -73,11 +71,11 @@ paths:
At this time, only a subset of whitelisted values are enabled for sorting, and only one of which can be used for sorting at a time. See below for a list of accepted fields.
-            - installs_total
-            - favorited
+            - install_count
+            - install_count_recent
+            - favorite_count
- id
- name
-            - installs_recent
- created
- changed
@@ -132,9 +130,9 @@ paths:
500:
description: Error while inserting data
-  /listings/{listingID}:
+  /listings/{listing_id}:
parameters:
-      - name: listingID
+      - name: listing_id
in: path
description: Unique ID of an individual listing
required: true
@@ -142,11 +140,9 @@ paths:
type: integer
format: int32
minimum: 1
-      - $ref: "#/components/parameters/product_version"
-      - $ref: "#/components/parameters/runtime_version"
+      - $ref: "#/components/parameters/platform_version"
- $ref: "#/components/parameters/java_version"
- $ref: "#/components/parameters/os"
-      - $ref: "#/components/parameters/locale"
get:
tags:
- Listings
@@ -164,9 +160,9 @@ paths:
500:
description: Error while retrieving data
-  /listings/{listingID}/installs:
+  /listings/{listing_id}/installs:
parameters:
-      - name: listingID
+      - name: listing_id
in: path
description: Unique ID of an individual listing
required: true
@@ -174,13 +170,12 @@ paths:
type: integer
format: int32
minimum: 1
-      - $ref: "#/components/parameters/product_version"
+      - $ref: "#/components/parameters/platform_version"
- $ref: "#/components/parameters/java_version"
- $ref: "#/components/parameters/os"
-      - $ref: "#/components/parameters/locale"
- $ref: "#/components/parameters/country"
- $ref: "#/components/parameters/page"
-      - $ref: "#/components/parameters/page_size"
+      - $ref: "#/components/parameters/limit"
get:
tags:
- Installs
@@ -196,9 +191,9 @@ paths:
404:
description: No listing found
-  /listings/{listingID}/version/{versionNumber}/installs:
+  /listings/{listing_id}/version/{versionNumber}/installs:
parameters:
-      - name: listingID
+      - name: listing_id
in: path
description: Unique ID of an individual listing
required: true
@@ -218,13 +213,12 @@ paths:
tags:
- Installs
parameters:
-        - $ref: "#/components/parameters/product_version"
+        - $ref: "#/components/parameters/platform_version"
- $ref: "#/components/parameters/java_version"
- $ref: "#/components/parameters/os"
-        - $ref: "#/components/parameters/locale"
- $ref: "#/components/parameters/country"
- $ref: "#/components/parameters/page"
-        - $ref: "#/components/parameters/page_size"
+        - $ref: "#/components/parameters/limit"
description: Retrieve install metrics for the given marketplace listing and version by its unique listing ID and version number. These stats will include available metrics for the last 12 months, as well as the overall install statistics for the version. The parameters that are available for this call act as filters for the statistics, allowing for greater flexibility of analysis of the Installation stats.
summary: Installation list by Solution Version
responses:
@@ -322,7 +316,7 @@ paths:
description: Retrieves a listing of markets available within the marketplace.
parameters:
- $ref: "#/components/parameters/page"
-        - $ref: "#/components/parameters/page_size"
+        - $ref: "#/components/parameters/limit"
responses:
200:
description: Success
@@ -355,9 +349,9 @@ paths:
500:
description: Error while inserting data
-  /markets/{marketID}:
+  /markets/{market_id}:
parameters:
-      - name: marketID
+      - name: market_id
in: path
description: Unique ID of an individual market
required: true
@@ -380,9 +374,9 @@ paths:
500:
description: Error while retrieving data
-  /markets/{marketID}/categories/{categoryID}:
+  /markets/{market_id}/categories/{category_id}:
parameters:
-      - name: marketID
+      - name: market_id
in: path
description: Unique ID of an individual market
required: true
@@ -390,7 +384,7 @@ paths:
type: integer
format: int32
minimum: 1
-      - name: categoryID
+      - name: category_id
in: path
description: Unique ID of an individual category for market
required: true
@@ -399,7 +393,7 @@ paths:
format: int32
minimum: 1
- $ref: "#/components/parameters/page"
-      - $ref: "#/components/parameters/page_size"
+      - $ref: "#/components/parameters/limit"
get:
tags:
- Categories
@@ -421,7 +415,7 @@ paths:
- Categories
parameters:
- $ref: "#/components/parameters/page"
-        - $ref: "#/components/parameters/page_size"
+        - $ref: "#/components/parameters/limit"
summary: Category list
description: Retrieves a listing of categories available within the marketplace.
responses:
@@ -492,20 +486,13 @@ components:
required: false
schema:
type: string
-    product_version:
-      name: product_version
+    platform_version:
+      name: platform_version
in: query
description: The version of the running product of the target Eclipse, identical to the version of the product's branding plugin
required: false
schema:
$ref: "#/components/schemas/osgiVersion"
-    runtime_version:
-      name: runtime_version
-      in: query
-      description: The version of the org.eclipse.core.runtime bundle of the target Eclipse
-      required: false
-      schema:
-        $ref: "#/components/schemas/osgiVersion"
java_version:
name: java_version
in: query
@@ -527,13 +514,6 @@ components:
required: false
schema:
type: string
-    locale:
-      name: locale
-      in: query
-      description: Language code of the user's locale, e.g. `en_US` or `de_DE`.
-      required: false
-      schema:
-        type: string
country:
name: country
in: query
@@ -548,8 +528,8 @@ components:
required: false
schema:
type: integer
-    page_size:
-      name: page_size
+    limit:
+      name: limit
in: query
description: 'The size of result sets returned (maximum: 50, default: 10)'
required: false
@@ -562,7 +542,7 @@ components:
properties:
id:
$ref: "#/components/schemas/ObjectID"
-        name:
+        title:
type: string
description: Listing Title
categories:
@@ -575,19 +555,22 @@ components:
items:
$ref: "#/components/schemas/Tag"
description: Array of tags that this listing appears.
-        owner:
+        authors:
type: string
description: Name of the author
-        favorited:
+        favorite_count:
type: integer
-          description: Number of times a listing was favorited
-        installs_total:
+          description: Number of times a listing was add to a favorite list.
+        install_count:
type: integer
description: Install count
-        installs_recent:
+        install_count_recent:
type: integer
description: Install count for the last month
-        short_description:
+        install_ranking:
+          type: string
+          description: Relative install_ranking of the given listing.
+        teaser:
type: string
description: Listing teaser
body:
@@ -605,15 +588,15 @@ components:
homepage_url:
type: string
description: Listing URL website
-        image:
+        logo:
type: string
description: Logo absolute URL
license:
type: string
description: Listing license
-        company_name:
+        organization:
type: string
-          description: Company name
+          description: Organization name
status:
type: string
description: Release status
@@ -630,9 +613,6 @@ components:
update_url:
type: string
description: Update site URL
-        ranking:
-          type: string
-          description: Relative ranking of the given listing.
ius:
type: array
items:
@@ -661,7 +641,7 @@ components:
properties:
id:
$ref: "#/components/schemas/ObjectID"
-        name:
+        title:
type: string
description: Tag Title
url:
@@ -678,7 +658,7 @@ components:
properties:
id:
$ref: "#/components/schemas/ObjectID"
-        name:
+        title:
type: string
description: Category title
url:
@@ -694,10 +674,10 @@ components:
properties:
id:
$ref: "#/components/schemas/ObjectID"
-        name:
+        title:
type: string
description: Listing Title
-        URL:
+        url:
type: string
description: URL to retrieve the category details.
categories:
@@ -729,7 +709,7 @@ components:
$ref: "#/components/schemas/ObjectID"
title:
type: string
-          description: Name of catalog
+          description: title of catalog
url:
type: string
description: Url prefix of the marketplace catalog
@@ -770,11 +750,11 @@ components:
sort_whitelist:
type: string
enum:
-        - installs_total
-        - favorited
+        - install_count
+        - install_count_recent
+        - favorite_count
- id
- name
-        - installs_recent
- created
- changed
@@ -811,10 +791,10 @@ components:
type: integer
format: int32
minimum: 0
-        installs_recent:
+        install_count_recent:
type: number
description: The number of installs in the last month for the given resource
-        installs_total:
+        install_count:
type: number
description: The number of historic installs for the given resource
\ No newline at end of file