Skip to content

Commit 0bc98a0

Browse files
committed
New IIIF API documentation
1 parent bc46d20 commit 0bc98a0

16 files changed

Lines changed: 139 additions & 12 deletions
File renamed without changes.

Markdowns/Server API/2. Authentication.md renamed to Markdowns/1. Server API/2. Authentication.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# 2. Authentication
22

3-
> [!NOTE]
4-
> Currently, API tokens are not opened for public users. To request an API token, please contact the administrator of
5-
> the IAW platform.
3+
```{note}
4+
Currently, API tokens are not opened for public users. To request an API token, please contact the administrator of
5+
the IAW platform.
6+
```
67

78
IAW Server uses API tokens for external clients to authenticate the requests. The token should be included in the
89
`Authorization` header as a `Bearer` token. For example, a standard API request header would be like:
File renamed without changes.
File renamed without changes.
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ POST /images/local
4141

4242
Create an image from a local image file.
4343

44-
> [!NOTE]
45-
> This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
44+
```{note}
45+
This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
46+
```
4647

4748
##### Request
4849

@@ -63,8 +64,9 @@ POST /images/remote
6364

6465
Create an image from a remote image file.
6566

66-
> [!NOTE]
67-
> This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
67+
```{note}
68+
This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
69+
```
6870

6971
##### Request
7072

@@ -84,8 +86,9 @@ POST /images/iiif
8486

8587
Create an image from an external IIIF image.
8688

87-
> [!NOTE]
88-
> This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
89+
```{note}
90+
This API only creates an isolated image. To add the image to an image set, use the [image set API](#image-sets).
91+
```
8992

9093
##### Request
9194

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)