@dpype/rest-at-rest NPM

Everything API Endpoints

This document outlines the API endpoints exposed by the "everything" API. The base path for all endpoints is /v[x = positive number]. Current x is 0.

Authentication:

/auth/refreshToken (POST): Refreshes an expired access token using a refresh token.
/auth/otp/request (POST): Requests a One-Time Password (OTP) for a resource.
/auth/otp/exchange (POST): Verifies an OTP and potentially exchanges it for an authentication session (details not provided).

Resource Management:

/api/{collectionName}/{resourceName}:
- POST: Creates a new resource within a specified collection.
- GET: Retrieves a list of resources within a specified collection.
/api/{collectionName}/{resourceName}/{resourceId}:
- POST, PATCH, PUT: Updates an existing resource identified by its resourceId.
- GET: Retrieves a specific resource identified by its resourceId.

Resource Actions:

/api/{collectionName}/{resourceName}/{resourceId}/actions/{actionType}/{destination} (POST): Performs an action on a resource. The specific action type and destination are not documented in the provided information.

Resource Permissions:

/api/{collectionName}/{resourceName}/{resourceId}/permissions/{actionType} (POST): Assigns a permission level (specific action type not documented) to a resource.

Notes:

/{collectionName} and /{resourceName} are placeholders for the collection and resource names, respectively.
/{resourceId} is a placeholder for the unique identifier of a specific resource.
Details about the specific actionType and destination used in the resource actions route are not available.
Similarly, details about the specific actionType used in the resource permissions route are not available.