Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

combine endpoints; deprecate old search endpoint and update readme #346

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Bug when adding visualization layers to an empty layer list [#331](https://github.com/IN-CORE/incore-services/issues/331)
- Bug when posting additional fields which need to be ignored [#338](https://github.com/IN-CORE/incore-services/issues/338)

### Changed
- Combine search and filter endpoints in project service [#344](https://github.com/IN-CORE/incore-services/issues/344)

## [1.27.1] - 2024-11-01
### Fixed
- Earthquake hazard visualization bounding box [#325](https://github.com/IN-CORE/incore-services/issues/325)
Expand Down
97 changes: 7 additions & 90 deletions server/project-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path**: `/project/api/projects`
- **Description**: Retrieve a list of all available projects, optionally filtered by parameters.
- **Query Parameters**:
- `name`, `creator`, `owner`, `region`, `type`, `space`, `skip`, `limit`
- `name`, `creator`, `owner`, `region`, `type`, `searchText`, `space`, `skip`, `limit`
- **Example**:
```http
GET /project/api/projects?name={name}&creator={creator}&skip={skip}&limit={limit}
```

#### **Search All Projects**

- **Method**: `GET`
- **Path**: `/project/api/projects/search`
- **Description**: Search for projects by name, description, creator, owner, and region.
- **Query Parameters**:
- `text`, `skip`, `limit`
- **Example**:
```http
GET /project/api/projects/search?text={text}&skip={skip}&limit={limit}
```

#### **Get Project by ID**

- **Method**: `GET`
Expand Down Expand Up @@ -158,25 +146,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- **Query Parameters**:
- `skip`, `limit`, `type`
- `skip`, `limit`, `type`, `searchText`
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/datasets
GET /project/api/projects/66c60ba518da486b1e9c08d5/datasets?searchText=Building Inventory
```

#### **Search Datasets belong to a Project**
- **Method**: `GET`
- **Path**: `/project/api/projects/{projectId}/datasets/search`
- **Description**: Search datasets associated with a specific project.
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- `text` (string) - Text to search.
- `limit` (int) - Number of datasets to return.
- `skip` (int) - Number of datasets to skip.
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/datasets/search?text=galveston&limit=10&skip=0
```

#### **Add Datasets to a Project**

Expand Down Expand Up @@ -283,27 +258,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- **Query Parameters**:
- `skip`, `limit`, `type`, `hazardType`, `inventoryType`
- `skip`, `limit`, `type`, `hazardType`, `inventoryType`, `searchText`
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/dfr3mappings
```

#### **Search Dfr3 mappings belong to a Project**

- **Method**: `GET`
- **Path**: `/project/api/projects/{projectId}/dfr3mappings/search`
- **Description**: Search dfr3 mappings associated with a specific project.
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- `text` (string) - Search query.
- `skip` (int) - Number of items to skip.
- `limit` (int) - Number of items to return.
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/dfr3mappings/search?text=fragility
```

#### **Add Dfr3 mappings to a Project**

- **Method**: `POST`
Expand Down Expand Up @@ -392,27 +352,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- **Query Parameters**:
- `skip`, `limit`, `type`
- `skip`, `limit`, `type`, `searchText`
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/hazards
```

#### **Search Hazards belong to a Project**

- **Method**: `GET`
- **Path**: `/project/api/projects/{projectId}/hazards/search`
- **Description**: Search hazards associated with a specific project.
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- `text` (string) - Search query.
- `skip` (int) - Number of items to skip.
- `limit` (int) - Number of items to return.
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/hazards/search?text=earthquake
```

#### **Add Hazards to a Project**

- **Method**: `POST`
Expand Down Expand Up @@ -564,26 +509,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- **Query Parameters**:
- `skip`, `limit`, `type`
- `skip`, `limit`, `type`, `searchText`
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/workflows
```

#### **Search Workflows belong to a Project**

- **Method**: `GET`
- **Path**: `/project/api/projects/{projectId}/workflows/search`
- **Description**: Search workflows associated with a specific project.
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- `text` (string) - Search query.
- `skip` (int) - Number of workflows to skip.
- `limit` (int) - Number of workflows to return.
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/workflows/search?text=retrofit_strategy_wf&skip=0&limit=10
```

#### **Add Workflows to a Project**

Expand Down Expand Up @@ -653,26 +584,12 @@ system, including creating, updating, and deleting projects, as well as managing
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- **Query Parameters**:
- `skip`, `limit`, `type`
- `skip`, `limit`, `type`, `searchText`
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/visualizations
```

#### **Search Visualizations belong to a Project**

- **Method**: `GET`
- **Path**: `/project/api/projects/{projectId}/visualizations/search`
- **Description**: Search visualizations associated with a specific project.
- **Path Parameter**:
- `projectId` (string) - ID of the project.
- `text` (string) - Search query.
- `skip` (int) - Number of visualizations to skip.
- `limit` (int) - Number of visualizations to return.
- **Example**:
```http
GET /project/api/projects/66c60ba518da486b1e9c08d5/visualizations/search?text=map&skip=0&limit=10
```

#### **Add Visualizations to a Project**

Expand Down
Loading
Loading