diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-06-11 12:39:28 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-06-11 12:39:28 -0400 |
| commit | 6e6b068ae2adc8c5ef8acb633dcadfbdc3221b61 (patch) | |
| tree | 79831028416b0d6934f32961a3fc77d8b004369e /docs/api/initial-setup.md | |
| parent | 1f009e06fd6db82a91536eec88ef3232267385bf (diff) | |
tools/reformat
Diffstat (limited to 'docs/api/initial-setup.md')
| -rw-r--r-- | docs/api/initial-setup.md | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/docs/api/initial-setup.md b/docs/api/initial-setup.md index 0179397..a3f6506 100644 --- a/docs/api/initial-setup.md +++ b/docs/api/initial-setup.md @@ -15,7 +15,6 @@ stateDiagram-v2 New instances of this service require an initial setup step before they can fully enter service. This setup is performed online, via the API endpoints in this section. - ## Requests before setup completed Before the service is set up, all API endpoints, other than those specifically documented as exceptions, will return a status of @@ -23,12 +22,11 @@ Before the service is set up, all API endpoints, other than those specifically d Initial setup can be completed only once. - ## `POST /api/setup` Initial setup performs the following tasks: -* Create the first user for the service. +- Create the first user for the service. This is the only user that does not require an [invitation](./invitations.md). @@ -48,7 +46,7 @@ Initial setup performs the following tasks: The request must have the following fields: | Field | Type | Description | -|:-----------|:-------|:---------------------------------------------| +| :--------- | :----- | :------------------------------------------- | | `name` | string | The initial login's name. | | `password` | string | The initial login's password, in plain text. | @@ -56,11 +54,11 @@ The request must have the following fields: The proposed `name` must be valid. The precise definition of valid is still up in the air, but, at minimum: -* It must be non-empty. -* It must not be "too long." (Currently, 64 characters is too long.) -* It must begin with a printing character. -* It must end with a printing character. -* It must not contain runs of multiple whitespace characters. +- It must be non-empty. +- It must not be "too long." (Currently, 64 characters is too long.) +- It must begin with a printing character. +- It must end with a printing character. +- It must not contain runs of multiple whitespace characters. ### Success @@ -79,7 +77,7 @@ This endpoint will respond with a status of The response will include the following fields: | Field | Type | Description | -|:-------|:-------|:---------------------------------------------------------------------------------------------------------------------------------------------------| +| :----- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | A unique identifier for the newly-created user. This can be used to associate the user with other events, or to make API calls targeting the user. | | `name` | string | The user's name. | @@ -100,4 +98,3 @@ This endpoint will respond with a status of `400 Bad Request` if the proposed `n Once completed, this operation cannot be performed a second time. Subsequent requests to this endpoint will respond with a status of `409 Conflict`. - |