Update pagination, remove xpath and validation (#4)

* Update pagination to use offset and limit
* Remove unused code such as total funcs
* Remove XPath
* Remove Validation

Author: farshidtz

apidoc/openapi-spec.yml

@@ -4,7 +4,7 @@ openapi: 3.0.3
 #  - url: http://localhost:8081
 
 info:
-  version: "1.0.0-beta.22"
+  version: "1.0.0-beta.24"
   title: TinyIoT Thing Directory
   description: API documentation of the [TinyIoT Thing Directory](https://github.com/tinyiot/thing-directory)
   license:
@@ -18,15 +18,29 @@ tags:
     description: Search API
   - name: events
     description: Notification API
-  - name: validation
-    description: Validation API (non-normative)
 
 paths:
   /things:
     get:
       tags:
         - things
       summary: Retrieves the list of Thing Descriptions
+      parameters:
+        - name: offset
+          in: query
+          description: Offset number in the pagination
+          required: false
+          schema:
+            type: number
+            format: integer
+            default: 0
+        - name: limit
+          in: query
+          description: Number of entries per page. When not set, all entries are returned incrementally.
+          required: false
+          schema:
+            type: number
+            format: integer
       responses:
         '200':
           description: Successful response
@@ -251,47 +265,6 @@ paths:
           $ref: '#/components/responses/RespForbidden'
         '500':
           $ref: '#/components/responses/RespInternalServerError'
-  /search/xpath:
-    get:
-      tags:
-        - search
-      summary: Query TDs with XPath expression
-      description: The query languages, described [here](https://github.com/tinyiot/thing-directory/wiki/Query-Language), can be used to filter results and select parts of Thing Descriptions.
-      parameters:
-        - name: query
-          in: query
-          description: xPath 3.0 expression for fetching specific items. E.g. `//*[title='Kitchen Lamp']/properties`
-          required: true
-          schema:
-            type: string
-          # example: //*[title='Kitchen Lamp']/properties
-      responses:
-        '200':
-          description: Successful response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  oneOf:
-                    - type: string
-                    - type: number
-                    - type: integer
-                    - type: boolean
-                    - type: array
-                    - type: object
-              # examples:
-              #   ThingDescriptionList:
-              #     $ref: '#/components/examples/ThingDescriptionList'
-        '400':
-          $ref: '#/components/responses/RespBadRequest'
-        '401':
-          $ref: '#/components/responses/RespUnauthorized'
-        '403':
-          $ref: '#/components/responses/RespForbidden'
-        '500':
-          $ref: '#/components/responses/RespInternalServerError'
-
 
   /events:
     get:
@@ -352,62 +325,11 @@ paths:
         '500':
           $ref: '#/components/responses/RespInternalServerError'
 
-
-  /validation:
-    get:
-      tags:
-        - validation
-      summary: Retrieves the validation result for a given Thing Description
-      description: |
-        The Thing Description should be provided as JSON in the request body.<br>
-        Note: This is currently not supported using Swagger UI.<br>
-        This endpoint is non-normative.
-      responses:
-        '200':
-          description: Validation Result
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ValidationResult'
-        '400':
-          $ref: '#/components/responses/RespBadRequest'
-        '401':
-          $ref: '#/components/responses/RespUnauthorized'
-        '403':
-          $ref: '#/components/responses/RespForbidden'
-        '500':
-          $ref: '#/components/responses/RespInternalServerError'
-      # wait for openapi 3.1.0 which brings back support for requetsBody in GET
-      # requestBody:
-      #   content:
-      #     application/ld+json:
-      #       schema:
-      #         $ref: '#/components/schemas/ThingDescription'
-      #       examples:
-      #         ThingDescription:
-      #           $ref: '#/components/examples/ThingDescriptionWithID'
 security:
   - BasicAuth: []
   - BearerAuth: []
 
 components:
-  parameters:
-    ParamPage:
-      name: page
-      in: query
-      description: Page number in the pagination
-      required: false
-      schema:
-        type: number
-        format: integer
-    ParamPerPage:
-      name: per_page
-      in: query
-      description: Number of entries per page
-      required: false
-      schema:
-        type: number
-        format: integer
   securitySchemes:
     BasicAuth:
       type: http

catalog/catalog.go

@@ -1,4 +1,3 @@
-
 package catalog
 
 import (
@@ -11,8 +10,6 @@ import (
 type ThingDescription = map[string]interface{}
 
 const (
-	ResponseContextURL = "https://linksmart.eu/thing-directory/context.jsonld"
-	ResponseType       = "Catalog"
 	// Storage backend types
 	BackendMemory  = "memory"
 	BackendLevelDB = "leveldb"
@@ -33,21 +30,11 @@ type CatalogController interface {
 	update(id string, d ThingDescription) error
 	patch(id string, d ThingDescription) error
 	delete(id string) error
-	list(page, perPage int) ([]ThingDescription, int, error)
-	listAllBytes() ([]byte, error)
-	// Deprecated
-	filterJSONPath(path string, page, perPage int) ([]interface{}, int, error)
+	listPaginate(offset, limit int) ([]ThingDescription, error)
 	filterJSONPathBytes(query string) ([]byte, error)
-	// Deprecated
-	filterXPath(path string, page, perPage int) ([]interface{}, int, error)
-	filterXPathBytes(query string) ([]byte, error)
-	//filterXPathBytes(query string) ([]byte, error)
-	total() (int, error)
 	iterateBytes(ctx context.Context) <-chan []byte
 	cleanExpired()
-
 	Stop()
-
 	AddSubscriber(listener EventListener)
 }
 
@@ -57,10 +44,9 @@ type Storage interface {
 	update(id string, td ThingDescription) error
 	delete(id string) error
 	get(id string) (ThingDescription, error)
-	list(page, perPage int) ([]ThingDescription, int, error)
+	listPaginate(offset, limit int) ([]ThingDescription, error)
 	listAllBytes() ([]byte, error)
-	total() (int, error)
-	iterator() <-chan ThingDescription
+	iterate() <-chan ThingDescription
 	iterateBytes(ctx context.Context) <-chan []byte
 	Close()
 }