Skip to content

Commit

Permalink
update API docs
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Hartmann <[email protected]>
  • Loading branch information
Chartman123 committed Aug 18, 2024
1 parent 9dab01d commit fab516b
Show file tree
Hide file tree
Showing 2 changed files with 907 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Forms Public API

## API v2 is now deprecated and will be removed with Forms v5. Please see documentation for [API v3](API_v3.md)

This file contains the API-Documentation. For more information on the returned Data-Structures, please refer to the [corresponding Documentation](DataStructure.md).

## Generals
Expand Down Expand Up @@ -27,6 +29,7 @@ This file contains the API-Documentation. For more information on the returned D

### Deprecation info

- Starting with Forms v4.3 API v2 will be deprecated and removed with Forms v5: Please see the documentation for [API v3](API_v3.md)
- Starting with API v2.2 all endpoints that update data will use PATCH/PUT as method. POST is now deprecated and will be removed in API v3

### Breaking Changes on API v2
Expand Down
Loading

0 comments on commit fab516b

Please sign in to comment.