Skip to content

Commit 131a9ea

Browse files
GozalaGozala
committed
Minor update
1 parent 8c3c1bd commit 131a9ea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2811
-231
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
.openapi-generator-ignore
44
.travis.yml
55
README.md
6+
docs/CheckResponse.md
7+
docs/CheckResponseValue.md
68
docs/Deal.md
79
docs/DeleteResponse.md
810
docs/ErrorResponse.md
@@ -30,6 +32,8 @@ nft_storage/apis/__init__.py
3032
nft_storage/configuration.py
3133
nft_storage/exceptions.py
3234
nft_storage/model/__init__.py
35+
nft_storage/model/check_response.py
36+
nft_storage/model/check_response_value.py
3337
nft_storage/model/deal.py
3438
nft_storage/model/delete_response.py
3539
nft_storage/model/error_response.py
@@ -55,6 +59,8 @@ setup.cfg
5559
setup.py
5660
test-requirements.txt
5761
test/__init__.py
62+
test/test_check_response.py
63+
test/test_check_response_value.py
5864
test/test_deal.py
5965
test/test_delete_response.py
6066
test/test_error_response.py

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.1.1-SNAPSHOT
1+
5.3.0-SNAPSHOT

‎README.md‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ import time
5050
import nft_storage
5151
from pprint import pprint
5252
from nft_storage.api import nft_storage_api
53+
from nft_storage.model.check_response import CheckResponse
5354
from nft_storage.model.delete_response import DeleteResponse
5455
from nft_storage.model.error_response import ErrorResponse
5556
from nft_storage.model.forbidden_error_response import ForbiddenErrorResponse
@@ -63,15 +64,6 @@ configuration = nft_storage.Configuration(
6364
host = "https://api.nft.storage"
6465
)
6566

66-
# The client must configure the authentication and authorization parameters
67-
# in accordance with the API server security policy.
68-
# Examples for each auth method are provided below, use the example that
69-
# satisfies your auth use case.
70-
71-
# Configure Bearer authorization (JWT): bearerAuth
72-
configuration = nft_storage.Configuration(
73-
access_token = 'YOUR_BEARER_TOKEN'
74-
)
7567

7668

7769
# Enter a context with an instance of the API client
@@ -81,11 +73,11 @@ with nft_storage.ApiClient(configuration) as api_client:
8173
cid = "bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u" # str | CID for the NFT
8274

8375
try:
84-
# Stop storing the content with the passed CID
85-
api_response = api_instance.delete(cid)
76+
# Check if a CID of an NFT is being stored by nft.storage.
77+
api_response = api_instance.check(cid)
8678
pprint(api_response)
8779
except nft_storage.ApiException as e:
88-
print("Exception when calling NFTStorageAPI->delete: %s\n" % e)
80+
print("Exception when calling NFTStorageAPI->check: %s\n" % e)
8981
```
9082

9183
## Documentation for API Endpoints
@@ -94,6 +86,7 @@ All URIs are relative to *https://api.nft.storage*
9486

9587
Class | Method | HTTP request | Description
9688
------------ | ------------- | ------------- | -------------
89+
*NFTStorageAPI* | [**check**](docs/NFTStorageAPI.md#check) | **GET** /check/{cid} | Check if a CID of an NFT is being stored by nft.storage.
9790
*NFTStorageAPI* | [**delete**](docs/NFTStorageAPI.md#delete) | **DELETE** /{cid} | Stop storing the content with the passed CID
9891
*NFTStorageAPI* | [**list**](docs/NFTStorageAPI.md#list) | **GET** / | List all stored files
9992
*NFTStorageAPI* | [**status**](docs/NFTStorageAPI.md#status) | **GET** /{cid} | Get information for the stored file CID
@@ -102,6 +95,8 @@ Class | Method | HTTP request | Description
10295

10396
## Documentation For Models
10497

98+
- [CheckResponse](docs/CheckResponse.md)
99+
- [CheckResponseValue](docs/CheckResponseValue.md)
105100
- [Deal](docs/Deal.md)
106101
- [DeleteResponse](docs/DeleteResponse.md)
107102
- [ErrorResponse](docs/ErrorResponse.md)

‎docs/CheckResponse.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CheckResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**ok** | **bool** | | [optional] if omitted the server will use the default value of True
8+
**value** | [**CheckResponseValue**](CheckResponseValue.md) | | [optional]
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/CheckResponseValue.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CheckResponseValue
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**cid** | **str** | Self-describing content-addressed identifiers for distributed systems. Check [spec](https://github.com/multiformats/cid) for more info. | [optional]
8+
**pin** | [**Pin**](Pin.md) | | [optional]
9+
**deals** | [**[Deal]**](Deal.md) | | [optional]
10+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/Deal.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**chain_deal_id** | **float** | Identifier for the deal stored on chain. | [optional]
1515
**deal_activation** | **str** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional]
1616
**deal_expiration** | **str** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional]
17+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1718

1819
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1920

‎docs/DeleteResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**ok** | **bool** | | [optional]
8+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
89

910
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1011

‎docs/ErrorResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**ok** | **bool** | | [optional] if omitted the server will use the default value of False
88
**error** | [**ErrorResponseError**](ErrorResponseError.md) | | [optional]
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
910

1011
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1112

‎docs/ErrorResponseError.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **str** | | [optional]
88
**message** | **str** | | [optional]
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
910

1011
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1112

‎docs/Files.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Files in the directory (only if this NFT is a directory).
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Files in the directory (only if this NFT is a directory). |
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
910

1011
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1112

0 commit comments

Comments
 (0)