Skip to content

Commit

Permalink
Update DataAPI endpt to kebab-case
Browse files Browse the repository at this point in the history
  • Loading branch information
Siddharth More authored and Siddharth More committed Feb 19, 2024
1 parent 3340da9 commit ee947a2
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 40 deletions.
50 changes: 40 additions & 10 deletions disperser/dataapi/docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const docTemplate = `{
}
}
},
"/feed/blobs/{blob_key}": {
"/feed/blobs/{blob-key}": {
"get": {
"produces": [
"application/json"
Expand All @@ -73,7 +73,7 @@ const docTemplate = `{
{
"type": "string",
"description": "Blob Key",
"name": "blob_key",
"name": "blob-key",
"in": "path",
"required": true
}
Expand Down Expand Up @@ -163,7 +163,7 @@ const docTemplate = `{
}
}
},
"/metrics/non_signers": {
"/metrics/non-signers": {
"get": {
"produces": [
"application/json"
Expand Down Expand Up @@ -211,7 +211,7 @@ const docTemplate = `{
}
}
},
"/metrics/operator_nonsigning_percentage": {
"/metrics/operator-nonsigning-percentage": {
"get": {
"produces": [
"application/json"
Expand Down Expand Up @@ -353,17 +353,20 @@ const docTemplate = `{
"type": "object",
"properties": {
"commitment": {
"$ref": "#/definitions/core.Commitment"
"$ref": "#/definitions/core.G1Commitment"
},
"length": {
"type": "integer"
},
"length_commitment": {
"$ref": "#/definitions/core.G2Commitment"
},
"length_proof": {
"$ref": "#/definitions/core.Commitment"
"$ref": "#/definitions/core.LengthProof"
}
}
},
"core.Commitment": {
"core.G1Commitment": {
"type": "object",
"properties": {
"x": {
Expand All @@ -374,6 +377,22 @@ const docTemplate = `{
}
}
},
"core.G2Commitment": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"core.LengthProof": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"core.SecurityParam": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -406,6 +425,9 @@ const docTemplate = `{
"batch_root": {
"type": "string"
},
"blob-key": {
"type": "string"
},
"blob_commitment": {
"$ref": "#/definitions/core.BlobCommitments"
},
Expand All @@ -415,9 +437,6 @@ const docTemplate = `{
"blob_index": {
"type": "integer"
},
"blob_key": {
"type": "string"
},
"blob_status": {
"$ref": "#/definitions/github_com_Layr-Labs_eigenda_disperser.BlobStatus"
},
Expand Down Expand Up @@ -591,6 +610,17 @@ const docTemplate = `{
"Finalized",
"InsufficientSignatures"
]
},
"github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2": {
"type": "object",
"properties": {
"a0": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}`
Expand Down
50 changes: 40 additions & 10 deletions disperser/dataapi/docs/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
}
}
},
"/feed/blobs/{blob_key}": {
"/feed/blobs/{blob-key}": {
"get": {
"produces": [
"application/json"
Expand All @@ -69,7 +69,7 @@
{
"type": "string",
"description": "Blob Key",
"name": "blob_key",
"name": "blob-key",
"in": "path",
"required": true
}
Expand Down Expand Up @@ -159,7 +159,7 @@
}
}
},
"/metrics/non_signers": {
"/metrics/non-signers": {
"get": {
"produces": [
"application/json"
Expand Down Expand Up @@ -207,7 +207,7 @@
}
}
},
"/metrics/operator_nonsigning_percentage": {
"/metrics/operator-nonsigning-percentage": {
"get": {
"produces": [
"application/json"
Expand Down Expand Up @@ -349,17 +349,20 @@
"type": "object",
"properties": {
"commitment": {
"$ref": "#/definitions/core.Commitment"
"$ref": "#/definitions/core.G1Commitment"
},
"length": {
"type": "integer"
},
"length_commitment": {
"$ref": "#/definitions/core.G2Commitment"
},
"length_proof": {
"$ref": "#/definitions/core.Commitment"
"$ref": "#/definitions/core.LengthProof"
}
}
},
"core.Commitment": {
"core.G1Commitment": {
"type": "object",
"properties": {
"x": {
Expand All @@ -370,6 +373,22 @@
}
}
},
"core.G2Commitment": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"core.LengthProof": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"core.SecurityParam": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -402,6 +421,9 @@
"batch_root": {
"type": "string"
},
"blob-key": {
"type": "string"
},
"blob_commitment": {
"$ref": "#/definitions/core.BlobCommitments"
},
Expand All @@ -411,9 +433,6 @@
"blob_index": {
"type": "integer"
},
"blob_key": {
"type": "string"
},
"blob_status": {
"$ref": "#/definitions/github_com_Layr-Labs_eigenda_disperser.BlobStatus"
},
Expand Down Expand Up @@ -587,6 +606,17 @@
"Finalized",
"InsufficientSignatures"
]
},
"github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2": {
"type": "object",
"properties": {
"a0": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
37 changes: 28 additions & 9 deletions disperser/dataapi/docs/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,31 @@ definitions:
core.BlobCommitments:
properties:
commitment:
$ref: '#/definitions/core.Commitment'
$ref: '#/definitions/core.G1Commitment'
length:
type: integer
length_commitment:
$ref: '#/definitions/core.G2Commitment'
length_proof:
$ref: '#/definitions/core.Commitment'
$ref: '#/definitions/core.LengthProof'
type: object
core.Commitment:
core.G1Commitment:
properties:
x:
items:
type: integer
type: array
type: object
core.G2Commitment:
properties:
x:
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
type: object
core.LengthProof:
properties:
x:
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
type: object
core.SecurityParam:
properties:
adversary_threshold:
Expand Down Expand Up @@ -44,14 +56,14 @@ definitions:
type: integer
batch_root:
type: string
blob-key:
type: string
blob_commitment:
$ref: '#/definitions/core.BlobCommitments'
blob_inclusion_proof:
type: string
blob_index:
type: integer
blob_key:
type: string
blob_status:
$ref: '#/definitions/github_com_Layr-Labs_eigenda_disperser.BlobStatus'
confirmation_block_number:
Expand Down Expand Up @@ -167,6 +179,13 @@ definitions:
- Failed
- Finalized
- InsufficientSignatures
github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2:
properties:
a0:
items:
type: integer
type: array
type: object
info:
contact: {}
description: This is the EigenDA Data Access API server.
Expand Down Expand Up @@ -202,12 +221,12 @@ paths:
summary: Fetch blobs metadata list
tags:
- Feed
/feed/blobs/{blob_key}:
/feed/blobs/{blob-key}:
get:
parameters:
- description: Blob Key
in: path
name: blob_key
name: blob-key
required: true
type: string
produces:
Expand Down Expand Up @@ -269,7 +288,7 @@ paths:
summary: Fetch metrics
tags:
- Metrics
/metrics/non_signers:
/metrics/non-signers:
get:
parameters:
- description: 'Interval to query for non signers in seconds [default: 3600]'
Expand Down Expand Up @@ -300,7 +319,7 @@ paths:
summary: Fetch non signers
tags:
- Metrics
/metrics/operator_nonsigning_percentage:
/metrics/operator-nonsigning-percentage:
get:
parameters:
- description: 'Interval to query for operators nonsigning percentage [default:
Expand Down
Loading

0 comments on commit ee947a2

Please sign in to comment.