Skip to content

Commit

Permalink
UPDATE: complete docs for tags, subdomain
Browse files Browse the repository at this point in the history
  • Loading branch information
BaggerFast committed Jun 2, 2024
1 parent 07e7ad2 commit e086fb4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
22 changes: 17 additions & 5 deletions doc-app/docs/api/user/subdomains.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Subdomains
Subdomains are important because all users interact with them directly, bypassing the domain controller.

### Base requirements
- Auth: `Bearer token`
Expand All @@ -10,10 +11,10 @@
- Max elements for 1 domain for user: `3`


> | name | type | data type | description |
> |-----------|----------|-----------|-------------------|
> | domainUid | required | UUID | domain uid |
> | value | required | string | subdomain address |
> | name | type | data type | description |
> |-----------|-------------------|-----------|-------------------|
> | domainUid | required | UUID | domain uid |
> | value | required / unique | string | subdomain address |
### Validation
- <u>value</u>
Expand All @@ -40,6 +41,12 @@
}
```

### Errors
- [Not unique](../misc/errors.md#notunique)
- [Not valid](../misc/errors.md#notvalid)
- [Too many records](../misc/errors.md#tomanyrecords)


## GET
Get all user domains data
- Method: `GET`
Expand Down Expand Up @@ -78,4 +85,9 @@ Get all user domains data
```

## DELETE / `{id}`
- Method: `DELETE`
- Method: `DELETE`
- Url: `/api/v1/user/subdomains`

### Errors
- [Not found](../misc/errors.md#errors)
- [Is using](../misc/errors.md#isusing)
2 changes: 2 additions & 0 deletions doc-app/docs/api/user/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Each tag is associated with a specific **user**
Get all user tags
- Method: `GET`
- Url: `/api/v1/user/tags`
- Create: automate [with link](../user/links.md#create)


### Response (200)

Expand Down

0 comments on commit e086fb4

Please sign in to comment.