Progress on adding upload calls for various object types

Added PUT calls for categories, markets, and listings. Culled out unused parameters that in the future will be read from User-Agents, if ever needed.

Change-Id: If2aed28fc92d42f22c302ca1af7c814ec124992c Signed-off-by: Martin Lowe martin.lowe@eclipse-foundation.org

spec/openapi.yaml

@@ -13,20 +13,26 @@ servers:
paths:
/listings:
-    parameters:
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
get:
-      summary: Retrieve multiple listings
+      summary: Multiple listings
parameters:
+        - $ref: "#/components/parameters/product.version"
+        - $ref: "#/components/parameters/runtime.version"
+        - $ref: "#/components/parameters/java.version"
+        - $ref: "#/components/parameters/os"
+        - $ref: "#/components/parameters/locale"
+        - name: marketID
+          in: query
+          description: "The ID of the market to search in for listings"
+          required: false
+          schema:
+            $ref: "#/components/schemas/ObjectID"
+        - name: categoryID
+          in: query
+          description: "The ID of the category to search in for listings"
+          required: false
+          schema:
+            $ref: "#/components/schemas/ObjectID"
- name: licenseType
in: query
description: |
@@ -34,9 +40,9 @@ paths:
The result will be a union of all included license types.
Valid values include:
-            * COMMERCIAL # Includes all commercial license types  
-            * OPEN_SOURCE # Includes all open source license types  
-            * EPL # Includes all versions of EPL  
+            * COMMERCIAL 
+            * OPEN_SOURCE 
+            * EPL
* EPL 1.0
* EPL 2.0
* GPL
@@ -53,13 +59,10 @@ paths:
type: string
- name: order
in: query
-          description: Optional query parameter to sort the resulting listings. This sort will be performed based on the field name passed, leaving the values unsorted if there is no field name that matches
+          description: Optional query parameter to order the resulting listings. This sort will be performed based on the field name passed, leaving the values unsorted if there is no field name that matches
required: false
-          schema:
+          schema: 
type: string
-            enum:
-              - asc
-              - desc
responses:
200:
description: Success
@@ -67,6 +70,27 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Listings"
+        500:
+          description: Error while retrieving data
+    put:
+      summary: Update or post a new listing by ID
+      requestBody:
+        description: The listing to be updated or inserted into the data set.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Listing"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Listing"
+        201:
+          description: Success (no content)
+        500:
+          description: Error while inserting data
/listings/{listingID}:
parameters:
@@ -78,18 +102,13 @@ paths:
type: integer
format: int32
minimum: 1
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
- $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/ws"
-      - $ref: "#/components/parameters/nl"
+      - $ref: "#/components/parameters/locale"
get:
-      summary: Retrieve listing by ID
+      summary: Listing by ID
responses:
200:
description: Success
@@ -99,22 +118,12 @@ paths:
$ref: "#/components/schemas/Listing"
404:
description: No listing found
-
+        500:
+          description: Error while retrieving data
/catalogs:
-    parameters:
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
get:
-      summary: Retrieve multiple listing catalogs
+      summary: Multiple catalogs
responses:
200:
description: Success
@@ -122,6 +131,27 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Catalogs"
+        500:
+          description: Error while retrieving data
+    put:
+      summary: Update or post a new catalog by ID
+      requestBody:
+        description: The catalog to be updated or inserted into the data set.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Catalog"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Catalog"
+        201:
+          description: Success (no content)
+        500:
+          description: Error while inserting data
/catalogs/{catalogId}:
parameters:
@@ -133,18 +163,8 @@ paths:
type: integer
format: int32
minimum: 1
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
get:
-      summary: Retrieve listing catalog by ID
+      summary: Catalog by ID
responses:
200:
description: Success
@@ -153,22 +173,13 @@ paths:
schema:
$ref: "#/components/schemas/Catalog"
404:
-          description: No listing found
+          description: No catalog found
+        500:
+          description: Error while retrieving data
/markets:
-    parameters:
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
get:
-      summary: Retrieve multiple markets
+      summary: Multiple markets
responses:
200:
description: Success
@@ -176,17 +187,52 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Markets"
-  /markets/{categoryID}/{marketID}:
+        500:
+          description: Error while retrieving data
+    put:
+      summary: Update or post a new market by ID
+      requestBody:
+        description: The market to be updated or inserted into the data set.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Market"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Catalog"
+        201:
+          description: Success (no content)
+        500:
+          description: Error while inserting data
+  /markets/{marketID}:
parameters:
-      - name: categoryID
+      - name: marketID
in: path
-        description: Unique ID of an individual category
+        description: Unique ID of an individual market
required: true
schema:
type: integer
format: int32
minimum: 1
+    get:
+      summary: Markets by ID
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Market"
+        500:
+          description: Error while retrieving data
+          
+  /markets/{marketID}/categories/{$categoryID}:
+    parameters:
- name: marketID
in: path
description: Unique ID of an individual market
@@ -195,76 +241,72 @@ paths:
type: integer
format: int32
minimum: 1
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
+
+  /categories:
get:
-      summary: Retrieve catalog by market
+      summary: Multiple categories
responses:
200:
description: Success
content:
application/json:
schema:
-                $ref: "#/components/schemas/Category"
-        404:
-          description: Not found
-
-  /featured:
+                $ref: "#/components/schemas/Categories"
+        500:
+          description: Error while retrieving data
+    put:
+      summary: Update or post a new category by ID
+      requestBody:
+        description: The market to be updated or inserted into the data set.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Category"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Catalog"
+        201:
+          description: Success (no content)
+        500:
+          description: Error while inserting data
+          
+  /categories/{catagoryID}:
parameters:
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
-      - $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/ws"
-      - $ref: "#/components/parameters/nl"
+      - name: catagoryID
+        in: path
+        description: Unique ID of an individual catalog
+        required: true
+        schema:
+          type: integer
+          format: int32
+          minimum: 1
get:
-      summary: Retrieve featured listings
+      summary: Catagory by ID
responses:
200:
description: Success
content:
application/json:
schema:
-                type: object
-                properties:
-                  count:
-                    type: integer
-                    minimum: 0
-                  listings:
-                    $ref: "#/components/schemas/Listings"
-  /related/{listingID}:
+                $ref: "#/components/schemas/Catalog"
+        404:
+          description: Not found
+        500:
+          description: Error while retrieving data
+  /featured:
parameters:
-      - in: path
-        name: listingID
-        required: true
-        description: A list of comma-separated node ids for installed marketplace nodes, url-encoded.
-        schema:
-          $ref: "#/components/schemas/ObjectID"
-      - $ref: "#/components/parameters/client"
-      - $ref: "#/components/parameters/client.version"
-      - $ref: "#/components/parameters/product"
- $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/ws"
-      - $ref: "#/components/parameters/nl"
+      - $ref: "#/components/parameters/locale"
get:
-      summary: Retrieve related listings
+      summary: Featured listings
responses:
200:
description: Success
@@ -281,20 +323,6 @@ paths:
components:
parameters:
-    client:
-      name: client
-      in: query
-      description: The only valid value for the client variable is org.eclipse.epp.mpc.core. This variable is usually sent from MPC to alter the default list. It's available for the Most Popular Listings, Top Favorited Listings, Recently Updated Listings and Featured Listings. Only installable listings owned by an Eclipse member company will be returned.
-      required: false
-      schema:
-        type: string
-    client.version:
-      name: client.version
-      in: query
-      description: The version of the client making the request
-      required: false
-      schema:
-        $ref: "#/components/schemas/osgiVersion"
product:
name: product
in: query
@@ -316,13 +344,6 @@ components:
required: false
schema:
$ref: "#/components/schemas/osgiVersion"
-    platform.version:
-      name: platform.version
-      in: query
-      description: (since Kepler/MPC 1.2) The version of the org.eclipse.platform bundle of the target Eclipse
-      required: false
-      schema:
-        $ref: "#/components/schemas/osgiVersion"
java.version:
name: java.version
in: query
@@ -344,15 +365,8 @@ components:
required: false
schema:
type: string
-    ws:
-      name: ws
-      in: query
-      description: Window system of the user. 
-      required: false
-      schema:
-        type: string
-    nl:
-      name: nl
+    locale:
+      name: locale
in: query
description: Language code of the user's locale, e.g. `en_US` or `de_DE`.
required: false
@@ -466,23 +480,28 @@ components:
description: Tag Title
URL:
type: string
-          description: URL to retrieve the category details.
+          description: URL to retrieve the tag details.
+    Categories:
+      type: array
+      items: 
+        $ref: "#/components/schemas/Category"
+        
Category:
type: object
properties:
id:
$ref: "#/components/schemas/ObjectID"
-        marketID:
-          $ref: "#/components/schemas/ObjectID"
name:
type: string
description: Category title
URL:
type: string
description: URL to retrieve the category details.
-        node:
-          $ref: "#/components/schemas/Listing"
+        marketIDs: 
+          type: array
+          items:
+            $ref: "#/components/schemas/ObjectID"
Market:
type: object
@@ -499,7 +518,7 @@ components:
type: array
items:
$ref: "#/components/schemas/Category"
-          description: Array of categories in which this listing appears. 
+          description: Array of categories that this market makes use of
Markets:
type: array
@@ -539,43 +558,18 @@ components:
description: Short description
dependenciesRepository:
type: string
-        wizard:
-          type: object
-          properties:
-            title:
-              type: string
-              description: Title of Wizard
-            icon:
-              type: string
-              description: Absolute url
-            searchtab:
-              type: object
-              description: Search tab title
-              properties:
-                enabled:
-                  type: boolean
-                  description: TRUE/FALSE 
-            populartab:
-              type: object
-              description: Popular tab title
-              properties:
-                enabled:
-                  type: boolean
-                  description: TRUE/FALSE 
-            recenttab:
-              type: object
-              description: Recent tab title
-              properties:
-                enabled:
-                  type: boolean
-                  description: TRUE/FALSE 
-            news:
-              type: object
-              description: News content URL.
-              properties:
-                enabled:
-                  type: boolean
-                  description: TRUE/FALSE
+        searchtab:
+          type: boolean
+          description: TRUE/FALSE 
+        populartab:
+          type: boolean
+          description: TRUE/FALSE 
+        recenttab:
+          type: boolean
+          description: TRUE/FALSE 
+        news:
+          type: boolean
+          description: TRUE/FALSE
licenseType:
type: string