onflow / onflow/docs

[DataAvailability] Document new rest request and response parameters

Open
#1,377 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Document the REST openAPI parameter updates from https://github.com/onflow/flow-go/issues/7625

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked flow-go issue 7625 to identify the REST request and response parameter changes. Locate the corresponding REST/OpenAPI documentation entry points in this repository, update their parameter descriptions, and verify that all changes from the upstream issue are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.