cyvive / cyvive/agnostic

Phase 1: API Documentation ~ Swagger

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
good first issue Status: Available
Dominant language
JavaScript
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

[Fastify Swagger](https://github.com/fastify/fastify-swagger) is avaiable

This is not REST friendly and will force an RPC approach. However, it also provides an excellent starting point for [Introspected REST](https://introspected.rest/) automatic generation of documentation.

Suggest starting with this and as template is uplifted to Introspected REST to add a compatible upgrade path module

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names Fastify Swagger and Introspected REST but no repository files, tests, or entry points. Start by reviewing the linked Fastify Swagger and Introspected REST resources, then locate the project's API documentation setup. Done means a documented Phase 1 approach and a compatible upgrade path module, with its scope agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.