Hi,
Here are some suggestions when preparing the documents for the REST API.
There are various ways of doing this. Embed swagger into a frame is the
first method [1]. As the second method, swagger APIs can be hosted [2] as
well. Also, if you like, you can generate static html pages from swagger
[3
As a platform we are moving more towards REST API and we have already
implemented most of the required components for complete story.
If you are looking for securing REST APIs with Basic Auth, OAuth, XACML
then all these feature are developed as CXF interceptors.
So do not spent time to reinvent th
Hi Natasha,
Giving you a small suggestion to port the documentation to Swagger [1] as
there are many advantages.
1. It is a well structured way of documenting APIs and it is used by many
organizations.
2. Users of your API can use the swagger doc to generate clients. There are
lots of tools that
I created a documentation jira and attached the api doc.
Thanks
Natasha
On Fri, Dec 11, 2015 at 4:23 PM, Nandika Jayawardana
wrote:
> Lets attach the doc to a documentation jira so that api is added to the
> documentation.
>
> Regards
> Nandika
>
> On Thu, Dec 10, 2015 at 7:03 PM, Natasha Wijes
Lets attach the doc to a documentation jira so that api is added to the
documentation.
Regards
Nandika
On Thu, Dec 10, 2015 at 7:03 PM, Natasha Wijesekara
wrote:
> Hi,
>
> @Vinod, I used the format given in the Activiti rest api documentation to
> include the response codes.
>
> @Nuwan, I have
Hi,
@Vinod, I used the format given in the Activiti rest api documentation to
include the response codes.
@Nuwan, I have updated the user guide with the response codes and the
sample success responses.
Thanks,
Natasha
On Thu, Dec 10, 2015 at 8:39 AM, Vinod Kavinda wrote:
> Hi Natasha,
> You c
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]
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 Pallew
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 wrote:
> Hi,
>
> I
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 wrote:
> [Adding Architecture group]
>
> On Tue, Dec 8, 2015 at 2
[Adding Architecture group]
On Tue, Dec 8, 2015 at 2:45 PM, Natasha Wijesekara 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 p
11 matches
Mail list logo
