hashgraph / hashgraph/guardian

Migrate Statis API Docs to Open API Spec

Open
#6,656 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
146
Forks
186
Avg merge
2d 15h
Merged PRs (30d)
116

Description

## Job Story

When reviewing API docs, I want the content to be autogenerated from the actual openapi spec, so that I can be sure that its accurate.

## Acceptance Criteria

* [ ] review static docs https://guardian.hedera.com/docs/develop/developer-tools/api-reference
* [ ] migrate anything useful over to https://guardian.hedera.com/api-reference-guardian
* [ ] delete static docs section

## Artifacts & Considerations

_Add supporting artifacts and considerations_

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the static API docs at https://guardian.hedera.com/docs/develop/developer-tools/api-reference and the OpenAPI-backed reference at https://guardian.hedera.com/api-reference-guardian; inventory useful content and identify where the static docs section is defined. Done means useful content is available in the OpenAPI reference and the static docs section has been removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.