Appearance
aeppic HTTP Api
List of all aeppic api endpoints. The api is versioned using the url path and is generated during the build process by fastify
Version: 3.203.6
/
GET
Description
The root of the api
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Default Response | { "version": string, "loaded": dateTime } |
/_ping
GET
Description
Check the server status with a ping request.
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Default Response | { "pong": dateTime } |
/auth/access
POST
Summary
JWT Issuance for Authenticated User
Description
Issue a JWT based on provided scopes for an already authenticated user
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| body | body | No | { "scopes": [ string ] } |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Default Response | { "token": string } |
| 400 | Invalid request body | string |
| 401 | User not authenticated or invalid scopes | string |
| 500 | JWT issuance failed | string |
/packages/{packageIdentifier}/_list
GET
Summary
Returns a plain text of newline seperated file paths inside the package.
Description
Lists the files inside a package
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| packageIdentifier | path | The full package identifier based on the id of the package document and it's version seperated by @. Example 945a852b-1573-4783-963a-3f638081c48e@initial | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | A list of files inside the package, seperated by newlines (\n) | string |
| 304 | The package has not changed since the last request. The client can use the cached version of the package. | string |
/statics/_list
GET
Summary
Returns a json object with a list of all static files and their hashes.
Description
All static files served by the server for the web app can be listed with this endpoint. It can be used by a service worker to precache all static files.
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | A json object with a list of all static files and their hashes. | string |
| 304 | The list has not changed since the last request. The client can use the cached version of the list. | string |
/features/
GET
Summary
Returns a json object for all configured features
Description
All available and configured features
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | A list of features namespaces and their configuration | object |
| 304 | The list has not changed since the last request. The client can use the cached version of the list. | string |
/features/namespaces/
GET
Summary
Returns a json object for all configured features
Description
All available and configured features in a namespace
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| namespace | path | The full namespace of the features to read | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | A list of features namespaces and their configuration | object |
| 304 | The list has not changed since the last request. The client can use the cached version of the list. | string |