Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TIP-48: CORE-API #153

Draft
wants to merge 96 commits into
base: main
Choose a base branch
from
Draft

TIP-48: CORE-API #153

wants to merge 96 commits into from

Conversation

PhilippGackstatter
Copy link

@PhilippGackstatter PhilippGackstatter commented Oct 24, 2023

Swagger Previews:

Note that this TIP is in Draft mode and as such is still being updated.

Copy link
Member

@thibault-martinez thibault-martinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are errors when opening the Core Swagger

strongParents:
- "0x0482f0eba39a23c9a13072c93d828b55543132c47f5f57514d9e55535e9d4f4f35000000"
- "0xae7c4f55a6db8bf4841e4a38f06d32ab9bd88b927a6ba0bc19bcb19c625ff8b63c000000"
weakParents:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not ordered

blockState:
type: string
enum:
- pending
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add accepted

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't expose accepted to users.

Comment on lines +3474 to +3485
BlockFullResponse:
description: Returns the block structure and the metadata of a given block.
properties:
block:
$ref: '#/components/schemas/Block'
description: The requested block structure.
metadata:
$ref: '#/components/schemas/BlockMetadataResponse'
description: The metadata of the requested block.
required:
- block
- metadata

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be renamed to BlockWithMetadataResponse? Would be consistent with OutputWithMetadataResponse.

metrics:
blocksPerSecond: "1.1E+00"
confirmedBlocksPerSecond: "2.2E+00"
confirmationRate: "3.3E+00"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really want scientific notation?

- latestAcceptedBlockSlot
- latestConfirmedBlockSlot
- pruningEpoch
metrics:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be put into its own route + response

- block
- metadata

BlockMetadataResponse:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be updated to latest (and examples)

- blockId
- blockState

TransactionMetadataResponse:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be updated to latest (and examples)

description: Return the information of committee members at the given epoch index. If epoch index is not provided, the current committee members are returned.
parameters:
- in: query
name: epochIndex
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: epochIndex
name: epoch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants