Skip to content

use headers to provide title and description params #5

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.

Sign up for GitHub

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

Open
groob wants to merge 1 commit into
base: master
Choose a base branch
from
Open

use headers to provide title and description params #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/action.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ func NewAction(method, handlerName string) (*Action, error) {
}

func (a *Action) AddRequest(req *Request, resp *Response) {
if req.Description != "" {
a.Description = req.Description
}
if req.Title != "" {
a.Title = req.Title
}
req.Response = resp
a.Requests = append(a.Requests, req)
}
26 changes: 23 additions & 3 deletions doc/request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,36 @@ func init() {
requestTmpl = template.Must(template.New("request").Parse(requestFmt))
}

const (
descriptionHeader = "X-Test2Doc-Description"
titleHeader = "X-Test2Doc-Title"
)

type Request struct {
Header *Header
Body *Body
Method string
Response *Response

// Headers which are pulled out of request
// to use for generating documentation.
Description string
Title string

// TODO:
// Attributes
// Schema
}

func NewRequest(req *http.Request) (*Request, error) {
// pull test2doc headers out of request,
// then delete header so that it's not used
// in the actual request
desc := req.Header.Get(descriptionHeader)
req.Header.Del(descriptionHeader)
title := req.Header.Get(titleHeader)
req.Header.Del(titleHeader)

body1, body2, err := cloneBody(req.Body)
if err != nil {
return nil, err
Expand All @@ -41,9 +59,11 @@ func NewRequest(req *http.Request) (*Request, error) {
contentType := req.Header.Get("Content-Type")

return &Request{
Header: NewHeader(req.Header),
Body: NewBody(b2bytes, contentType),
Method: req.Method,
Header: NewHeader(req.Header),
Body: NewBody(b2bytes, contentType),
Method: req.Method,
Description: desc,
Title: title,
}, nil
}

Expand Down