Add OapApi.v1 module
This commit is contained in:
30
docs/api/OapApiV1.md
Normal file
30
docs/api/OapApiV1.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# OapApiV1
|
||||
|
||||
URL: [`https://oaprotection.org/api/v1`](https://oaprotection.org/api/v1)
|
||||
|
||||
| method | path | description |
|
||||
| --- | --- | --- |
|
||||
| [getApplications](OapApiV1/getApplications.md) | `GET /applications` | Gets applications for the current user. |
|
||||
| [createApplication](OapApiV1/createApplication.md) | `POST /applications/` | Creates a new application for the current user. |
|
||||
| [getApplication](OapApiV1/getApplication.md) | `GET /applications/{id}` | Gets the specified application for the current user. |
|
||||
| [updateApplication](OapApiV1/updateApplication.md) | `PATCH /applications/{id}` | Updates the application. |
|
||||
|
||||
| data | description |
|
||||
| --- | --- |
|
||||
| [Application](OapApiV1/Application.md) | An application. |
|
||||
| [ApplicationCreateSet](OapApiV1/ApplicationCreateSet.md) | |
|
||||
| [ApplicationChangeSet](OapApiV1/ApplicationChangeSet.md) | |
|
||||
| [ApplicationTermsCreateSet](OapApiV1/ApplicationTermsCreateSet.md) | |
|
||||
| [ApplicationTerms](OapApiV1/ApplicationTerms.md) | |
|
||||
|
||||
| enum | description |
|
||||
| --- | --- |
|
||||
| [ApplicationStatus](OapApiV1/ApplicationStatus.md) | |
|
||||
|
||||
API providing OAP functionality for the application form, calculator and more.
|
||||
|
||||
## Heading
|
||||
|
||||
Use a primary heading to indicate the member name.
|
||||
|
||||
<!-- DO NOT EDIT: generated by fsdgenmd -->
|
||||
Reference in New Issue
Block a user