Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-03-05 03:40:56 +01:00
Code Issues Packages Projects Releases Activity

improve openapi description

Browse Source
This commit is contained in:
Sebastian Sdorra
2020-02-25 10:12:04 +01:00
parent b3a9b8a42c
commit 039ea46958
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
scm-webapp/src/main/doc/openapi.md
View File

@@ -7,9 +7,9 @@ valid token using the authentication endpoint and copy the response body.
SCM-Manager defines a modern ["Level 3"-REST API](https://martinfowler.com/articles/richardsonMaturityModel.html).
Using the HATEOAS architecture for REST allows us to provide discoverable and self explanatory endpoint definitions.
The responses are build using the [HAL format](http://stateless.co/hal_specification.html) as JSON or XML.
The responses are build using the [HAL JSON format](http://stateless.co/hal_specification.html).
HAL makes the API human-friendly and simplifies the communication between the frontend and the server using links and embedded resources.
We highly suggest using the HAL links when creating new functions for the SCM-Manager since they are consistent and can be
We highly suggest using HAL links when creating new functions for SCM-Manager since they are consistent and can be
permission checked before being append to the response. The links and embedded resources can also be used by plugins, which can
define new resources or enrich existing ones.