-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CIRCSTORE-509: Create CRUD API for storing circulation settings (#466)
* CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Create CRUD API for storing circulation settings * CIRCSTORE-509 Fix formatting Co-authored-by: OleksandrVidinieiev <[email protected]> --------- Co-authored-by: Alexander Kurash <[email protected]> Co-authored-by: OleksandrVidinieiev <[email protected]>
- Loading branch information
3 people
authored
Jun 11, 2024
1 parent
2d74a75
commit 81c55e3
Showing
17 changed files
with
521 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "title": "Circulation Setting Schema", | ||
| "description": "Circulation setting", | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "description": "ID of the circulation setting", | ||
| "type": "string", | ||
| "$ref": "raml-util/schemas/uuid.schema" | ||
| }, | ||
| "name": { | ||
| "description": "Circulation setting name", | ||
| "type": "string" | ||
| }, | ||
| "value": { | ||
| "description": "Circulation setting", | ||
| "type": "object", | ||
| "additionalProperties": true | ||
| }, | ||
| "metadata": { | ||
| "description": "Metadata about creation and changes, provided by the server (client should not provide)", | ||
| "type": "object", | ||
| "$ref": "raml-util/schemas/metadata.schema" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "id", | ||
| "name", | ||
| "value" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| #%RAML 1.0 | ||
| title: Circulation Settings Storage | ||
| version: v1.0 | ||
| protocols: [ HTTP, HTTPS ] | ||
| baseUri: http://localhost:9130 | ||
|
|
||
| documentation: | ||
| - title: Circulation Settings Storage API | ||
| content: <b>Storage for circulation settings</b> | ||
|
|
||
| traits: | ||
| language: !include raml-util/traits/language.raml | ||
| pageable: !include raml-util/traits/pageable.raml | ||
| searchable: !include raml-util/traits/searchable.raml | ||
| validate: !include raml-util/traits/validation.raml | ||
|
|
||
| types: | ||
| circulation-setting: !include circulation-setting.json | ||
| circulation-settings: !include circulation-settings.json | ||
| errors: !include raml-util/schemas/errors.schema | ||
| parameters: !include raml-util/schemas/parameters.schema | ||
|
|
||
| resourceTypes: | ||
| collection: !include raml-util/rtypes/collection.raml | ||
| collection-item: !include raml-util/rtypes/item-collection.raml | ||
|
|
||
| /circulation-settings-storage: | ||
| /circulation-settings: | ||
| type: | ||
| collection: | ||
| exampleCollection: !include examples/circulation-settings.json | ||
| exampleItem: !include examples/circulation-setting.json | ||
| schemaCollection: circulation-settings | ||
| schemaItem: circulation-setting | ||
| post: | ||
| is: [validate] | ||
| description: Create a new circulation setting | ||
| body: | ||
| application/json: | ||
| type: circulation-setting | ||
| responses: | ||
| 201: | ||
| description: "Circulation setting has been created" | ||
| body: | ||
| application/json: | ||
| type: circulation-setting | ||
| 500: | ||
| description: "Internal server error" | ||
| body: | ||
| text/plain: | ||
| example: "Internal server error" | ||
| get: | ||
| is: [validate, pageable, searchable: { description: "with valid searchable fields", example: "id=497f6eca-6276-4993-bfeb-98cbbbba8f79" }] | ||
| description: Get all circulation settings | ||
| responses: | ||
| 200: | ||
| description: "Circulation settings successfully retreived" | ||
| body: | ||
| application/json: | ||
| type: circulation-settings | ||
| 500: | ||
| description: "Internal server error" | ||
| body: | ||
| text/plain: | ||
| example: "Internal server error" | ||
| /{circulationSettingsId}: | ||
| type: | ||
| collection-item: | ||
| exampleItem: !include examples/circulation-setting.json | ||
| schema: circulation-setting | ||
| get: | ||
| responses: | ||
| 200: | ||
| description: "Circulation setting successfully retreived" | ||
| body: | ||
| application/json: | ||
| type: circulation-setting | ||
| 500: | ||
| description: "Internal server error" | ||
| body: | ||
| text/plain: | ||
| example: "Internal server error" | ||
| put: | ||
| is: [ validate ] | ||
| body: | ||
| application/json: | ||
| type: circulation-setting | ||
| responses: | ||
| 204: | ||
| description: "Circulation settings have been saved." | ||
| 500: | ||
| description: "Internal server error" | ||
| body: | ||
| text/plain: | ||
| example: "Internal server error" | ||
| delete: | ||
| is: [ validate ] | ||
| responses: | ||
| 204: | ||
| description: "Circulation settings deleted" | ||
| 500: | ||
| description: "Internal server error" | ||
| body: | ||
| text/plain: | ||
| example: "Internal server error" | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "description": "Collection of Circulation settings", | ||
| "type": "object", | ||
| "properties": { | ||
| "circulationSettings": { | ||
| "description": "List of circulation settings", | ||
| "id": "circulationSettings", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "$ref": "circulation-setting.json" | ||
| } | ||
| }, | ||
| "totalRecords": { | ||
| "type": "integer" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "circulationSettings", | ||
| "totalRecords" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", | ||
| "name": "Sample settings", | ||
| "value": { | ||
| "org.folio.circulation.settings": "true" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "circulationSettings": [ | ||
| { | ||
| "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", | ||
| "name": "Sample settings", | ||
| "value": { | ||
| "org.folio.circulation.settings": "true" | ||
| } | ||
| } | ||
| ], | ||
| "totalRecords": 1 | ||
| } |
22 changes: 22 additions & 0 deletions
22
src/main/java/org/folio/persist/CirculationSettingsRepository.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package org.folio.persist; | ||
|
|
||
| import static org.folio.rest.persist.PgUtil.postgresClient; | ||
| import static org.folio.support.ModuleConstants.CIRCULATION_SETTINGS_TABLE; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import org.folio.rest.jaxrs.model.CirculationSetting; | ||
|
|
||
| import io.vertx.core.Context; | ||
|
|
||
| public class CirculationSettingsRepository | ||
| extends AbstractRepository<CirculationSetting> { | ||
|
|
||
| public CirculationSettingsRepository(Context context, Map<String, | ||
| String> okapiHeaders) { | ||
|
|
||
| super(postgresClient(context, okapiHeaders), CIRCULATION_SETTINGS_TABLE, | ||
| CirculationSetting.class); | ||
| } | ||
|
|
||
| } |
67 changes: 67 additions & 0 deletions
67
src/main/java/org/folio/rest/impl/CirculationSettingsAPI.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package org.folio.rest.impl; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import javax.ws.rs.core.Response; | ||
|
|
||
| import org.folio.rest.jaxrs.model.CirculationSetting; | ||
| import org.folio.rest.jaxrs.resource.CirculationSettingsStorage; | ||
| import org.folio.service.CirculationSettingsService; | ||
|
|
||
| import io.vertx.core.AsyncResult; | ||
| import io.vertx.core.Context; | ||
| import io.vertx.core.Handler; | ||
|
|
||
| public class CirculationSettingsAPI implements CirculationSettingsStorage { | ||
|
|
||
| @Override | ||
| public void postCirculationSettingsStorageCirculationSettings(String lang, | ||
| CirculationSetting circulationSettings, Map<String, String> okapiHeaders, | ||
| Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) { | ||
|
|
||
| new CirculationSettingsService(vertxContext, okapiHeaders) | ||
| .create(circulationSettings) | ||
| .onComplete(asyncResultHandler); | ||
| } | ||
|
|
||
| @Override | ||
| public void getCirculationSettingsStorageCirculationSettings(int offset, | ||
| int limit, String query, String lang, Map<String, String> okapiHeaders, | ||
| Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) { | ||
|
|
||
| new CirculationSettingsService(vertxContext, okapiHeaders) | ||
| .getAll(offset, limit, query) | ||
| .onComplete(asyncResultHandler); | ||
| } | ||
|
|
||
| @Override | ||
| public void getCirculationSettingsStorageCirculationSettingsByCirculationSettingsId( | ||
| String circulationSettingsId, String lang, Map<String, String> okapiHeaders, | ||
| Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) { | ||
|
|
||
| new CirculationSettingsService(vertxContext, okapiHeaders) | ||
| .findById(circulationSettingsId) | ||
| .onComplete(asyncResultHandler); | ||
| } | ||
|
|
||
| @Override | ||
| public void putCirculationSettingsStorageCirculationSettingsByCirculationSettingsId( | ||
| String circulationSettingsId, String lang, CirculationSetting entity, | ||
| Map<String, String> okapiHeaders, Handler<AsyncResult<Response>> asyncResultHandler, | ||
| Context vertxContext) { | ||
|
|
||
| new CirculationSettingsService(vertxContext, okapiHeaders) | ||
| .update(circulationSettingsId, entity) | ||
| .onComplete(asyncResultHandler); | ||
| } | ||
|
|
||
| @Override | ||
| public void deleteCirculationSettingsStorageCirculationSettingsByCirculationSettingsId( | ||
| String circulationSettingsId, String lang, Map<String, String> okapiHeaders, | ||
| Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) { | ||
|
|
||
| new CirculationSettingsService(vertxContext, okapiHeaders) | ||
| .delete(circulationSettingsId) | ||
| .onComplete(asyncResultHandler); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.