chore: update

codex-storage · Aug 25, 2024 · 87afa99 · 87afa99
1 parent c4562c8
commit 87afa99
Show file tree

Hide file tree

Showing 18 changed files with 324 additions and 49 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -28,6 +28,7 @@ codex_client/models/sales_availability.py
 codex_client/models/sales_availability_create.py
 codex_client/models/sales_availability_read.py
 codex_client/models/slot.py
+codex_client/models/slot_agent.py
 codex_client/models/space.py
 codex_client/models/spr_read.py
 codex_client/models/storage_ask.py
@@ -54,6 +55,7 @@ docs/SalesAvailability.md
 docs/SalesAvailabilityCREATE.md
 docs/SalesAvailabilityREAD.md
 docs/Slot.md
+docs/SlotAgent.md
 docs/Space.md
 docs/StorageAsk.md
 docs/StorageRequest.md
@@ -65,4 +67,5 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_slot_agent.py
 tox.ini
diff --git a/README.md b/README.md
@@ -123,6 +123,7 @@ Class | Method | HTTP request | Description
  - [SalesAvailabilityCREATE](docs/SalesAvailabilityCREATE.md)
  - [SalesAvailabilityREAD](docs/SalesAvailabilityREAD.md)
  - [Slot](docs/Slot.md)
+ - [SlotAgent](docs/SlotAgent.md)
  - [Space](docs/Space.md)
  - [StorageAsk](docs/StorageAsk.md)
  - [StorageRequest](docs/StorageRequest.md)

diff --git a/codex.yaml b/codex.yaml
@@ -23,6 +23,8 @@ components:
     Id:
       type: string
       description: 32bits identifier encoded in hex-decimal string.
+      minLength: 66
+      maxLength: 66
       example: 0x...
 
     BigInt:
@@ -168,7 +170,39 @@ components:
           $ref: "#/components/schemas/StorageRequest"
         slotIndex:
           type: string
-          description: Slot Index as hexadecimal string
+          description: Slot Index as decimal string
+
+    SlotAgent:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/SlotId"
+        slotIndex:
+          type: string
+          description: Slot Index as decimal string
+        requestId:
+          $ref: "#/components/schemas/Id"
+        request:
+          $ref: "#/components/schemas/StorageRequest"
+        reservation:
+          $ref: "#/components/schemas/Reservation"
+        state:
+          type: string
+          description: Description of the slot's
+          enum:
+            - SaleCancelled
+            - SaleDownloading
+            - SaleErrored
+            - SaleFailed
+            - SaleFilled
+            - SaleFilling
+            - SaleFinished
+            - SaleIgnored
+            - SaleInitialProving
+            - SalePayout
+            - SalePreparing
+            - SaleProving
+            - SaleUnknown
 
     Reservation:
       type: object
@@ -183,7 +217,7 @@ components:
           $ref: "#/components/schemas/Id"
         slotIndex:
           type: string
-          description: Slot Index as hexadecimal string
+          description: Slot Index as decimal string
 
     StorageRequestCreation:
       type: object
@@ -260,14 +294,14 @@ components:
           type: string
           description: Description of the Request's state
           enum:
-            - cancelled
-            - error
-            - failed
-            - finished
-            - pending
-            - started
-            - submitted
-            - unknown
+            - PurchaseCancelled
+            - PurchaseError
+            - PurchaseFailed
+            - PurchaseFinished
+            - PurchasePending
+            - PurchaseStarted
+            - PurchaseSubmitted
+            - PurchaseUnknown
         error:
           type: string
           description: If Request failed, then here is presented the error message
@@ -500,7 +534,7 @@ paths:
                   $ref: "#/components/schemas/Slot"
 
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
 
   "/sales/slots/{slotId}":
     get:
@@ -520,7 +554,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/Slot"
+                $ref: "#/components/schemas/SlotAgent"
 
         "400":
           description: Invalid or missing SlotId
@@ -529,7 +563,7 @@ paths:
           description: Host is not in an active sale for the slot
 
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
 
   "/sales/availability":
     get:
@@ -548,7 +582,7 @@ paths:
         "500":
           description: Error getting unused availabilities
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
 
     post:
       summary: "Offers storage for sale"
@@ -573,7 +607,7 @@ paths:
         "500":
           description: Error reserving availability
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
   "/sales/availability/{id}":
     patch:
       summary: "Updates availability"
@@ -606,7 +640,7 @@ paths:
         "500":
           description: Error reserving availability
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
 
   "/sales/availability/{id}/reservations":
     get:
@@ -637,7 +671,7 @@ paths:
         "500":
           description: Error getting reservations
         "503":
-          description: Sales are unavailable
+          description: Persistence is not enabled
 
   "/storage/request/{cid}":
     post:
@@ -668,7 +702,7 @@ paths:
         "404":
           description: Request ID not found
         "503":
-          description: Purchasing is unavailable
+          description: Persistence is not enabled
 
   "/storage/purchases":
     get:
@@ -685,7 +719,7 @@ paths:
                 items:
                   type: string
         "503":
-          description: Purchasing is unavailable
+          description: Persistence is not enabled
 
   "/storage/purchases/{id}":
     get:
@@ -711,7 +745,7 @@ paths:
         "404":
           description: Purchase not found
         "503":
-          description: Purchasing is unavailable
+          description: Persistence is not enabled
 
   "/node/spr":
     get:

diff --git a/codex_client/__init__.py b/codex_client/__init__.py
@@ -49,6 +49,7 @@
 from codex_client.models.sales_availability_create import SalesAvailabilityCREATE
 from codex_client.models.sales_availability_read import SalesAvailabilityREAD
 from codex_client.models.slot import Slot
+from codex_client.models.slot_agent import SlotAgent
 from codex_client.models.space import Space
 from codex_client.models.storage_ask import StorageAsk
 from codex_client.models.storage_request import StorageRequest

diff --git a/codex_client/api/marketplace_api.py b/codex_client/api/marketplace_api.py
@@ -25,6 +25,7 @@
 from codex_client.models.sales_availability_create import SalesAvailabilityCREATE
 from codex_client.models.sales_availability_read import SalesAvailabilityREAD
 from codex_client.models.slot import Slot
+from codex_client.models.slot_agent import SlotAgent
 from codex_client.models.storage_request_creation import StorageRequestCreation
 
 from codex_client.api_client import ApiClient, RequestSerialized
@@ -353,7 +354,7 @@ def get_active_slot_by_id(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Slot:
+    ) -> SlotAgent:
         """Returns active slot with id {slotId} for the host
 
 
@@ -390,7 +391,7 @@ def get_active_slot_by_id(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Slot",
+            '200': "SlotAgent",
             '400': None,
             '404': None,
             '503': None,
@@ -422,7 +423,7 @@ def get_active_slot_by_id_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Slot]:
+    ) -> ApiResponse[SlotAgent]:
         """Returns active slot with id {slotId} for the host
 
 
@@ -459,7 +460,7 @@ def get_active_slot_by_id_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Slot",
+            '200': "SlotAgent",
             '400': None,
             '404': None,
             '503': None,
@@ -528,7 +529,7 @@ def get_active_slot_by_id_without_preload_content(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Slot",
+            '200': "SlotAgent",
             '400': None,
             '404': None,
             '503': None,

diff --git a/codex_client/models/__init__.py b/codex_client/models/__init__.py
@@ -29,6 +29,7 @@
 from codex_client.models.sales_availability_create import SalesAvailabilityCREATE
 from codex_client.models.sales_availability_read import SalesAvailabilityREAD
 from codex_client.models.slot import Slot
+from codex_client.models.slot_agent import SlotAgent
 from codex_client.models.space import Space
 from codex_client.models.storage_ask import StorageAsk
 from codex_client.models.storage_request import StorageRequest

diff --git a/codex_client/models/purchase.py b/codex_client/models/purchase.py
@@ -38,8 +38,8 @@ def state_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in set(['cancelled', 'error', 'failed', 'finished', 'pending', 'started', 'submitted', 'unknown']):
-            raise ValueError("must be one of enum values ('cancelled', 'error', 'failed', 'finished', 'pending', 'started', 'submitted', 'unknown')")
+        if value not in set(['PurchaseCancelled', 'PurchaseError', 'PurchaseFailed', 'PurchaseFinished', 'PurchasePending', 'PurchaseStarted', 'PurchaseSubmitted', 'PurchaseUnknown']):
+            raise ValueError("must be one of enum values ('PurchaseCancelled', 'PurchaseError', 'PurchaseFailed', 'PurchaseFinished', 'PurchasePending', 'PurchaseStarted', 'PurchaseSubmitted', 'PurchaseUnknown')")
         return value
 
     model_config = ConfigDict(

diff --git a/codex_client/models/reservation.py b/codex_client/models/reservation.py
@@ -19,18 +19,19 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
 class Reservation(BaseModel):
     """
     Reservation
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
-    availability_id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.", alias="availabilityId")
+    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")
-    request_id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.", alias="requestId")
-    slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as hexadecimal string", 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")
+    slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as decimal string", alias="slotIndex")
     __properties: ClassVar[List[str]] = ["id", "availabilityId", "size", "requestId", "slotIndex"]
 
     model_config = ConfigDict(

diff --git a/codex_client/models/sales_availability.py b/codex_client/models/sales_availability.py
@@ -19,14 +19,15 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
 class SalesAvailability(BaseModel):
     """
     SalesAvailability
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
+    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")
     min_price: Optional[StrictStr] = Field(default=None, description="Minimum price to be paid (in amount of tokens) as decimal string", alias="minPrice")

diff --git a/codex_client/models/sales_availability_create.py b/codex_client/models/sales_availability_create.py
@@ -19,14 +19,15 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
 class SalesAvailabilityCREATE(BaseModel):
     """
     SalesAvailabilityCREATE
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
+    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")
     min_price: StrictStr = Field(description="Minimum price to be paid (in amount of tokens) as decimal string", alias="minPrice")

diff --git a/codex_client/models/sales_availability_read.py b/codex_client/models/sales_availability_read.py
@@ -19,14 +19,15 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
 class SalesAvailabilityREAD(BaseModel):
     """
     SalesAvailabilityREAD
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="32bits identifier encoded in hex-decimal string.")
+    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")
     min_price: Optional[StrictStr] = Field(default=None, description="Minimum price to be paid (in amount of tokens) as decimal string", alias="minPrice")

diff --git a/codex_client/models/slot.py b/codex_client/models/slot.py
@@ -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 hexadecimal string", alias="slotIndex")
+    slot_index: Optional[StrictStr] = Field(default=None, description="Slot Index as decimal string", alias="slotIndex")
     __properties: ClassVar[List[str]] = ["id", "request", "slotIndex"]
 
     model_config = ConfigDict(