Hi Natasha, You can use the format used in Activiti rest api documentations [1] for this also. It includes response codes and sample success responses.
@Dinithi, we are doing basic authentication using the security handler [2] AFAIK. [1] - http://www.activiti.org/userguide/#_get_a_deployment [2] - https://github.com/wso2/carbon-business-process/blob/master/components/bpmn/bpmn-rest/src/main/java/org/wso2/carbon/bpmn/rest/security/AuthenticationHandler.java Regards, Vinod Kavinda On Thu, Dec 10, 2015 at 7:30 AM, Dinithi De Silva <[email protected]> wrote: > Hi Natasha, > > How are you going to ensure the security of the APIs? Have you thought of > using any security models? > > You can use permission/role based model in order to achieve this. Just > make sure which APIs need the administrative privileges. > > Thanks. > > > On Wed, Dec 9, 2015 at 9:30 PM, Nuwan Pallewela <[email protected]> wrote: > >> Hi Natasha, >> >> Great work. >> What happens if an invalid request or request with an illegal argument >> sent to the API ? >> It is better to have those response messages or response status code also >> in the documentation. >> >> Thanks, >> Nuwan >> >> On Wed, Dec 9, 2015 at 5:08 PM, Natasha Wijesekara <[email protected]> >> wrote: >> >>> Hi, >>> >>> I documented a user guide which contains details about the new rest API >>> implemented to generate the statistics for bpmn. >>> Appreciate any suggestions and comments. >>> >>> Thanks, >>> Natasha >>> >>> On Tue, Dec 8, 2015 at 4:44 PM, Vinod Kavinda <[email protected]> wrote: >>> >>>> [Adding Architecture group] >>>> >>>> On Tue, Dec 8, 2015 at 2:45 PM, Natasha Wijesekara <[email protected]> >>>> wrote: >>>> >>>>> Hi , >>>>> >>>>> Currently the statistics generated for the bpmn-explorer is generated >>>>> using jaggery. When the work load is high, the bpmn-explorer takes a >>>>> longer time to generate these statistics which causes performance issues. >>>>> >>>>> As a solution I am working a new stats REST api to generate these >>>>> statistics at the back-end. This reduces the work load and thereby solves >>>>> the performance issues caused during peak times (when the workload is at >>>>> its maximum). >>>>> >>>>> After taking in data about the bpmn processes, tasks and users >>>>> involved, the api processes these data into meaningful statistics.These >>>>> statistics generated is used in the bpmn-explorer reporting dashboard to >>>>> generate the statistical graphs. >>>>> >>>>> The statistics generated includes: >>>>> >>>>> 1) Average time duration for all completed processes. >>>>> The user has the option to either view all completed processes or the >>>>> top 10 processes which finished within a short time duration or the top 10 >>>>> processes which took a long time duration to finish. >>>>> >>>>> 2) Average time duration of tasks of a completed process. >>>>> The user can select the completed process from the combo box and view >>>>> the average time duration. >>>>> >>>>> 3) User and the no. of tasks he/she has completed upto now. >>>>> >>>>> 4) Average time taken by each user to complete the tasks assigned to >>>>> him/her. >>>>> >>>>> 5) Task demand variation over time i.e. no. of tasks started and no. >>>>> of tasks completed in each month. This is useful for resource allocation >>>>> purposes. >>>>> >>>>> 6) Process demand variation over time i.e. no. of processes started >>>>> and no. of processes completed in each month regardless of a specific >>>>> user. >>>>> This is useful for resource allocation purposes. >>>>> >>>>> 7) User Performance i.e. Task demand variation of users separately >>>>> over time i.e. no. of tasks started and no. of tasks completed in each >>>>> month. This is useful for resource allocation purposes. >>>>> >>>>> I have attached the class diagram of the REST api. The new stats REST >>>>> api will be integrated with the existing bpmn REST api. >>>>> Appreciate any suggestions and comments. >>>>> >>>>> Thanks, >>>>> -- >>>>> *Natasha Wijesekare* >>>>> >>>>> *Software Engineering Intern, WSO2 Inc: http://wso2.com >>>>> <http://wso2.com/>* >>>>> *email : [email protected] <[email protected]>* >>>>> *mobile: +94 771358651 <%2B94%20771358651>* >>>>> >>>> >>>> >>>> >>>> -- >>>> Vinod Kavinda >>>> Software Engineer >>>> *WSO2 Inc. - lean . enterprise . middleware <http://www.wso2.com>.* >>>> Mobile : +94 (0) 712 415544 >>>> Blog : http://soatechflicks.blogspot.com/ >>>> >>>> >>> >>> >>> -- >>> *Natasha Wijesekare* >>> >>> *Software Engineering Intern, WSO2 Inc: http://wso2.com >>> <http://wso2.com/>* >>> *email : [email protected] <[email protected]>* >>> *mobile: +94 771358651 <%2B94%20771358651>* >>> >>> _______________________________________________ >>> Dev mailing list >>> [email protected] >>> http://wso2.org/cgi-bin/mailman/listinfo/dev >>> >>> >> >> >> -- >> ---------------------------------------------------------- >> >> *Nuwan Chamara Pallewela* >> >> >> *Software Engineer* >> >> *WSO2, Inc. *http://wso2.com >> *lean . enterprise . middleware* >> >> Email *[email protected] <[email protected]>* >> Mobile *+94719079739 <%2B94719079739>@* >> >> >> >> _______________________________________________ >> Architecture mailing list >> [email protected] >> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture >> >> > > > -- > *Dinithi De Silva* > Associate Software Engineer, WSO2 Inc. > m:+94716667655 | e:[email protected] | w: www.wso2.com > | a: #20, Palm Grove, Colombo 03 > > _______________________________________________ > Dev mailing list > [email protected] > http://wso2.org/cgi-bin/mailman/listinfo/dev > > -- Vinod Kavinda Software Engineer *WSO2 Inc. - lean . enterprise . middleware <http://www.wso2.com>.* Mobile : +94 (0) 712 415544 Blog : http://soatechflicks.blogspot.com/
_______________________________________________ Architecture mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
