Function DocumentMessages

auditlog/message/docs.go:44–69

DocumentMessages returns a documentation for the message format.

()

// DocumentMessages returns a documentation for the message format.
func DocumentMessages() Documentation {
	typeDocs := getTypeDocs()

	msg := document(&Message{}, typeDocs)
	payloads := map[DocType]*DocStruct{}
	for _, messageType := range ListTypes() {
		payload, err := messageType.Payload()
		if err != nil {
			panic(err)
		}
		var payloadDoc *DocStruct = nil
		if payload != nil {
			d := document(payload, typeDocs)
			payloadDoc = &d
		}
		typeVal := reflect.ValueOf(messageType)
		payloads[DocType{
			Type:        messageType,
			Description: typeDocs[typeVal.Kind().String()],
		}] = payloadDoc
	}
	return Documentation{
		Message:  msg,
		Payloads: payloads,
	}
}

func getTypeDocs() map[string]string {
	fset := token.NewFileSet()