Skip to content

Commit e1b1db1

Browse files
committed
doc: update doc links
1 parent bda6602 commit e1b1db1

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ The usage of the SDK has been explained below
5151

5252
This method allows you to create a URL using the path where the image exists and the URL
5353
endpoint(url_endpoint) you want to use to access the image. You can refer to the documentation
54-
[here](https://docs.imagekit.io/imagekit-docs/url-endpoints) to read more about URL endpoints
55-
in ImageKit and the section about [image origins](https://docs.imagekit.io/imagekit-docs/configure-origin) to understand
54+
[here](https://docs.imagekit.io/integration/url-endpoints) to read more about URL endpoints
55+
in ImageKit and the section about [image origins](https://docs.imagekit.io/integration/configure-origin) to understand
5656
about paths with different kinds of origins.
5757

5858

@@ -100,7 +100,7 @@ The ```.url()``` method accepts the following parameters
100100
| url_endpoint | Optional. The base URL to be appended before the path of the image. If not specified, the URL Endpoint specified at the time of SDK initialization is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
101101
| path | Conditional. This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter need to be specified for URL generation. |
102102
| src | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter need to be specified for URL generation. |
103-
| transformation | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a [chained transformation](https://docs.imagekit.io/imagekit-docs/chained-transformations) can be specified as different objects of the array. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. |
103+
| transformation | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a [chained transformation](https://docs.imagekit.io/features/image-transformations/chained-transformations) can be specified as different objects of the array. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. |
104104
| transformation_position | Optional. Default value is `path` that places the transformation string as a path parameter in the URL. Can also be specified as `query` which adds the transformation string as the query parameter `tr` in the URL. If you use `src` parameter to create the URL, then the transformation string is always added as a query parameter. |
105105
| query_parameters | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful, if you want to add some versioning parameter to your URLs. |
106106
| signed | Optional. Boolean. Default is `false`. If set to `true`, the SDK generates a signed image URL adding the image signature to the image URL. This can only be used if you are creating the URL with the `url_endpoint` and `path` parameters, and not with the `src` parameter. |
@@ -133,7 +133,7 @@ https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300%2Cw-
133133

134134
**2. Sharpening and contrast transforms and a progressive JPG image**
135135

136-
There are some transforms like [Sharpening](https://docs.imagekit.io/imagekit-docs/image-enhancement---color-manipulation)
136+
There are some transforms like [Sharpening](https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation)
137137
that can be added to the URL with or without any other value. To use such transforms without specifying a value, specify
138138
the value as "-" in the transformation object, otherwise, specify the value that you want to be
139139
added to this transformation.
@@ -179,7 +179,7 @@ https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&i
179179

180180
**List of transformations**
181181

182-
The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/imagekit-docs/image-transformations).
182+
The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations).
183183
The SDK gives a name to each transformation parameter, making the code simpler, making the code simpler and readable.
184184
If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the
185185
transformation code from ImageKit docs as the name when using in the ```url``` function.
@@ -232,13 +232,13 @@ transformation code from ImageKit docs as the name when using in the ```url``` f
232232
## File Upload
233233

234234
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media library. It
235-
accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/imagekit-docs/server-side-file-upload).
235+
accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload).
236236

237237
The `upload()` method requires at least the `file` and the `file_name` parameter to upload a file and returns
238238
a callback with the `error` and `result` as arguments. You can pass other parameters supported by the
239239
ImageKit upload API using the same parameter name as specified in the upload API documentation. For example, to
240240
specify tags for a file at the time of upload use the tags parameter as specified in the
241-
[documentation here](https://docs.imagekit.io/imagekit-docs/server-side-file-upload)
241+
[documentation here](https://docs.imagekit.io/media-library/overview/image-tags)
242242

243243

244244
Simple usage
@@ -427,13 +427,13 @@ be `None`
427427

428428
## File Management
429429

430-
The SDK provides a simple interface for all the [media APIs mentioned here](https://docs.imagekit.io/imagekit-docs/media-api)
430+
The SDK provides a simple interface for all the [media APIs mentioned here](https://docs.imagekit.io/api-reference/media-api)
431431
to manage your files. This also returns `error` and `result`, error will be `None` if API succeeds.
432432

433433
**1. List & Search Files**
434434

435435
Accepts an object specifying the parameters to be used to list and search files. All parameters specified
436-
in the [documentation here](https://docs.imagekit.io/imagekit-docs/list-and-search-files-api) can be passed as is with the
436+
in the [documentation here](https://docs.imagekit.io/api-reference/media-api/list-and-search-files#list-and-search-file-api) can be passed as is with the
437437
correct values to get the results.
438438

439439
```python
@@ -444,14 +444,14 @@ correct values to get the results.
444444
)
445445
```
446446
**2. Get File Details**
447-
Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/get-file-details-api)
447+
Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-details)
448448

449449
```python
450450
imagekit.get_file_details(file_id)
451451
```
452452

453453
**3. Get File Metadata**
454-
Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/imagekit-docs)
454+
Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files)
455455
```python
456456
imagekit.get_metadata(file_id)
457457
```
@@ -465,7 +465,7 @@ imagekit.get_remote_url_metadata(remote_file_url)
465465
```
466466

467467
**4. Update File Details**
468-
Update parameters associated with the file as per the [API documentation here](https://docs.imagekit.io/imagekit-docs).
468+
Update parameters associated with the file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/update-file-details).
469469
The first argument to the `update_field_details` method is the file ID and the second argument is an object with the
470470
parameters to be updated.
471471

@@ -477,7 +477,7 @@ imagekit.update_file_details("file_id", {
477477
```
478478

479479
**6. Delete File**
480-
Delete a file as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/delete-file-api). The method accepts the file ID of the file that has to be
480+
Delete a file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-file). The method accepts the file ID of the file that has to be
481481
deleted.
482482

483483
```python
@@ -493,15 +493,15 @@ imagekit.bulk_delete(["file_id1", "file_id2"])
493493
```
494494

495495
**6. Purge Cache**
496-
Programmatically issue a cache clear request as clear request as pet the [API documentation here](https://docs.imagekit.io/imagekit-docs/purge-cache-api).
496+
Programmatically issue a cache clear request as clear request as pet the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache).
497497
Accepts the full URL of the file for which the cache has to be cleared.
498498
```python
499499
imagekit.purge_cache(full_url)
500500
```
501501
**7. Purge Cache Status**
502502

503503
Get the purge cache request status using the request ID returned when a purge cache request gets submitted as pet the
504-
[API documentation here](https://docs.imagekit.io/imagekit-docs/purge-cache-status-api)
504+
[API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache-status)
505505

506506
```python
507507
imagekit.get_purge_cache_status(cache_request_id)
@@ -541,7 +541,7 @@ signature are always returned in the response, no matter if they are provided as
541541
**Distance calculation between two pHash values**
542542

543543
Perceptual hashing allows you to constructing a has value that uniquely identifies an input image based on the contents
544-
of an image. [imagekit.io metadata API](https://docs.imagekit.io/imagekit-docs/metadata-api) returns the pHash
544+
of an image. [imagekit.io metadata API](https://docs.imagekit.io/api-reference/metadata-api) returns the pHash
545545
value of an image in the response. You can use this value to find duplicate, near duplicate(similar) image by calculating
546546
distance between the two images.
547547

@@ -585,7 +585,7 @@ For any feedback or to report any issues or general implementation support pleas
585585

586586
## Links
587587

588-
* [Documentation](https://docs.imagekit.io/imagekit-docs)
588+
* [Documentation](https://docs.imagekit.io/)
589589

590590
* [Main Website](https://imagekit.io/)
591591

0 commit comments

Comments
 (0)