Examples with ApiOperation com.wordnik.swagger.annotations.ApiOperation used on opensource projects

Example 86 with ApiOperation

use of com.wordnik.swagger.annotations.ApiOperation in project ma-modules-public by infiniteautomation.

the class DeviceNameController method deviceNames.

@ApiOperation(value = "List device names", response = String.class, responseContainer = "Set")
@RequestMapping(method = RequestMethod.GET, produces = { "application/json" })
public ResponseEntity<Set<String>> deviceNames(@RequestParam(value = "contains", required = false) String contains, HttpServletRequest request) {
    RestProcessResult<Set<String>> result = new RestProcessResult<Set<String>>(HttpStatus.OK);
    final User user = this.checkUser(request, result);
    if (result.isOk()) {
        DeviceAndPermissionCallback callback = new DeviceAndPermissionCallback(user);
        if (contains != null) {
            DataPointDao.instance.query(SELECT_DEVICENAME + " WHERE pt.deviceName LIKE ?", new Object[] { "%" + contains + "%" }, DEVICE_AND_PERMISSION_MAPPER, callback);
        } else {
            DataPointDao.instance.query(SELECT_DEVICENAME, new Object[] {}, DEVICE_AND_PERMISSION_MAPPER, callback);
        }
        return result.createResponseEntity(callback.results);
    }
    return result.createResponseEntity();
}

Example 87 with ApiOperation

use of com.wordnik.swagger.annotations.ApiOperation in project ma-modules-public by infiniteautomation.

the class EventsRestController method getById.

@ApiOperation(value = "Get event by ID", notes = "")
@RequestMapping(method = RequestMethod.GET, produces = { "application/json" }, value = "/{id}")
public ResponseEntity<EventInstanceModel> getById(@ApiParam(value = "Valid Event ID", required = true, allowMultiple = false) @PathVariable Integer id, HttpServletRequest request) {
    RestProcessResult<EventInstanceModel> result = new RestProcessResult<EventInstanceModel>(HttpStatus.OK);
    User user = this.checkUser(request, result);
    if (result.isOk()) {
        EventInstanceVO vo = EventInstanceDao.instance.get(id);
        if (vo == null) {
            result.addRestMessage(getDoesNotExistMessage());
            return result.createResponseEntity();
        }
        if (!Permissions.hasEventTypePermission(user, vo.getEventType())) {
            result.addRestMessage(getUnauthorizedMessage());
            return result.createResponseEntity();
        }
        EventInstanceModel model = new EventInstanceModel(vo);
        return result.createResponseEntity(model);
    }
    return result.createResponseEntity();
}

Example 88 with ApiOperation

use of com.wordnik.swagger.annotations.ApiOperation in project ma-modules-public by infiniteautomation.

the class EventsRestController method moduleDefinedQuery.

// TODO 2 new endpoints 1 for module defined query, 1 for explain all
@ApiOperation(value = "Query Events By Custom Module Defined Query", notes = "See explain-module-defined-queries for all options", response = EventInstanceModel.class, responseContainer = "Array")
@RequestMapping(method = RequestMethod.POST, value = "/module-defined-query")
public ResponseEntity<QueryDataPageStream<EventInstanceVO>> moduleDefinedQuery(@ApiParam(value = "Query Payload", required = true) @RequestBody(required = true) ModuleQueryModel model, @AuthenticationPrincipal User user, HttpServletRequest request) throws IOException {
    model.ensureValid(user, this.dao.tableName);
    ASTNode query = model.createQuery(user);
    return ResponseEntity.ok(getPageStream(query));
}

Example 89 with ApiOperation

use of com.wordnik.swagger.annotations.ApiOperation in project ma-modules-public by infiniteautomation.

the class EventsRestController method getActiveSummary.

@ApiOperation(value = "Get the active events summary", notes = "List of counts for all active events by type and the most recent active alarm for each.")
@RequestMapping(method = RequestMethod.GET, produces = { "application/json" }, value = "/active-summary")
public ResponseEntity<List<EventLevelSummaryModel>> getActiveSummary(HttpServletRequest request) {
    RestProcessResult<List<EventLevelSummaryModel>> result = new RestProcessResult<List<EventLevelSummaryModel>>(HttpStatus.OK);
    User user = this.checkUser(request, result);
    if (result.isOk()) {
        List<EventLevelSummaryModel> list = new ArrayList<EventLevelSummaryModel>();
        // This query is slow the first time as it must fill the UserEventCache
        List<EventInstance> events = Common.eventManager.getAllActiveUserEvents(user.getId());
        int lifeSafetyTotal = 0;
        EventInstance lifeSafetyEvent = null;
        int criticalTotal = 0;
        EventInstance criticalEvent = null;
        int urgentTotal = 0;
        EventInstance urgentEvent = null;
        int warningTotal = 0;
        EventInstance warningEvent = null;
        int importantTotal = 0;
        EventInstance importantEvent = null;
        int informationTotal = 0;
        EventInstance informationEvent = null;
        int noneTotal = 0;
        EventInstance noneEvent = null;
        int doNotLogTotal = 0;
        EventInstance doNotLogEvent = null;
        for (EventInstance event : events) {
            switch(event.getAlarmLevel()) {
                case AlarmLevels.LIFE_SAFETY:
                    lifeSafetyTotal++;
                    lifeSafetyEvent = event;
                    break;
                case AlarmLevels.CRITICAL:
                    criticalTotal++;
                    criticalEvent = event;
                    break;
                case AlarmLevels.URGENT:
                    urgentTotal++;
                    urgentEvent = event;
                    break;
                case AlarmLevels.WARNING:
                    warningTotal++;
                    warningEvent = event;
                    break;
                case AlarmLevels.IMPORTANT:
                    importantTotal++;
                    importantEvent = event;
                    break;
                case AlarmLevels.INFORMATION:
                    informationTotal++;
                    informationEvent = event;
                    break;
                case AlarmLevels.NONE:
                    noneTotal++;
                    noneEvent = event;
                    break;
                case AlarmLevels.DO_NOT_LOG:
                    doNotLogTotal++;
                    doNotLogEvent = event;
                    break;
            }
        }
        EventInstanceModel model;
        // Life Safety
        if (lifeSafetyEvent != null)
            model = new EventInstanceModel(lifeSafetyEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.LIFE_SAFETY), lifeSafetyTotal, model));
        // Critical Events
        if (criticalEvent != null)
            model = new EventInstanceModel(criticalEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.CRITICAL), criticalTotal, model));
        // Urgent Events
        if (urgentEvent != null)
            model = new EventInstanceModel(urgentEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.URGENT), urgentTotal, model));
        // Warning Events
        if (warningEvent != null)
            model = new EventInstanceModel(warningEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.WARNING), warningTotal, model));
        // Important Events
        if (importantEvent != null)
            model = new EventInstanceModel(importantEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.IMPORTANT), importantTotal, model));
        // Information Events
        if (informationEvent != null)
            model = new EventInstanceModel(informationEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.INFORMATION), informationTotal, model));
        // None Events
        if (noneEvent != null)
            model = new EventInstanceModel(noneEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.NONE), noneTotal, model));
        // Do Not Log Events
        if (doNotLogEvent != null)
            model = new EventInstanceModel(doNotLogEvent);
        else
            model = null;
        list.add(new EventLevelSummaryModel(AlarmLevels.CODES.getCode(AlarmLevels.DO_NOT_LOG), doNotLogTotal, model));
        return result.createResponseEntity(list);
    }
    return result.createResponseEntity();
}

Example 90 with ApiOperation

use of com.wordnik.swagger.annotations.ApiOperation in project ma-modules-public by infiniteautomation.

the class EventsRestController method query.

@ApiOperation(value = "Query Events", notes = "Query by posting AST Model", response = EventInstanceModel.class, responseContainer = "Array")
@RequestMapping(method = RequestMethod.POST, consumes = { "application/json" }, produces = { "application/json" }, value = "/query")
public ResponseEntity<QueryDataPageStream<EventInstanceVO>> query(@ApiParam(value = "Query", required = true) @RequestBody(required = true) ASTNode query, HttpServletRequest request) {
    RestProcessResult<QueryDataPageStream<EventInstanceVO>> result = new RestProcessResult<QueryDataPageStream<EventInstanceVO>>(HttpStatus.OK);
    User user = this.checkUser(request, result);
    if (result.isOk()) {
        query = addAndRestriction(query, new ASTNode("eq", "userId", user.getId()));
        return result.createResponseEntity(getPageStream(query));
    }
    return result.createResponseEntity();
}