[PR #1408] [MERGED] Add documentation for common configuration fields, common proxy configuration, and sessions #4380

New issue

Closed

opened 2026-05-05 14:41:00 -06:00 by gitea-mirror · 0 comments

gitea-mirror commented

2026-05-05 14:41:00 -06:00

Owner

📋 Pull Request Information

Original PR: https://github.com/fatedier/frp/pull/1408
Author: @velovix
Created: 8/24/2019
Status: ✅ Merged
Merged: 8/25/2019
Merged by: @fatedier

Base: dev ← Head: issue-1387_api-documentation

📝 Commits (2)

4dfd851 Add docs for common config fields & sessions
9279126 Add documentation for base proxy config

📊 Changes

4 files changed (+261 additions, -73 deletions)

View changed files

📝 client/service.go (+2 -0)
📝 models/config/client_common.go (+93 -27)
📝 models/config/proxy.go (+64 -20)
📝 models/config/server_common.go (+102 -26)

📄 Description

Now that the common configuration objects and session objects are part of a public API, they need to be documented in a way that can be read with GoDoc.

This documentation is not yet complete on the client side. I still need to write documentation for the specific proxy objects like TcpProxyConf and HttpProxyConf, but I figured this was enough to review for one pull request.

I documented these fields to the best of my ability but I'm sure I got some details wrong. Please let me know what I can clarify and improve.

Related: #1387

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/fatedier/frp/pull/1408 **Author:** [@velovix](https://github.com/velovix) **Created:** 8/24/2019 **Status:** ✅ Merged **Merged:** 8/25/2019 **Merged by:** [@fatedier](https://github.com/fatedier) **Base:** `dev` ← **Head:** `issue-1387_api-documentation` --- ### 📝 Commits (2) - [`4dfd851`](https://github.com/fatedier/frp/commit/4dfd851c462e7b17a2177a79419e7063897d1ff5) Add docs for common config fields & sessions - [`9279126`](https://github.com/fatedier/frp/commit/92791260a7066d21ac86a1d22e0c3bdee184ef98) Add documentation for base proxy config ### 📊 Changes **4 files changed** (+261 additions, -73 deletions) <details> <summary>View changed files</summary> 📝 `client/service.go` (+2 -0) 📝 `models/config/client_common.go` (+93 -27) 📝 `models/config/proxy.go` (+64 -20) 📝 `models/config/server_common.go` (+102 -26) </details> ### 📄 Description Now that the common configuration objects and session objects are part of a public API, they need to be documented in a way that can be read with GoDoc. This documentation is not yet complete on the client side. I still need to write documentation for the specific proxy objects like TcpProxyConf and HttpProxyConf, but I figured this was enough to review for one pull request. I documented these fields to the best of my ability but I'm sure I got some details wrong. Please let me know what I can clarify and improve. Related: #1387 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>