logos-storage/logos-storage-py-api-client
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-py-api-client.git synced 2026-01-02 13:33:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generated API update

Browse Source
This commit is contained in:
AuHau 2025-03-31 15:49:38 +00:00 committed by github-actions[bot]
parent 9a7b29981a
commit 254e5341e0
19 changed files with 72 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
codex.yaml
View File

@ -27,10 +27,6 @@ components:
maxLength: 66
example: 0x...
BigInt:
type: string
description: Integer represented as decimal string
Cid:
type: string
description: Content Identifier as specified at https://github.com/multiformats/cid
@ -55,17 +51,18 @@ components:
description: The amount of tokens paid per byte per second per slot to hosts the client is willing to pay
Duration:
type: string
description: The duration of the request in seconds as decimal string
type: integer
format: int64
description: The duration of the request in seconds
ProofProbability:
type: string
description: How often storage proofs are required as decimal string
Expiry:
type: string
type: integer
format: int64
description: A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data.
default: 10 minutes
SPR:
type: string
@ -153,8 +150,9 @@ components:
id:
$ref: "#/components/schemas/Id"
totalSize:
type: string
description: Total size of availability's storage in bytes as decimal string
type: integer
format: int64
description: Total size of availability's storage in bytes
duration:
$ref: "#/components/schemas/Duration"
minPricePerBytePerSecond:
@ -170,8 +168,9 @@ components:
- type: object
properties:
freeSize:
type: string
description: Unused size of availability's storage in bytes as decimal string
type: integer
format: int64
description: Unused size of availability's storage in bytes
SalesAvailabilityCREATE:
allOf:
@ -190,8 +189,9 @@ components:
request:
$ref: "#/components/schemas/StorageRequest"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
SlotAgent:
type: object
@ -199,8 +199,9 @@ components:
id:
$ref: "#/components/schemas/SlotId"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
requestId:
$ref: "#/components/schemas/Id"
request:
@ -233,12 +234,15 @@ components:
availabilityId:
$ref: "#/components/schemas/Id"
size:
$ref: "#/components/schemas/BigInt"
type: integer
format: int64
description: Size of the slot in bytes
requestId:
$ref: "#/components/schemas/Id"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
StorageRequestCreation:
type: object
@ -258,17 +262,18 @@ components:
nodes:
description: Minimal number of nodes the content should be stored on
type: integer
default: 1
default: 3
tolerance:
description: Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost
type: integer
default: 0
default: 1
collateralPerByte:
type: string
description: Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots
expiry:
type: string
description: Number as decimal string that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.
type: integer
format: int64
description: Number that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.
StorageAsk:
type: object
required:

6
codex_api_client/models/reservation.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from typing import Optional, Set
@ -29,9 +29,9 @@ class Reservation(BaseModel):
""" # noqa: E501
id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
availability_id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.", alias="availabilityId")
size: Optional[StrictStr] = Field(default=None, description="Integer represented as decimal string")
size: Optional[StrictInt] = Field(default=None, description="Size of the slot in bytes")
request_id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.", alias="requestId")
slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as decimal string", alias="slotIndex")
slot_index: Optional[StrictInt] = Field(default=None, description="Slot Index number", alias="slotIndex")
__properties: ClassVar[List[str]] = ["id", "availabilityId", "size", "requestId", "slotIndex"]
model_config = ConfigDict(

6
codex_api_client/models/sales_availability.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from typing import Optional, Set
@ -28,8 +28,8 @@ class SalesAvailability(BaseModel):
SalesAvailability
""" # noqa: E501
id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
total_size: Optional[StrictStr] = Field(default=None, description="Total size of availability's storage in bytes as decimal string", alias="totalSize")
duration: Optional[StrictStr] = Field(default=None, description="The duration of the request in seconds as decimal string")
total_size: Optional[StrictInt] = Field(default=None, description="Total size of availability's storage in bytes", alias="totalSize")
duration: Optional[StrictInt] = Field(default=None, description="The duration of the request in seconds")
min_price_per_byte_per_second: Optional[StrictStr] = Field(default=None, description="Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string", alias="minPricePerBytePerSecond")
total_collateral: Optional[StrictStr] = Field(default=None, description="Total collateral (in amount of tokens) that can be used for matching requests", alias="totalCollateral")
__properties: ClassVar[List[str]] = ["id", "totalSize", "duration", "minPricePerBytePerSecond", "totalCollateral"]

6
codex_api_client/models/sales_availability_create.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from typing import Optional, Set
@ -28,8 +28,8 @@ class SalesAvailabilityCREATE(BaseModel):
SalesAvailabilityCREATE
""" # noqa: E501
id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
total_size: StrictStr = Field(description="Total size of availability's storage in bytes as decimal string", alias="totalSize")
duration: StrictStr = Field(description="The duration of the request in seconds as decimal string")
total_size: StrictInt = Field(description="Total size of availability's storage in bytes", alias="totalSize")
duration: StrictInt = Field(description="The duration of the request in seconds")
min_price_per_byte_per_second: StrictStr = Field(description="Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string", alias="minPricePerBytePerSecond")
total_collateral: StrictStr = Field(description="Total collateral (in amount of tokens) that can be used for matching requests", alias="totalCollateral")
__properties: ClassVar[List[str]] = ["id", "totalSize", "duration", "minPricePerBytePerSecond", "totalCollateral"]

8
codex_api_client/models/sales_availability_read.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from typing import Optional, Set
@ -28,11 +28,11 @@ class SalesAvailabilityREAD(BaseModel):
SalesAvailabilityREAD
""" # noqa: E501
id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
total_size: Optional[StrictStr] = Field(default=None, description="Total size of availability's storage in bytes as decimal string", alias="totalSize")
duration: Optional[StrictStr] = Field(default=None, description="The duration of the request in seconds as decimal string")
total_size: Optional[StrictInt] = Field(default=None, description="Total size of availability's storage in bytes", alias="totalSize")
duration: Optional[StrictInt] = Field(default=None, description="The duration of the request in seconds")
min_price_per_byte_per_second: Optional[StrictStr] = Field(default=None, description="Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string", alias="minPricePerBytePerSecond")
total_collateral: Optional[StrictStr] = Field(default=None, description="Total collateral (in amount of tokens) that can be used for matching requests", alias="totalCollateral")
free_size: Optional[StrictStr] = Field(default=None, description="Unused size of availability's storage in bytes as decimal string", alias="freeSize")
free_size: Optional[StrictInt] = Field(default=None, description="Unused size of availability's storage in bytes", alias="freeSize")
__properties: ClassVar[List[str]] = ["id", "totalSize", "duration", "minPricePerBytePerSecond", "totalCollateral", "freeSize"]
model_config = ConfigDict(

4
codex_api_client/models/slot.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from codex_api_client.models.storage_request import StorageRequest
from typing import Optional, Set
@ -29,7 +29,7 @@ class Slot(BaseModel):
""" # noqa: E501
id: Optional[StrictStr] = Field(default=None, description="Keccak hash of the abi encoded tuple (RequestId, slot index)")
request: Optional[StorageRequest] = None
slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as decimal string", alias="slotIndex")
slot_index: Optional[StrictInt] = Field(default=None, description="Slot Index number", alias="slotIndex")
__properties: ClassVar[List[str]] = ["id", "request", "slotIndex"]
model_config = ConfigDict(

4
codex_api_client/models/slot_agent.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from codex_api_client.models.reservation import Reservation
@ -30,7 +30,7 @@ class SlotAgent(BaseModel):
SlotAgent
""" # noqa: E501
id: Optional[StrictStr] = Field(default=None, description="Keccak hash of the abi encoded tuple (RequestId, slot index)")
slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as decimal string", alias="slotIndex")
slot_index: Optional[StrictInt] = Field(default=None, description="Slot Index number", alias="slotIndex")
request_id: Optional[Annotated[str, Field(min_length=66, strict=True, max_length=66)]] = Field(default=None, description="32bits identifier encoded in hex-decimal string.", alias="requestId")
request: Optional[StorageRequest] = None
reservation: Optional[Reservation] = None

2
codex_api_client/models/storage_ask.py
View File

@ -28,7 +28,7 @@ class StorageAsk(BaseModel):
""" # noqa: E501
slots: Optional[StrictInt] = Field(default=None, description="Number of slots (eq. hosts) that the Request want to have the content spread over")
slot_size: Optional[StrictStr] = Field(default=None, description="Amount of storage per slot (in bytes) as decimal string", alias="slotSize")
duration: Optional[StrictStr] = Field(default=None, description="The duration of the request in seconds as decimal string")
duration: Optional[StrictInt] = Field(default=None, description="The duration of the request in seconds")
proof_probability: Optional[StrictStr] = Field(default=None, description="How often storage proofs are required as decimal string", alias="proofProbability")
price_per_byte_per_second: StrictStr = Field(description="The amount of tokens paid per byte per second per slot to hosts the client is willing to pay", alias="pricePerBytePerSecond")
max_slot_loss: Optional[StrictInt] = Field(default=None, description="Max slots that can be lost without data considered to be lost", alias="maxSlotLoss")

6
codex_api_client/models/storage_request.py
View File

@ -17,7 +17,7 @@ import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from codex_api_client.models.content import Content
from codex_api_client.models.storage_ask import StorageAsk
@ -32,7 +32,7 @@ class StorageRequest(BaseModel):
client: Optional[StrictStr] = Field(default=None, description="Address of Ethereum address")
ask: Optional[StorageAsk] = None
content: Optional[Content] = None
expiry: Optional[StrictStr] = Field(default='10 minutes', description="A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data.")
expiry: Optional[StrictInt] = Field(default=None, description="A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data.")
nonce: Optional[StrictStr] = Field(default=None, description="Random data")
__properties: ClassVar[List[str]] = ["id", "client", "ask", "content", "expiry", "nonce"]
@ -97,7 +97,7 @@ class StorageRequest(BaseModel):
"client": obj.get("client"),
"ask": StorageAsk.from_dict(obj["ask"]) if obj.get("ask") is not None else None,
"content": Content.from_dict(obj["content"]) if obj.get("content") is not None else None,
"expiry": obj.get("expiry") if obj.get("expiry") is not None else '10 minutes',
"expiry": obj.get("expiry"),
"nonce": obj.get("nonce")
})
return _obj

12
codex_api_client/models/storage_request_creation.py
View File

@ -26,13 +26,13 @@ class StorageRequestCreation(BaseModel):
"""
StorageRequestCreation
""" # noqa: E501
duration: StrictStr = Field(description="The duration of the request in seconds as decimal string")
duration: StrictInt = Field(description="The duration of the request in seconds")
price_per_byte_per_second: StrictStr = Field(description="The amount of tokens paid per byte per second per slot to hosts the client is willing to pay", alias="pricePerBytePerSecond")
proof_probability: StrictStr = Field(description="How often storage proofs are required as decimal string", alias="proofProbability")
nodes: Optional[StrictInt] = Field(default=1, description="Minimal number of nodes the content should be stored on")
tolerance: Optional[StrictInt] = Field(default=0, description="Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost")
nodes: Optional[StrictInt] = Field(default=3, description="Minimal number of nodes the content should be stored on")
tolerance: Optional[StrictInt] = Field(default=1, description="Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost")
collateral_per_byte: StrictStr = Field(description="Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots", alias="collateralPerByte")
expiry: StrictStr = Field(description="Number as decimal string that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.")
expiry: StrictInt = Field(description="Number that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.")
__properties: ClassVar[List[str]] = ["duration", "pricePerBytePerSecond", "proofProbability", "nodes", "tolerance", "collateralPerByte", "expiry"]
model_config = ConfigDict(
@ -89,8 +89,8 @@ class StorageRequestCreation(BaseModel):
"duration": obj.get("duration"),
"pricePerBytePerSecond": obj.get("pricePerBytePerSecond"),
"proofProbability": obj.get("proofProbability"),
"nodes": obj.get("nodes") if obj.get("nodes") is not None else 1,
"tolerance": obj.get("tolerance") if obj.get("tolerance") is not None else 0,
"nodes": obj.get("nodes") if obj.get("nodes") is not None else 3,
"tolerance": obj.get("tolerance") if obj.get("tolerance") is not None else 1,
"collateralPerByte": obj.get("collateralPerByte"),
"expiry": obj.get("expiry")
})

4
docs/Reservation.md
View File

@ -7,9 +7,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**availability_id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**size** | **str** | Integer represented as decimal string | [optional]
**size** | **int** | Size of the slot in bytes | [optional]
**request_id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**slot_index** | **str** | Slot Index as decimal string | [optional]
**slot_index** | **int** | Slot Index number | [optional]
## Example

4
docs/SalesAvailability.md
View File

@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**total_size** | **str** | Total size of availability's storage in bytes as decimal string | [optional]
**duration** | **str** | The duration of the request in seconds as decimal string | [optional]
**total_size** | **int** | Total size of availability's storage in bytes | [optional]
**duration** | **int** | The duration of the request in seconds | [optional]
**min_price_per_byte_per_second** | **str** | Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string | [optional]
**total_collateral** | **str** | Total collateral (in amount of tokens) that can be used for matching requests | [optional]

4
docs/SalesAvailabilityCREATE.md
View File

@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**total_size** | **str** | Total size of availability's storage in bytes as decimal string |
**duration** | **str** | The duration of the request in seconds as decimal string |
**total_size** | **int** | Total size of availability's storage in bytes |
**duration** | **int** | The duration of the request in seconds |
**min_price_per_byte_per_second** | **str** | Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string |
**total_collateral** | **str** | Total collateral (in amount of tokens) that can be used for matching requests |

6
docs/SalesAvailabilityREAD.md
View File

@ -6,11 +6,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**total_size** | **str** | Total size of availability's storage in bytes as decimal string | [optional]
**duration** | **str** | The duration of the request in seconds as decimal string | [optional]
**total_size** | **int** | Total size of availability's storage in bytes | [optional]
**duration** | **int** | The duration of the request in seconds | [optional]
**min_price_per_byte_per_second** | **str** | Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string | [optional]
**total_collateral** | **str** | Total collateral (in amount of tokens) that can be used for matching requests | [optional]
**free_size** | **str** | Unused size of availability's storage in bytes as decimal string | [optional]
**free_size** | **int** | Unused size of availability's storage in bytes | [optional]
## Example

2
docs/Slot.md
View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Keccak hash of the abi encoded tuple (RequestId, slot index) | [optional]
**request** | [**StorageRequest**](StorageRequest.md) | | [optional]
**slot_index** | **str** | Slot Index as decimal string | [optional]
**slot_index** | **int** | Slot Index number | [optional]
## Example

2
docs/SlotAgent.md
View File

@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Keccak hash of the abi encoded tuple (RequestId, slot index) | [optional]
**slot_index** | **str** | Slot Index as decimal string | [optional]
**slot_index** | **int** | Slot Index number | [optional]
**request_id** | **str** | 32bits identifier encoded in hex-decimal string. | [optional]
**request** | [**StorageRequest**](StorageRequest.md) | | [optional]
**reservation** | [**Reservation**](Reservation.md) | | [optional]

2
docs/StorageAsk.md
View File

@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**slots** | **int** | Number of slots (eq. hosts) that the Request want to have the content spread over | [optional]
**slot_size** | **str** | Amount of storage per slot (in bytes) as decimal string | [optional]
**duration** | **str** | The duration of the request in seconds as decimal string | [optional]
**duration** | **int** | The duration of the request in seconds | [optional]
**proof_probability** | **str** | How often storage proofs are required as decimal string | [optional]
**price_per_byte_per_second** | **str** | The amount of tokens paid per byte per second per slot to hosts the client is willing to pay |
**max_slot_loss** | **int** | Max slots that can be lost without data considered to be lost | [optional]

2
docs/StorageRequest.md
View File

@ -9,7 +9,7 @@ Name | Type | Description | Notes
**client** | **str** | Address of Ethereum address | [optional]
**ask** | [**StorageAsk**](StorageAsk.md) | | [optional]
**content** | [**Content**](Content.md) | | [optional]
**expiry** | **str** | A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data. | [optional] [default to '10 minutes']
**expiry** | **int** | A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data. | [optional]
**nonce** | **str** | Random data | [optional]
## Example

8
docs/StorageRequestCreation.md
View File

@ -5,13 +5,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**duration** | **str** | The duration of the request in seconds as decimal string |
**duration** | **int** | The duration of the request in seconds |
**price_per_byte_per_second** | **str** | The amount of tokens paid per byte per second per slot to hosts the client is willing to pay |
**proof_probability** | **str** | How often storage proofs are required as decimal string |
**nodes** | **int** | Minimal number of nodes the content should be stored on | [optional] [default to 1]
**tolerance** | **int** | Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost | [optional] [default to 0]
**nodes** | **int** | Minimal number of nodes the content should be stored on | [optional] [default to 3]
**tolerance** | **int** | Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost | [optional] [default to 1]
**collateral_per_byte** | **str** | Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots |
**expiry** | **str** | Number as decimal string that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself. |
**expiry** | **int** | Number that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself. |
## Example