openapi.ts
1 /** 2 * This file was auto-generated by openapi-typescript. 3 * Do not make direct changes to the file. 4 */ 5 6 export interface paths { 7 "/connect/{peerId}": { 8 parameters: { 9 query?: never; 10 header?: never; 11 path?: never; 12 cookie?: never; 13 }; 14 /** 15 * Connect to a peer 16 * @description If `addrs` param is supplied, it will be used to dial the peer, otherwise the `peerId` is used 17 * to invoke peer discovery, if it succeeds the returned addresses will be used to dial. 18 * 19 */ 20 get: operations["connectPeer"]; 21 put?: never; 22 post?: never; 23 delete?: never; 24 options?: never; 25 head?: never; 26 patch?: never; 27 trace?: never; 28 }; 29 "/data": { 30 parameters: { 31 query?: never; 32 header?: never; 33 path?: never; 34 cookie?: never; 35 }; 36 /** Lists manifest CIDs stored locally in node. */ 37 get: operations["listData"]; 38 put?: never; 39 /** Upload a file in a streaming manner. Once finished, the file is stored in the node and can be retrieved by any node in the network using the returned CID. */ 40 post: operations["upload"]; 41 delete?: never; 42 options?: never; 43 head?: never; 44 patch?: never; 45 trace?: never; 46 }; 47 "/data/{cid}": { 48 parameters: { 49 query?: never; 50 header?: never; 51 path?: never; 52 cookie?: never; 53 }; 54 /** Download a file from the local node in a streaming manner. If the file is not available locally, a 404 is returned. */ 55 get: operations["downloadLocal"]; 56 put?: never; 57 post?: never; 58 /** Deletes either a single block or an entire dataset from the local node. */ 59 delete: operations["deleteLocal"]; 60 options?: never; 61 head?: never; 62 patch?: never; 63 trace?: never; 64 }; 65 "/data/{cid}/network": { 66 parameters: { 67 query?: never; 68 header?: never; 69 path?: never; 70 cookie?: never; 71 }; 72 get?: never; 73 put?: never; 74 /** Download a file from the network to the local node if it's not available locally. Note: Download is performed async. Call can return before download is completed. */ 75 post: operations["downloadNetwork"]; 76 delete?: never; 77 options?: never; 78 head?: never; 79 patch?: never; 80 trace?: never; 81 }; 82 "/data/{cid}/network/stream": { 83 parameters: { 84 query?: never; 85 header?: never; 86 path?: never; 87 cookie?: never; 88 }; 89 /** Download a file from the network in a streaming manner. If the file is not available locally, it will be retrieved from other nodes in the network if able. */ 90 get: operations["downloadNetworkStream"]; 91 put?: never; 92 post?: never; 93 delete?: never; 94 options?: never; 95 head?: never; 96 patch?: never; 97 trace?: never; 98 }; 99 "/data/{cid}/network/manifest": { 100 parameters: { 101 query?: never; 102 header?: never; 103 path?: never; 104 cookie?: never; 105 }; 106 /** Download only the dataset manifest from the network to the local node if it's not available locally. */ 107 get: operations["downloadNetworkManifest"]; 108 put?: never; 109 post?: never; 110 delete?: never; 111 options?: never; 112 head?: never; 113 patch?: never; 114 trace?: never; 115 }; 116 "/space": { 117 parameters: { 118 query?: never; 119 header?: never; 120 path?: never; 121 cookie?: never; 122 }; 123 /** Gets a summary of the storage space allocation of the node. */ 124 get: operations["space"]; 125 put?: never; 126 post?: never; 127 delete?: never; 128 options?: never; 129 head?: never; 130 patch?: never; 131 trace?: never; 132 }; 133 "/sales/slots": { 134 parameters: { 135 query?: never; 136 header?: never; 137 path?: never; 138 cookie?: never; 139 }; 140 /** Returns active slots */ 141 get: operations["getActiveSlots"]; 142 put?: never; 143 post?: never; 144 delete?: never; 145 options?: never; 146 head?: never; 147 patch?: never; 148 trace?: never; 149 }; 150 "/sales/slots/{slotId}": { 151 parameters: { 152 query?: never; 153 header?: never; 154 path?: never; 155 cookie?: never; 156 }; 157 /** Returns active slot with id {slotId} for the host */ 158 get: operations["getActiveSlotById"]; 159 put?: never; 160 post?: never; 161 delete?: never; 162 options?: never; 163 head?: never; 164 patch?: never; 165 trace?: never; 166 }; 167 "/sales/availability": { 168 parameters: { 169 query?: never; 170 header?: never; 171 path?: never; 172 cookie?: never; 173 }; 174 /** Returns storage that is for sale */ 175 get: operations["getAvailabilities"]; 176 put?: never; 177 /** Offers storage for sale */ 178 post: operations["offerStorage"]; 179 delete?: never; 180 options?: never; 181 head?: never; 182 patch?: never; 183 trace?: never; 184 }; 185 "/sales/availability/{id}": { 186 parameters: { 187 query?: never; 188 header?: never; 189 path?: never; 190 cookie?: never; 191 }; 192 get?: never; 193 put?: never; 194 post?: never; 195 delete?: never; 196 options?: never; 197 head?: never; 198 /** 199 * Updates availability 200 * @description The new parameters will be only considered for new requests. 201 * Existing Requests linked to this Availability will continue as is. 202 * 203 */ 204 patch: operations["updateOfferedStorage"]; 205 trace?: never; 206 }; 207 "/sales/availability/{id}/reservations": { 208 parameters: { 209 query?: never; 210 header?: never; 211 path?: never; 212 cookie?: never; 213 }; 214 /** 215 * Get availability's reservations 216 * @description Return's list of Reservations for ongoing Storage Requests that the node hosts. 217 */ 218 get: operations["getReservations"]; 219 put?: never; 220 post?: never; 221 delete?: never; 222 options?: never; 223 head?: never; 224 patch?: never; 225 trace?: never; 226 }; 227 "/storage/request/{cid}": { 228 parameters: { 229 query?: never; 230 header?: never; 231 path?: never; 232 cookie?: never; 233 }; 234 get?: never; 235 put?: never; 236 /** Creates a new Request for storage */ 237 post: operations["createStorageRequest"]; 238 delete?: never; 239 options?: never; 240 head?: never; 241 patch?: never; 242 trace?: never; 243 }; 244 "/storage/purchases": { 245 parameters: { 246 query?: never; 247 header?: never; 248 path?: never; 249 cookie?: never; 250 }; 251 /** Returns list of purchase IDs */ 252 get: operations["getPurchases"]; 253 put?: never; 254 post?: never; 255 delete?: never; 256 options?: never; 257 head?: never; 258 patch?: never; 259 trace?: never; 260 }; 261 "/storage/purchases/{id}": { 262 parameters: { 263 query?: never; 264 header?: never; 265 path?: never; 266 cookie?: never; 267 }; 268 /** Returns purchase details */ 269 get: operations["getPurchase"]; 270 put?: never; 271 post?: never; 272 delete?: never; 273 options?: never; 274 head?: never; 275 patch?: never; 276 trace?: never; 277 }; 278 "/spr": { 279 parameters: { 280 query?: never; 281 header?: never; 282 path?: never; 283 cookie?: never; 284 }; 285 /** Get Node's SPR */ 286 get: operations["getSPR"]; 287 put?: never; 288 post?: never; 289 delete?: never; 290 options?: never; 291 head?: never; 292 patch?: never; 293 trace?: never; 294 }; 295 "/peerid": { 296 parameters: { 297 query?: never; 298 header?: never; 299 path?: never; 300 cookie?: never; 301 }; 302 /** Get Node's PeerID */ 303 get: operations["getPeerId"]; 304 put?: never; 305 post?: never; 306 delete?: never; 307 options?: never; 308 head?: never; 309 patch?: never; 310 trace?: never; 311 }; 312 "/debug/chronicles/loglevel": { 313 parameters: { 314 query?: never; 315 header?: never; 316 path?: never; 317 cookie?: never; 318 }; 319 get?: never; 320 put?: never; 321 /** Set log level at run time */ 322 post: operations["setDebugLogLevel"]; 323 delete?: never; 324 options?: never; 325 head?: never; 326 patch?: never; 327 trace?: never; 328 }; 329 "/debug/info": { 330 parameters: { 331 query?: never; 332 header?: never; 333 path?: never; 334 cookie?: never; 335 }; 336 /** Gets node information */ 337 get: operations["getDebugInfo"]; 338 put?: never; 339 post?: never; 340 delete?: never; 341 options?: never; 342 head?: never; 343 patch?: never; 344 trace?: never; 345 }; 346 } 347 export type webhooks = Record<string, never>; 348 export interface components { 349 schemas: { 350 /** 351 * @description Address of node as specified by the multi-address specification https://multiformats.io/multiaddr/ 352 * @example /ip4/127.0.0.1/tcp/8080 353 */ 354 MultiAddress: string; 355 /** 356 * @description Peer Identity reference as specified at https://docs.libp2p.io/concepts/fundamentals/peers/ 357 * @example QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N 358 */ 359 PeerId: string; 360 /** 361 * @description 32bits identifier encoded in hex-decimal string. 362 * @example 0x... 363 */ 364 Id: string; 365 /** 366 * @description Content Identifier as specified at https://github.com/multiformats/cid 367 * @example QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N 368 */ 369 Cid: string; 370 /** 371 * @description Keccak hash of the abi encoded tuple (RequestId, slot index) 372 * @example 268a781e0db3f7cf36b18e5f4fdb7f586ec9edd08e5500b17c0e518a769f114a 373 */ 374 SlotId: string; 375 /** 376 * @description One of the log levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL 377 * @example DEBUG 378 */ 379 LogLevel: string; 380 /** @description Address of Ethereum address */ 381 EthereumAddress: string; 382 /** @description The amount of tokens paid per byte per second per slot to hosts the client is willing to pay */ 383 PricePerBytePerSecond: string; 384 /** @description Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots */ 385 CollateralPerByte: string; 386 /** 387 * Format: int64 388 * @description The duration of the request in seconds 389 */ 390 Duration: number; 391 /** @description How often storage proofs are required as decimal string */ 392 ProofProbability: string; 393 /** 394 * Format: int64 395 * @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. 396 */ 397 Expiry: number; 398 /** @description Signed Peer Record (libp2p) */ 399 SPR: string; 400 SPRRead: { 401 spr: components["schemas"]["SPR"]; 402 }; 403 PeerIdRead: { 404 id?: components["schemas"]["PeerId"]; 405 }; 406 /** @description Parameters specifying the content */ 407 Content: { 408 cid: components["schemas"]["Cid"]; 409 }; 410 Node: { 411 nodeId: string; 412 peerId: string; 413 record: string; 414 address: string; 415 seen: boolean; 416 }; 417 CodexVersion: { 418 /** @example v0.1.7 */ 419 version?: string; 420 /** @example 0c647d8 */ 421 revision?: string; 422 /** @example 0b537c7 */ 423 contracts?: string; 424 }; 425 PeersTable: { 426 localNode: components["schemas"]["Node"]; 427 nodes: components["schemas"]["Node"][]; 428 }; 429 DebugInfo: { 430 id: components["schemas"]["PeerId"]; 431 addrs: components["schemas"]["MultiAddress"][]; 432 /** @description Path of the data repository where all nodes data are stored */ 433 repo: string; 434 spr: components["schemas"]["SPR"]; 435 announceAddresses: components["schemas"]["MultiAddress"][]; 436 table: components["schemas"]["PeersTable"]; 437 codex: components["schemas"]["CodexVersion"]; 438 }; 439 SalesAvailability: { 440 /** 441 * Format: int64 442 * @description Total size of availability's storage in bytes 443 */ 444 totalSize: number; 445 duration: components["schemas"]["Duration"]; 446 /** @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 */ 447 minPricePerBytePerSecond: string; 448 /** @description Total collateral (in amount of tokens) that can be used for matching requests */ 449 totalCollateral: string; 450 /** 451 * @description Enable the ability to receive sales on this availability. 452 * @default true 453 */ 454 enabled?: boolean; 455 /** 456 * @description Specifies the latest timestamp, after which the availability will no longer host any slots. If set to 0, there will be no restrictions. 457 * @default 0 458 */ 459 until?: number; 460 }; 461 SalesAvailabilityREAD: components["schemas"]["SalesAvailability"] & { 462 id: components["schemas"]["Id"]; 463 /** 464 * Format: int64 465 * @description Unused size of availability's storage in bytes as decimal string 466 */ 467 readonly freeSize: number; 468 /** @description Total collateral effective (in amount of tokens) that can be used for matching requests */ 469 readonly totalRemainingCollateral: string; 470 }; 471 Slot: { 472 id: components["schemas"]["SlotId"]; 473 request: components["schemas"]["StorageRequest"]; 474 /** 475 * Format: int64 476 * @description Slot Index number 477 */ 478 slotIndex: number; 479 }; 480 SlotAgent: { 481 /** 482 * Format: int64 483 * @description Slot Index number 484 */ 485 slotIndex: number; 486 requestId: components["schemas"]["Id"]; 487 request?: components["schemas"]["StorageRequest"]; 488 reservation?: components["schemas"]["Reservation"]; 489 /** 490 * @description Description of the slot's 491 * @enum {string} 492 */ 493 state: "SaleCancelled" | "SaleDownloading" | "SaleErrored" | "SaleFailed" | "SaleFilled" | "SaleFilling" | "SaleFinished" | "SaleIgnored" | "SaleInitialProving" | "SalePayout" | "SalePreparing" | "SaleProving" | "SaleUnknown"; 494 }; 495 Reservation: { 496 id: components["schemas"]["Id"]; 497 availabilityId: components["schemas"]["Id"]; 498 /** 499 * Format: int64 500 * @description Size of the slot in bytes 501 */ 502 size: number; 503 requestId: components["schemas"]["Id"]; 504 /** 505 * Format: int64 506 * @description Slot Index number 507 */ 508 slotIndex: number; 509 /** @description Timestamp after which the reservation will no longer be valid. */ 510 validUntil: number; 511 }; 512 StorageRequestCreation: { 513 duration: components["schemas"]["Duration"]; 514 pricePerBytePerSecond: components["schemas"]["PricePerBytePerSecond"]; 515 proofProbability: components["schemas"]["ProofProbability"]; 516 /** 517 * @description Minimal number of nodes the content should be stored on 518 * @default 3 519 */ 520 nodes?: number; 521 /** 522 * @description Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost 523 * @default 1 524 */ 525 tolerance?: number; 526 collateralPerByte: components["schemas"]["CollateralPerByte"]; 527 /** 528 * Format: int64 529 * @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. 530 */ 531 expiry: number; 532 }; 533 StorageAsk: { 534 /** 535 * Format: int64 536 * @description Number of slots (eq. hosts) that the Request want to have the content spread over 537 */ 538 slots: number; 539 /** 540 * Format: int64 541 * @description Amount of storage per slot in bytes 542 */ 543 slotSize: number; 544 duration: components["schemas"]["Duration"]; 545 proofProbability: components["schemas"]["ProofProbability"]; 546 pricePerBytePerSecond: components["schemas"]["PricePerBytePerSecond"]; 547 collateralPerByte: components["schemas"]["CollateralPerByte"]; 548 /** 549 * Format: int64 550 * @description Max slots that can be lost without data considered to be lost 551 */ 552 maxSlotLoss: number; 553 }; 554 StorageRequest: { 555 /** @description Request ID */ 556 id: string; 557 client: components["schemas"]["EthereumAddress"]; 558 ask: components["schemas"]["StorageAsk"]; 559 content: components["schemas"]["Content"]; 560 expiry: components["schemas"]["Expiry"]; 561 /** @description Random data */ 562 nonce: string; 563 }; 564 Purchase: { 565 /** 566 * @description Description of the Request's state 567 * @enum {string} 568 */ 569 state: "cancelled" | "errored" | "failed" | "finished" | "pending" | "started" | "submitted" | "unknown"; 570 /** @description If Request failed, then here is presented the error message */ 571 error?: string | null; 572 request?: components["schemas"]["StorageRequest"]; 573 requestId: components["schemas"]["Id"]; 574 }; 575 DataList: { 576 content: components["schemas"]["DataItem"][]; 577 }; 578 DataItem: { 579 cid: components["schemas"]["Cid"]; 580 manifest: components["schemas"]["ManifestItem"]; 581 }; 582 ManifestItem: { 583 /** @description Unique data identifier */ 584 treeCid: components["schemas"]["Cid"]; 585 /** 586 * Format: int64 587 * @description Length of original content in bytes 588 */ 589 datasetSize: number; 590 /** @description Size of blocks */ 591 blockSize: number; 592 /** @description Indicates if content is protected by erasure-coding */ 593 protected: boolean; 594 /** 595 * @description The original name of the uploaded content (optional) 596 * @example codex.png 597 */ 598 filename?: string | null; 599 /** 600 * @description The original mimetype of the uploaded content (optional) 601 * @example image/png 602 */ 603 mimetype?: string | null; 604 }; 605 Space: { 606 /** 607 * Format: int64 608 * @description Number of blocks stored by the node 609 */ 610 totalBlocks: number; 611 /** 612 * Format: int64 613 * @description Maximum storage space (in bytes) available for the node in Codex's local repository. 614 */ 615 quotaMaxBytes: number; 616 /** 617 * Format: int64 618 * @description Amount of storage space (in bytes) currently used for storing files in Codex's local repository. 619 */ 620 quotaUsedBytes: number; 621 /** 622 * Format: int64 623 * @description Amount of storage reserved (in bytes) in the Codex's local repository for future use when storage requests will be picked up and hosted by the node using node's availabilities. This does not include the storage currently in use. 624 */ 625 quotaReservedBytes: number; 626 }; 627 }; 628 responses: never; 629 parameters: never; 630 requestBodies: never; 631 headers: never; 632 pathItems: never; 633 } 634 export type $defs = Record<string, never>; 635 export interface operations { 636 connectPeer: { 637 parameters: { 638 query?: { 639 /** @description If supplied, it will be used to dial the peer. 640 * The address has to target the listening address of the peer, 641 * which is specified with the `--listen-addrs` CLI flag. 642 * */ 643 addrs?: components["schemas"]["MultiAddress"][] | null; 644 }; 645 header?: never; 646 path: { 647 /** @description Peer that should be dialed. */ 648 peerId: components["schemas"]["PeerId"]; 649 }; 650 cookie?: never; 651 }; 652 requestBody?: never; 653 responses: { 654 /** @description Successfully connected to peer */ 655 200: { 656 headers: { 657 [name: string]: unknown; 658 }; 659 content?: never; 660 }; 661 /** @description Peer either not found or was not possible to dial */ 662 400: { 663 headers: { 664 [name: string]: unknown; 665 }; 666 content?: never; 667 }; 668 }; 669 }; 670 listData: { 671 parameters: { 672 query?: never; 673 header?: never; 674 path?: never; 675 cookie?: never; 676 }; 677 requestBody?: never; 678 responses: { 679 /** @description Retrieved list of content CIDs */ 680 200: { 681 headers: { 682 [name: string]: unknown; 683 }; 684 content: { 685 "application/json": components["schemas"]["DataList"]; 686 }; 687 }; 688 /** @description Invalid CID is specified */ 689 400: { 690 headers: { 691 [name: string]: unknown; 692 }; 693 content?: never; 694 }; 695 /** @description Content specified by the CID is not found */ 696 404: { 697 headers: { 698 [name: string]: unknown; 699 }; 700 content?: never; 701 }; 702 /** @description The content type is not a valid content type or the filename is not valid */ 703 422: { 704 headers: { 705 [name: string]: unknown; 706 }; 707 content?: never; 708 }; 709 /** @description Well it was bad-bad */ 710 500: { 711 headers: { 712 [name: string]: unknown; 713 }; 714 content?: never; 715 }; 716 }; 717 }; 718 upload: { 719 parameters: { 720 query?: never; 721 header?: { 722 /** @description The content type of the file. Must be valid. */ 723 "content-type"?: string; 724 /** @description The content disposition used to send the filename. */ 725 "content-disposition"?: string; 726 }; 727 path?: never; 728 cookie?: never; 729 }; 730 requestBody?: { 731 content: { 732 "application/octet-stream": string; 733 }; 734 }; 735 responses: { 736 /** @description CID of uploaded file */ 737 200: { 738 headers: { 739 [name: string]: unknown; 740 }; 741 content: { 742 "text/plain": string; 743 }; 744 }; 745 /** @description The mimetype of the filename is invalid */ 746 422: { 747 headers: { 748 [name: string]: unknown; 749 }; 750 content?: never; 751 }; 752 /** @description Well it was bad-bad and the upload did not work out */ 753 500: { 754 headers: { 755 [name: string]: unknown; 756 }; 757 content?: never; 758 }; 759 }; 760 }; 761 downloadLocal: { 762 parameters: { 763 query?: never; 764 header?: never; 765 path: { 766 /** @description File to be downloaded. */ 767 cid: components["schemas"]["Cid"]; 768 }; 769 cookie?: never; 770 }; 771 requestBody?: never; 772 responses: { 773 /** @description Retrieved content specified by CID */ 774 200: { 775 headers: { 776 [name: string]: unknown; 777 }; 778 content: { 779 "application/octet-stream": string; 780 }; 781 }; 782 /** @description Invalid CID is specified */ 783 400: { 784 headers: { 785 [name: string]: unknown; 786 }; 787 content?: never; 788 }; 789 /** @description Content specified by the CID is unavailable locally */ 790 404: { 791 headers: { 792 [name: string]: unknown; 793 }; 794 content?: never; 795 }; 796 /** @description Well it was bad-bad */ 797 500: { 798 headers: { 799 [name: string]: unknown; 800 }; 801 content?: never; 802 }; 803 }; 804 }; 805 deleteLocal: { 806 parameters: { 807 query?: never; 808 header?: never; 809 path: { 810 /** @description Block or dataset to be deleted. */ 811 cid: components["schemas"]["Cid"]; 812 }; 813 cookie?: never; 814 }; 815 requestBody?: never; 816 responses: { 817 /** @description Data was successfully deleted. */ 818 204: { 819 headers: { 820 [name: string]: unknown; 821 }; 822 content?: never; 823 }; 824 /** @description Invalid CID is specified */ 825 400: { 826 headers: { 827 [name: string]: unknown; 828 }; 829 content?: never; 830 }; 831 /** @description There was an error during deletion */ 832 500: { 833 headers: { 834 [name: string]: unknown; 835 }; 836 content?: never; 837 }; 838 }; 839 }; 840 downloadNetwork: { 841 parameters: { 842 query?: never; 843 header?: never; 844 path: { 845 /** @description File to be downloaded. */ 846 cid: components["schemas"]["Cid"]; 847 }; 848 cookie?: never; 849 }; 850 requestBody?: never; 851 responses: { 852 /** @description Manifest information for download that has been started. */ 853 200: { 854 headers: { 855 [name: string]: unknown; 856 }; 857 content: { 858 "application/json": components["schemas"]["DataItem"]; 859 }; 860 }; 861 /** @description Invalid CID is specified */ 862 400: { 863 headers: { 864 [name: string]: unknown; 865 }; 866 content?: never; 867 }; 868 /** @description Failed to download dataset manifest */ 869 404: { 870 headers: { 871 [name: string]: unknown; 872 }; 873 content?: never; 874 }; 875 /** @description Well it was bad-bad */ 876 500: { 877 headers: { 878 [name: string]: unknown; 879 }; 880 content?: never; 881 }; 882 }; 883 }; 884 downloadNetworkStream: { 885 parameters: { 886 query?: never; 887 header?: never; 888 path: { 889 /** @description File to be downloaded. */ 890 cid: components["schemas"]["Cid"]; 891 }; 892 cookie?: never; 893 }; 894 requestBody?: never; 895 responses: { 896 /** @description Retrieved content specified by CID */ 897 200: { 898 headers: { 899 [name: string]: unknown; 900 }; 901 content: { 902 "application/octet-stream": string; 903 }; 904 }; 905 /** @description Invalid CID is specified */ 906 400: { 907 headers: { 908 [name: string]: unknown; 909 }; 910 content?: never; 911 }; 912 /** @description Content specified by the CID is not found */ 913 404: { 914 headers: { 915 [name: string]: unknown; 916 }; 917 content?: never; 918 }; 919 /** @description Well it was bad-bad */ 920 500: { 921 headers: { 922 [name: string]: unknown; 923 }; 924 content?: never; 925 }; 926 }; 927 }; 928 downloadNetworkManifest: { 929 parameters: { 930 query?: never; 931 header?: never; 932 path: { 933 /** @description File for which the manifest is to be downloaded. */ 934 cid: components["schemas"]["Cid"]; 935 }; 936 cookie?: never; 937 }; 938 requestBody?: never; 939 responses: { 940 /** @description Manifest information. */ 941 200: { 942 headers: { 943 [name: string]: unknown; 944 }; 945 content: { 946 "application/json": components["schemas"]["DataItem"]; 947 }; 948 }; 949 /** @description Invalid CID is specified */ 950 400: { 951 headers: { 952 [name: string]: unknown; 953 }; 954 content?: never; 955 }; 956 /** @description Failed to download dataset manifest */ 957 404: { 958 headers: { 959 [name: string]: unknown; 960 }; 961 content?: never; 962 }; 963 /** @description Well it was bad-bad */ 964 500: { 965 headers: { 966 [name: string]: unknown; 967 }; 968 content?: never; 969 }; 970 }; 971 }; 972 space: { 973 parameters: { 974 query?: never; 975 header?: never; 976 path?: never; 977 cookie?: never; 978 }; 979 requestBody?: never; 980 responses: { 981 /** @description Summary of storage allocation */ 982 200: { 983 headers: { 984 [name: string]: unknown; 985 }; 986 content: { 987 "application/json": components["schemas"]["Space"]; 988 }; 989 }; 990 /** @description It's not working as planned */ 991 500: { 992 headers: { 993 [name: string]: unknown; 994 }; 995 content?: never; 996 }; 997 }; 998 }; 999 getActiveSlots: { 1000 parameters: { 1001 query?: never; 1002 header?: never; 1003 path?: never; 1004 cookie?: never; 1005 }; 1006 requestBody?: never; 1007 responses: { 1008 /** @description Retrieved active slots */ 1009 200: { 1010 headers: { 1011 [name: string]: unknown; 1012 }; 1013 content: { 1014 "application/json": components["schemas"]["Slot"][]; 1015 }; 1016 }; 1017 /** @description Persistence is not enabled */ 1018 503: { 1019 headers: { 1020 [name: string]: unknown; 1021 }; 1022 content?: never; 1023 }; 1024 }; 1025 }; 1026 getActiveSlotById: { 1027 parameters: { 1028 query?: never; 1029 header?: never; 1030 path: { 1031 /** @description File to be downloaded. */ 1032 slotId: components["schemas"]["Cid"]; 1033 }; 1034 cookie?: never; 1035 }; 1036 requestBody?: never; 1037 responses: { 1038 /** @description Retrieved active slot */ 1039 200: { 1040 headers: { 1041 [name: string]: unknown; 1042 }; 1043 content: { 1044 "application/json": components["schemas"]["SlotAgent"]; 1045 }; 1046 }; 1047 /** @description Invalid or missing SlotId */ 1048 400: { 1049 headers: { 1050 [name: string]: unknown; 1051 }; 1052 content?: never; 1053 }; 1054 /** @description Host is not in an active sale for the slot */ 1055 404: { 1056 headers: { 1057 [name: string]: unknown; 1058 }; 1059 content?: never; 1060 }; 1061 /** @description Persistence is not enabled */ 1062 503: { 1063 headers: { 1064 [name: string]: unknown; 1065 }; 1066 content?: never; 1067 }; 1068 }; 1069 }; 1070 getAvailabilities: { 1071 parameters: { 1072 query?: never; 1073 header?: never; 1074 path?: never; 1075 cookie?: never; 1076 }; 1077 requestBody?: never; 1078 responses: { 1079 /** @description Retrieved storage availabilities of the node */ 1080 200: { 1081 headers: { 1082 [name: string]: unknown; 1083 }; 1084 content: { 1085 "application/json": components["schemas"]["SalesAvailabilityREAD"][]; 1086 }; 1087 }; 1088 /** @description Error getting unused availabilities */ 1089 500: { 1090 headers: { 1091 [name: string]: unknown; 1092 }; 1093 content?: never; 1094 }; 1095 /** @description Persistence is not enabled */ 1096 503: { 1097 headers: { 1098 [name: string]: unknown; 1099 }; 1100 content?: never; 1101 }; 1102 }; 1103 }; 1104 offerStorage: { 1105 parameters: { 1106 query?: never; 1107 header?: never; 1108 path?: never; 1109 cookie?: never; 1110 }; 1111 requestBody?: { 1112 content: { 1113 "application/json": components["schemas"]["SalesAvailability"]; 1114 }; 1115 }; 1116 responses: { 1117 /** @description Created storage availability */ 1118 201: { 1119 headers: { 1120 [name: string]: unknown; 1121 }; 1122 content: { 1123 "application/json": components["schemas"]["SalesAvailabilityREAD"]; 1124 }; 1125 }; 1126 /** @description Invalid data input */ 1127 400: { 1128 headers: { 1129 [name: string]: unknown; 1130 }; 1131 content?: never; 1132 }; 1133 /** @description Not enough node's storage quota available or the provided parameters did not pass validation */ 1134 422: { 1135 headers: { 1136 [name: string]: unknown; 1137 }; 1138 content?: never; 1139 }; 1140 /** @description Error reserving availability */ 1141 500: { 1142 headers: { 1143 [name: string]: unknown; 1144 }; 1145 content?: never; 1146 }; 1147 /** @description Persistence is not enabled */ 1148 503: { 1149 headers: { 1150 [name: string]: unknown; 1151 }; 1152 content?: never; 1153 }; 1154 }; 1155 }; 1156 updateOfferedStorage: { 1157 parameters: { 1158 query?: never; 1159 header?: never; 1160 path: { 1161 /** @description ID of Availability */ 1162 id: string; 1163 }; 1164 cookie?: never; 1165 }; 1166 requestBody?: { 1167 content: { 1168 "application/json": components["schemas"]["SalesAvailability"]; 1169 }; 1170 }; 1171 responses: { 1172 /** @description Availability successfully updated */ 1173 204: { 1174 headers: { 1175 [name: string]: unknown; 1176 }; 1177 content?: never; 1178 }; 1179 /** @description Invalid data input */ 1180 400: { 1181 headers: { 1182 [name: string]: unknown; 1183 }; 1184 content?: never; 1185 }; 1186 /** @description Availability not found */ 1187 404: { 1188 headers: { 1189 [name: string]: unknown; 1190 }; 1191 content?: never; 1192 }; 1193 /** @description The provided parameters did not pass validation */ 1194 422: { 1195 headers: { 1196 [name: string]: unknown; 1197 }; 1198 content?: never; 1199 }; 1200 /** @description Error reserving availability */ 1201 500: { 1202 headers: { 1203 [name: string]: unknown; 1204 }; 1205 content?: never; 1206 }; 1207 /** @description Persistence is not enabled */ 1208 503: { 1209 headers: { 1210 [name: string]: unknown; 1211 }; 1212 content?: never; 1213 }; 1214 }; 1215 }; 1216 getReservations: { 1217 parameters: { 1218 query?: never; 1219 header?: never; 1220 path: { 1221 /** @description ID of Availability */ 1222 id: string; 1223 }; 1224 cookie?: never; 1225 }; 1226 requestBody?: never; 1227 responses: { 1228 /** @description Retrieved storage availabilities of the node */ 1229 200: { 1230 headers: { 1231 [name: string]: unknown; 1232 }; 1233 content: { 1234 "application/json": components["schemas"]["Reservation"][]; 1235 }; 1236 }; 1237 /** @description Invalid Availability ID */ 1238 400: { 1239 headers: { 1240 [name: string]: unknown; 1241 }; 1242 content?: never; 1243 }; 1244 /** @description Availability not found */ 1245 404: { 1246 headers: { 1247 [name: string]: unknown; 1248 }; 1249 content?: never; 1250 }; 1251 /** @description Error getting reservations */ 1252 500: { 1253 headers: { 1254 [name: string]: unknown; 1255 }; 1256 content?: never; 1257 }; 1258 /** @description Persistence is not enabled */ 1259 503: { 1260 headers: { 1261 [name: string]: unknown; 1262 }; 1263 content?: never; 1264 }; 1265 }; 1266 }; 1267 createStorageRequest: { 1268 parameters: { 1269 query?: never; 1270 header?: never; 1271 path: { 1272 /** @description CID of the uploaded data that should be stored */ 1273 cid: components["schemas"]["Cid"]; 1274 }; 1275 cookie?: never; 1276 }; 1277 requestBody?: { 1278 content: { 1279 "application/json": components["schemas"]["StorageRequestCreation"]; 1280 }; 1281 }; 1282 responses: { 1283 /** @description Returns the Request ID as decimal string */ 1284 200: { 1285 headers: { 1286 [name: string]: unknown; 1287 }; 1288 content: { 1289 "text/plain": string; 1290 }; 1291 }; 1292 /** @description Invalid or missing Request ID */ 1293 400: { 1294 headers: { 1295 [name: string]: unknown; 1296 }; 1297 content?: never; 1298 }; 1299 /** @description Request ID not found */ 1300 404: { 1301 headers: { 1302 [name: string]: unknown; 1303 }; 1304 content?: never; 1305 }; 1306 /** @description The storage request parameters are not valid */ 1307 422: { 1308 headers: { 1309 [name: string]: unknown; 1310 }; 1311 content?: never; 1312 }; 1313 /** @description Persistence is not enabled */ 1314 503: { 1315 headers: { 1316 [name: string]: unknown; 1317 }; 1318 content?: never; 1319 }; 1320 }; 1321 }; 1322 getPurchases: { 1323 parameters: { 1324 query?: never; 1325 header?: never; 1326 path?: never; 1327 cookie?: never; 1328 }; 1329 requestBody?: never; 1330 responses: { 1331 /** @description Gets all purchase IDs stored in node */ 1332 200: { 1333 headers: { 1334 [name: string]: unknown; 1335 }; 1336 content: { 1337 "application/json": string[]; 1338 }; 1339 }; 1340 /** @description Persistence is not enabled */ 1341 503: { 1342 headers: { 1343 [name: string]: unknown; 1344 }; 1345 content?: never; 1346 }; 1347 }; 1348 }; 1349 getPurchase: { 1350 parameters: { 1351 query?: never; 1352 header?: never; 1353 path: { 1354 /** @description Hexadecimal ID of a Purchase */ 1355 id: string; 1356 }; 1357 cookie?: never; 1358 }; 1359 requestBody?: never; 1360 responses: { 1361 /** @description Purchase details */ 1362 200: { 1363 headers: { 1364 [name: string]: unknown; 1365 }; 1366 content: { 1367 "application/json": components["schemas"]["Purchase"]; 1368 }; 1369 }; 1370 /** @description Invalid or missing Purchase ID */ 1371 400: { 1372 headers: { 1373 [name: string]: unknown; 1374 }; 1375 content?: never; 1376 }; 1377 /** @description Purchase not found */ 1378 404: { 1379 headers: { 1380 [name: string]: unknown; 1381 }; 1382 content?: never; 1383 }; 1384 /** @description Persistence is not enabled */ 1385 503: { 1386 headers: { 1387 [name: string]: unknown; 1388 }; 1389 content?: never; 1390 }; 1391 }; 1392 }; 1393 getSPR: { 1394 parameters: { 1395 query?: never; 1396 header?: never; 1397 path?: never; 1398 cookie?: never; 1399 }; 1400 requestBody?: never; 1401 responses: { 1402 /** @description Node's SPR */ 1403 200: { 1404 headers: { 1405 [name: string]: unknown; 1406 }; 1407 content: { 1408 "text/plain": components["schemas"]["SPR"]; 1409 "application/json": components["schemas"]["SPRRead"]; 1410 }; 1411 }; 1412 /** @description Node SPR not ready, try again later */ 1413 503: { 1414 headers: { 1415 [name: string]: unknown; 1416 }; 1417 content?: never; 1418 }; 1419 }; 1420 }; 1421 getPeerId: { 1422 parameters: { 1423 query?: never; 1424 header?: never; 1425 path?: never; 1426 cookie?: never; 1427 }; 1428 requestBody?: never; 1429 responses: { 1430 /** @description Node's Peer ID */ 1431 200: { 1432 headers: { 1433 [name: string]: unknown; 1434 }; 1435 content: { 1436 "text/plain": components["schemas"]["PeerId"]; 1437 "application/json": components["schemas"]["PeerIdRead"]; 1438 }; 1439 }; 1440 }; 1441 }; 1442 setDebugLogLevel: { 1443 parameters: { 1444 query: { 1445 level: components["schemas"]["LogLevel"]; 1446 }; 1447 header?: never; 1448 path?: never; 1449 cookie?: never; 1450 }; 1451 requestBody?: never; 1452 responses: { 1453 /** @description Successfully log level set */ 1454 200: { 1455 headers: { 1456 [name: string]: unknown; 1457 }; 1458 content?: never; 1459 }; 1460 /** @description Invalid or missing log level */ 1461 400: { 1462 headers: { 1463 [name: string]: unknown; 1464 }; 1465 content?: never; 1466 }; 1467 /** @description Well it was bad-bad */ 1468 500: { 1469 headers: { 1470 [name: string]: unknown; 1471 }; 1472 content?: never; 1473 }; 1474 }; 1475 }; 1476 getDebugInfo: { 1477 parameters: { 1478 query?: never; 1479 header?: never; 1480 path?: never; 1481 cookie?: never; 1482 }; 1483 requestBody?: never; 1484 responses: { 1485 /** @description Node's information */ 1486 200: { 1487 headers: { 1488 [name: string]: unknown; 1489 }; 1490 content: { 1491 "application/json": components["schemas"]["DebugInfo"]; 1492 }; 1493 }; 1494 }; 1495 }; 1496 }