diff --git a/ProjectPlugins/CodexPlugin/openapi.yaml b/ProjectPlugins/CodexPlugin/openapi.yaml index bfe6046..9a20212 100644 --- a/ProjectPlugins/CodexPlugin/openapi.yaml +++ b/ProjectPlugins/CodexPlugin/openapi.yaml @@ -456,9 +456,35 @@ paths: "/data/{cid}/network": get: - summary: "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." + summary: "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." tags: [ Data ] operationId: downloadNetwork + parameters: + - in: path + name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + description: "File to be downloaded." + responses: + "200": + description: Manifest information for download that has been started. + content: + application/json: + schema: + $ref: "#/components/schemas/DataItem" + "400": + description: Invalid CID is specified + "404": + description: Failed to download dataset manifest + "500": + description: Well it was bad-bad + + "/data/{cid}/network/stream": + get: + summary: "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." + tags: [ Data ] + operationId: downloadNetworkStream parameters: - in: path name: cid @@ -481,6 +507,32 @@ paths: "500": description: Well it was bad-bad + "/data/{cid}/network/manifest": + get: + summary: "Download only the dataset manifest from the network to the local node if it's not available locally." + tags: [ Data ] + operationId: downloadNetworkManifest + parameters: + - in: path + name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + description: "File for which the manifest is to be downloaded." + responses: + "200": + description: Manifest information. + content: + application/json: + schema: + $ref: "#/components/schemas/DataItem" + "400": + description: Invalid CID is specified + "404": + description: Failed to download dataset manifest + "500": + description: Well it was bad-bad + "/space": get: summary: "Gets a summary of the storage space allocation of the node." @@ -726,7 +778,7 @@ paths: "503": description: Persistence is not enabled - "/node/spr": + "/spr": get: summary: "Get Node's SPR" operationId: getSPR @@ -744,7 +796,7 @@ paths: "503": description: Node SPR not ready, try again later - "/node/peerid": + "/peerid": get: summary: "Get Node's PeerID" operationId: getPeerId @@ -792,4 +844,4 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DebugInfo" \ No newline at end of file + $ref: "#/components/schemas/DebugInfo"