dingo / dingo/blueprint

How do you guys adding overview section?

Open
#59 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
270
Forks
105
PR merge metrics
No merged PRs in 30d

Description

I'm working on an API service, which have some endpoints are handled by third-party libraries(e.g: Laravel Passport) and have a general error format that should be output to the final blueprint document.

I want to place an overview section before main content like this:
https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#def-api-name-section

Sadly, it seems not supported by `dingo/blueprint`, so I create a new controller, define several empty methods to output these documents.

Is there anyway that I can insert contents as overview section into the blueprint document?

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the requested overview section with the linked API Blueprint specification, then inspect dingo/blueprint's document-generation entry points and the controller approach described in the issue. Determine whether the generated document can include overview content and a general error format before its main content; done means both appear in valid Blueprint output.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.