From 8a98b24ed70d9357b49beaeae713a0e9465a365e Mon Sep 17 00:00:00 2001 From: Florian RUEN Date: Mon, 4 Dec 2023 16:11:20 +0100 Subject: [PATCH] feat: remove api folder --- content/en/api/cidg-public-api.html | 417 ------------------ content/en/api/index.html | 644 ---------------------------- 2 files changed, 1061 deletions(-) delete mode 100644 content/en/api/cidg-public-api.html delete mode 100644 content/en/api/index.html diff --git a/content/en/api/cidg-public-api.html b/content/en/api/cidg-public-api.html deleted file mode 100644 index 3ffa57e..0000000 --- a/content/en/api/cidg-public-api.html +++ /dev/null @@ -1,417 +0,0 @@ - - - - - - CIDgravity Public API - - - - - - - - - -
CIDgravity logo
API docs by Redocly

CIDgravity Public API (1.0.0)

CIDgravity team: contact@cidgravity.com License: BSD-2-Clause-Patent Terms of Service

This is the CIDgravity public API
You can download the OpenAPI specification here: https://docs.cidgravity.com/openapi.yaml

-

Reporting

Retrieve single miner status check result

Get the status of a miner for a specific check id. You will get the status and some information related to the miner

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Specify the ID of the check you want to retrieve

-
id
required
integer <int32>

Responses

Response Schema: application/json
id
integer <int32>
checkId
string
isAvailable
boolean
sentOn
string <date-time>
receivedOn
string <date-time>
minerStats
any
errorRawProposal
any
proposalVersion
string
agent
string
errorCode
string
connectorVersion
string
tenantId
string

Request samples 

curl --request POST \
-  --url https://service.cidgravity.com/private/v1/miner-status-checker/get-results \
-  --header 'X-API-KEY: REPLACE_KEY_VALUE' \
-  --header 'content-type: application/json' \
-  --data '{"id":0}'

Response samples

Content type
application/json
{
  • "id": 0,
  • "checkId": "string",
  • "isAvailable": true,
  • "sentOn": "2019-08-24T14:15:22Z",
  • "receivedOn": "2019-08-24T14:15:22Z",
  • "minerStats": null,
  • "errorRawProposal": null,
  • "proposalVersion": "string",
  • "agent": "string",
  • "errorCode": "string",
  • "connectorVersion": "string",
  • "tenantId": "string"
}
- - - - diff --git a/content/en/api/index.html b/content/en/api/index.html deleted file mode 100644 index b0c5e95..0000000 --- a/content/en/api/index.html +++ /dev/null @@ -1,644 +0,0 @@ - - - - - - - API Reference | ReDoc - - - - - - - - - - -
CIDgravity logo
API docs by Redocly

CIDgravity Public API (1.0.0)

Download OpenAPI specification:Download

CIDgravity team: contact@cidgravity.com License: BSD-2-Clause-Patent Terms of Service

This is the CIDgravity public API

-

Chain info

Get reports related to accepted / rejected reasons (storage deals)

XXXX CET EXEMPLE EST FAUX LE REQUEST BODY EST MAL FORMER

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Specify a timeRange to retrieve reports details

-
knownTimeRange (string) or Timestamp (string)

Responses

Request samples

Content type
application/json
{
  • "timeRange": "60minutes"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "datesToQuery": [
    ]
}

Get report for your top 10 clients and top 10 pricing models (storage deals)

XXXX CET EXEMPLE EST FAUX LE REQUEST BODY EST MAL FORMER

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "data": {
    },
  • "datesToQuery": [
    ]
}

Get reports related to accepted storage deals

Get reports related to accepted storage deals including TransferType, DealSize, DealDuration and FilPlus (each of them include number of proposals, raw size and quality adjusted power)

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "data": {
    },
  • "datesToQuery": [
    ]
}

Get reports related to rejected storage deals

Get reports related to rejected storage deals including TransferType, DealSize, DealDuration and FilPlus (each of them include number of proposals, raw size and quality adjusted power)

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "data": {
    },
  • "datesToQuery": [
    ]
}

Get all storage deal proposals for your address that match specific filters

Get all storage deal proposals for your address that match specific filters (results paginated)

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify optional parameters to filter the list of retrieval proposal returned

-
searchTerm
string
startDate
string
endDate
string
status
string (ValidInternalDecision)
Enum: "all" "accept" "reject" "invalidProposal" "maintenance" "rateLimit" "sizeRateLimit" "acl" "retrievalRateLimit" "blacklist"
size
integer <int32>
page
integer <int32>
pricing
string

Responses

Request samples

Content type
application/json
{
  • "searchTerm": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "status": "all",
  • "size": 0,
  • "page": 0,
  • "pricing": "string"
}

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "totalCount": 0
}

Get single storage proposal that match a specific ID

Get single storage proposal that match a specific ID

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify the ID of the storage proposal to search for

-
id
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Get reports related to accepted / rejected reasons (retrieval deals)

Get reports related to accepted / rejected reasons (retrieval deals). For each reason you will retrieve number of proposal only

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "datesToQuery": [
    ]
}

Get report for your top 10 receivers (retrieval deals)

Get report for your top 10 receivers (retrieval deals) including accepted and rejected decisions

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "data": {
    },
  • "datesToQuery": [
    ]
}

Get all retrieval deal proposals for your address that match specific filters

Get retrieval storage deal proposals for your address that match specific filters (results paginated)

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify optional parameters to filter the list of retrieval proposal returned

-
searchTerm
string
startDate
string
endDate
string
status
string (ValidInternalDecision)
Enum: "all" "accept" "reject" "invalidProposal" "maintenance" "rateLimit" "sizeRateLimit" "acl" "retrievalRateLimit" "blacklist"
size
integer <int32>
page
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "searchTerm": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "status": "all",
  • "size": 0,
  • "page": 0
}

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "totalCount": 0
}

Get single retrieval proposal that match a specific ID

Get single retrieval proposal that match a specific ID

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify the ID of the retrieval proposal to search

-
id
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Get report related to miner status checker requests (last check report and availability)

Include last check for sealing pipeline and funds states + availability over time

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "lastCheckReceivedOn": "string",
  • "lastCheckInfos": {
    },
  • "lastCheckSealingPipeline": {
    },
  • "lastCheckFundsState": {
    },
  • "errorCodesAggregate": [
    ],
  • "minerAvailabilityAggregate": [
    ]
}

Get report related to sealing pipeline and sectors state

Include normalize sectors states and unormalized sectors states over time

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "SectorStatesOverTime": [
    ]
}

Stats

Get miner status check results that match a specific id

Get the status of a miner for a specific check id. You will get the status and some information related to the miner

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify the ID of the check you want to retrieve

-
id
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "checkId": "string",
  • "isAvailable": true,
  • "sentOn": "2019-08-24T14:15:22Z",
  • "receivedOn": "2019-08-24T14:15:22Z",
  • "minerStats": null,
  • "errorRawProposal": null,
  • "proposalVersion": "string",
  • "agent": "string",
  • "errorCode": "string",
  • "connectorVersion": "string",
  • "tenantId": "string"
}

Reporting

Get report related to miner funds states and wallets

Include Escrow, Collateral and PubMsg wallets over the time

-
Authorizations:
ApiKeyAuth
Request Body schema: application/json

Specify a timeRange to retrieve reports details

-
One of
any (ValidTimeRange)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "WalletsAmountsOverTime": [
    ]
}

Booking SP

Send single status check request to a provider

Send single status check request to a provider. The provider address must be passed in X-Address-ID header

-
Authorizations:
ApiKeyAuth

Responses

Request samples 

curl -X POST -H "X-API-KEY: <API_KEY>" https://services.cidgravity.com/api/v1/miner-status/send

Response samples

Content type
application/json
{
  • "boostResponse": {
    },
  • "checkId": "string"
}
- - -