https://github.com/lblod/toezicht-search-query-management-service

Service that provides management of search-queries.
https://github.com/lblod/toezicht-search-query-management-service

Last synced: 22 days ago
JSON representation

Service that provides management of search-queries.

• Host: GitHub
• URL: https://github.com/lblod/toezicht-search-query-management-service
• Owner: lblod
• License: mit
• Created: 2020-06-16T15:23:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T07:52:05.000Z (6 months ago)
• Last Synced: 2024-06-20T23:51:02.342Z (6 months ago)
• Language: JavaScript
• Size: 32.2 KB
• Stars: 0
• Watchers: 20
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# toezicht-search-query-management-service

Service that provides management of search-queries.

## Installation

To add the service to your stack, add the following snippet to docker-compose.yml:

```

services:

  search-query-managment:

    image: lblod/toezicht-search-query-management-service:x.x.x

    volumes:

      - ./config/search-query:/share/search-query

```

## Configuration

### Environment variables

- `META_CONSTRUCTION_CRON_PATTERN`: Frequency at witch the meta-data should be re-constructed. Defaults to 0 0 */2 * * *, run every 2 hours.

- `ORGANISATION_GRAPH` : Graph where the new data/triples will be put on PUT. Default implemented.

- `BATCH_SIZE` : Max number of triples it will retrieve on construction of a search-query. Default set to 1000.

   

## REST API

### GET `/search-query/:uuid`

Retrieves all the triples for the search-query with the given UUID.

- Content-Type: `application/n-triples`

### PUT `/search-query/:uuid`

Replaces the old triples with the received triples for the search-query with the given UUID.

- Accepts: `application/n-triples`

- Content-Type: `application/n-triples`

### DELETE `/search-query/:uuid`

Deletes all the data/triples for the search-query with the given UUID.

### GET `/search-query-forms/:uuid`

Retrieves the content of the form for the given UUID.

- Content-Type: `text/turtle`

### POST `search-query-forms/initiate-meta-construction`

re-Constructs the meta-data of the forms.

### GET `/search-query-forms/:uuid/meta`

Retrieves the meta-data of the form for the given UUID.

- Accepts: `application/n-triples`

- Content-Type: `application/n-triples`

## Model

### Used prefixes

Prefix | URI 

--- | --- 

searchToezicht: |  

search: | 

skos: |  

mu: |  

### Search Query

Encapsulated a preset of search qeuries/filters.

#### Class

`ext:SearchQuery`

#### Properties

 Name | Predicate | Range | Definition 

--- | --- | --- | ---

uuid | `mu:uuid` | `xsd:string` | unique identifier

label | `skos:prefLabel` | `xsd:string` | name of the SearchQuery

comment | `skos:comment` | `xsd:string` | more detailed description of the SearchQuery

term | `search:term` | `xsd:string` | search term filter

status | `searchToezicht:status` | `xsd:boolean` | state of dossiers filter

status | `searchToezicht:administrativeUnit` | `uri` | administrative unit filter

province | `searchToezicht:province` | `uri` | province filter

administrativeUnitClassification | `searchToezicht:administrativeUnitClassification` | `uri` | administrative unit classification filter

governingBodyClassification | `searchToezicht:governingBodyClassification` | `uri` | governing-body classification filter

regulationType | `searchToezicht:regulationType` | `uri` | regulationType filter

sessionDateFrom | `searchToezicht:sessionDateFrom` | `xsd:date` | session date from filter

sessionDateTo | `searchToezicht:sessionDateTo` | `xsd:date` | session date to filter

sentDateFrom | `searchToezicht:sentDateFrom` | `xsd:date` | sent date from filter

sentDateTo | `searchToezicht:sentDateTo` | `xsd:date` | sent date to filter 

chartOfAccount | `searchToezicht:chartOfAccount` | `uri` | chart of account filter

dateOfEntryIntoForceFrom | `searchToezicht:dateOfEntryIntoForceFrom` | `xsd:date` | date of entry into force from filter

dateOfEntryIntoForceTo | `searchToezicht:dateOfEntryIntoForceTo` | `xsd:date` | date of entry into force to filter

dateNoLongerInForceFrom | `searchToezicht:dateNoLongerInForceFrom` | `xsd:date` | date no longer in force from filter

dateNoLongerInForceTo | `searchToezicht:dateNoLongerInForceTo` | `xsd:date` | date no longer in force to filter

## Development

For a more detailed look in how to develop a microservices based on the [mu-javascript-template](https://github.com/mu-semtech/mu-javascript-template), 

we would recommend reading "[Developing with the template](https://github.com/mu-semtech/mu-javascript-template#developing-with-the-template)"

### Developing in the `mu.semte.ch` stack

Paste the following snip-it in your `docker-compose.override.yml`:

````  

search-query-managment:

  image: semtech/mu-javascript-template:1.4.0

  ports:

    - 8888:80

    - 9229:9229

  environment:

    NODE_ENV: "development"

  volumes:

    - ./config/search-query:/share/search-query

    - /absolute/path/to/your/sources/:/app/