Details

      Description

      As a user of the REST API I want to be able to perform a search for sites in the system so that I can build a client that allows users to find sites.

      Acceptance Criteria

      basePath: /alfresco/api/-default-/public/alfresco/versions/1
      paths:
        '/queries/live-search-sites':
          get:
            tags:
              - queries
              - 5.2 changes
            summary: Live search for sites
            description: |
              Returns a list of sites that match the given search criteria.
      
              The search term is used to look for sites that match against site id, title or description.
      
              The search term must contain a minimum of 2 alphanumeric characters.
              
              You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter:
              * id
              * title
              * description
            operationId: liveSearchSites
            produces:
              - application/json
            parameters:
              - $ref: '#/parameters/skipCountParam'
              - $ref: '#/parameters/maxItemsParam'
              - name: term
                in: query
                description: The term to search for.
                type: string
                required: true
              - $ref: '#/parameters/orderByParam'
              - $ref: '#/parameters/fieldsParam'
            responses:
              '200':
                description: Successful response
                schema:
                  $ref: '#/definitions/SitePaging'
              '400':
                description: Invalid parameter, eg. search term is too short, unknown orderBy field
              '401':
                description: If authentication fails          
              default:
                description: Error response
                schema:
                  $ref: '#/definitions/Error'    
      

      Notes

      • Used as one of the category types returned from the live search: nodes (documents), people (users) & sites. Needs to be consistent with those.
      • Need to be consistent with the rest of the V1 people API and based on the implementation of the v0 "live search" REST API

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                gcornwell Gavin Cornwell [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: