Skip to content

Commit d6c3522

Browse files
authored
Implementation updates (#381)
1 parent 9ae7f43 commit d6c3522

3 files changed

Lines changed: 993200 additions & 9 deletions

File tree

IMPLEMENTATION.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -184,15 +184,30 @@ Pass the coordinates as a comma-separated string of longitude and latitude pairs
184184

185185
## List of all endpoints
186186

187-
| HTTP Method | Path | Public | Pagination | Sort | Search |
188-
| ----------- | ------------------------------------------------------------------------ | ------ | ---------- | ---- | ------ |
189-
| GET | `/api/@next/public/planning_application/search` | YES | YES | YES | YES |
190-
| GET | `/api/@next/public/planning_application/{reference}` | YES | NO | NO | NO |
191-
| GET | `/api/@next/public/planning_application/{reference}/documents` | YES | YES | YES | YES |
192-
| GET | `/api/@next/public/planning_application/{reference}/comments/public` | YES | YES | YES | YES |
193-
| GET | `/api/@next/public/planning_application/{reference}/comments/specialist` | YES | YES | YES | YES |
194-
| POST | `/api/@next/planning_application/{reference}/comments/public` | NO | n/a | n/a | n/a |
195-
| POST | `/api/@next/planning_application/{reference}/comments/specialist` | NO | n/a | n/a | n/a |
187+
| HTTP Method | Path | Public | Pagination | Sort | Search |
188+
| ----------- | ---------------------------------------------------------------------------------- | ------ | ------------ | ---- | ------ |
189+
| GET | `/api/@next/public/applications` | YES | YES | YES | YES |
190+
| GET | `/api/@next/public/applications/{applicationId}` | YES | NO | NO | NO |
191+
| GET | `/api/@next/public/applications/{applicationId}/documents` | YES | YES | YES | YES |
192+
| GET | `/api/@next/public/applications/{applicationId}/documents/{documentId}` | YES | NO | NO | NO |
193+
| GET | `/api/@next/public/applications/{applicationId}/publicComments` | YES | YES | YES | YES |
194+
| GET | `/api/@next/public/applications/{applicationId}/publicComments/{publicCommentId}` | YES | NO | NO | NO |
195+
| GET | `/api/@next/public/applications/{applicationId}/specialistComments` | YES | YES | YES | YES |
196+
| GET | `/api/@next/public/applications/{applicationId}/specialistComments/{specialistId}` | YES | YES \*\*\*\* | YES | YES |
197+
| GET | `/api/@next/applications` | NO | YES | YES | YES |
198+
| GET | `/api/@next/applications/{applicationId}` | NO | NO | NO | NO |
199+
| GET | `/api/@next/applications/{applicationId}/documents` | NO | YES | YES | YES |
200+
| GET | `/api/@next/applications/{applicationId}/documents/{documentId}` | NO | NO | NO | NO |
201+
| GET | `/api/@next/applications/{applicationId}/publicComments` | NO | YES | YES | YES |
202+
| GET | `/api/@next/applications/{applicationId}/publicComments/{publicCommentId}` | NO | NO | NO | NO |
203+
| GET | `/api/@next/applications/{applicationId}/specialistComments` | NO | YES | YES | YES |
204+
| GET | `/api/@next/applications/{applicationId}/specialistComments/{specialistId}` | NO | YES | YES | YES |
205+
| POST | `/api/@next/applications/{applicationId}/publicComments` | NO | n/a | n/a | n/a |
206+
| POST | `/api/@next/applications/{applicationId}/specialistComments` | NO | n/a | n/a | n/a |
207+
208+
> [!WARNING]
209+
> The details below are out of date, latest details can be found in the [openapi.yaml](./openapi.yaml) file or the [openapi.json](./openapi.json) file.
210+
> You can see these files rendered in a more user friendly way using [Swagger Editor](https://swagger.io/tools/swagger-editor/) or using the Digital Planning Register's [API documentation page](https://dpr-backend-production-1345166d23b1.herokuapp.com/docs) ([swagger version](https://dpr-backend-production-1345166d23b1.herokuapp.com/swagger))
196211
197212
## Endpoints
198213

openapi.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)