Skip to content

Commit ac18429

Browse files
Update README.md
1 parent 3621add commit ac18429

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ The SDK provides a simple interface for all the [media APIs mentioned here](http
420420

421421
**1. List & Search Files**
422422

423-
Accepts an object specifying the parameters to be used to list and search files. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/media-api/list-and-search-files) can be passed as-is with the correct values to get the results.
423+
Accepts an object of class `GetFileListRequest` specifying the parameters to be used to list and search files. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/media-api/list-and-search-files) can be passed as-is with the correct values to get the results.
424424

425425
```java
426426
String[] tags = new String[3];
@@ -477,7 +477,7 @@ System.out.println(resultFileVersions.getResponseMetaData().getMap());
477477

478478
**4. Get File Version details**
479479

480-
Accepts the file ID and vesrion ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-version-details).
480+
Accepts the file ID and version ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-version-details).
481481

482482
```java
483483
String fileId = "62a04834c10d49825c6de9e8";
@@ -493,7 +493,7 @@ System.out.println(resultFileVersionDetails.getResponseMetaData().getMap());
493493

494494
**5. Update File Details**
495495

496-
Accepts an object specifying the parameters to be used to update file details. All parameters specified in the [documentation here] (https://docs.imagekit.io/api-reference/media-api/update-file-details) can be passed as-is with the correct values to get the results.
496+
Accepts an object of class `FileUpdateRequest` specifying the parameters to be used to update file details. All parameters specified in the [documentation here] (https://docs.imagekit.io/api-reference/media-api/update-file-details) can be passed as-is with the correct values to get the results.
497497

498498
```java
499499
List<String> tags = new ArrayList<>();
@@ -648,8 +648,7 @@ System.out.println(result.getResponseMetaData().getMap());
648648

649649
**12. Copy file**
650650

651-
Accepts the sourceFilePath and destinationPath to copy the File as per the
652-
[API documentation here](https://docs.imagekit.io/api-reference/media-api/copy-file).
651+
Accepts the sourceFilePath and destinationPath to copy the File as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/copy-file).
653652

654653
```java
655654
CopyFileRequest copyFileRequest = new CopyFileRequest();
@@ -854,7 +853,7 @@ System.out.println(result.getResponseMetaData().getMap());
854853

855854
**24. Create CustomMetaDataFields**
856855

857-
Accepts an object specifying the parameters to be used to create cusomMetaDataFields. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field) can be passed as-is with the correct values to get the results.
856+
Accepts an object of class `CustomMetaDataFieldCreateRequest` specifying the parameters to be used to create cusomMetaDataFields. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field) can be passed as-is with the correct values to get the results.
858857

859858
Check for the [Allowed Values In The Schema](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field#allowed-values-in-the-schema-object).
860859

@@ -927,8 +926,7 @@ ResultCustomMetaDataField resultCustomMetaDataField = ImageKit.getInstance()
927926

928927
**25. Get CustomMetaDataFields**
929928

930-
Fetches the metadata as per the
931-
[API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field)
929+
Fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field)
932930

933931
```java
934932
ResultCustomMetaDataFieldList resultCustomMetaDataFieldList=ImageKit.getInstance().getCustomMetaDataFields(false);
@@ -943,7 +941,7 @@ System.out.println(resultCustomMetaDataFieldList.getResultCustomMetaDataFields()
943941

944942
**26. Edit CustomMetaDataFields**
945943

946-
Accepts an ID of customMetaDataField and object specifying the parameters to be used to edit cusomMetaDataFields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/update-custom-metadata-field).
944+
Accepts an ID of customMetaDataField and object of class `CustomMetaDataFieldUpdateRequest` specifying the parameters to be used to edit cusomMetaDataFields as per the [API documentation here](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/update-custom-metadata-field).
947945

948946
```java
949947
CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();

0 commit comments

Comments
 (0)