mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-15 23:40:26 +00:00
00b457e291
This will help api packages like https://codeberg.org/Cyborus/forgejo-api to generate clients that expose the header information as well. Currently `forgejo-api` has to edit the swagger json to generate a client crate that knows about headers. - Create separate response types for different endpoint behaviors - CommitList: Base type with only X-Total-Count header - CommitListWithPagination: For GetPullRequestCommits (pagination headers + X-Total-Count) - CommitListWithLegacyPagination: For GetAllCommits (pagination headers + X-Total-Count + deprecated X-Total) - ChangedFileList: Base type with only X-Total-Count header - ChangedFileListWithPagination: For GetPullRequestFiles (pagination headers + X-Total-Count) This ensures swagger documentation accurately reflects which headers each endpoint returns. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9380 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Reviewed-by: Cyborus <cyborus@disroot.org> Co-authored-by: Myers Carpenter <myers@maski.org> Co-committed-by: Myers Carpenter <myers@maski.org>
53 lines
1 KiB
Go
53 lines
1 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package swagger
|
|
|
|
import (
|
|
api "forgejo.org/modules/structs"
|
|
)
|
|
|
|
// PublicKey
|
|
// swagger:response PublicKey
|
|
type swaggerResponsePublicKey struct {
|
|
// in:body
|
|
Body api.PublicKey `json:"body"`
|
|
}
|
|
|
|
// PublicKeyList
|
|
// swagger:response PublicKeyList
|
|
type swaggerResponsePublicKeyList struct {
|
|
// in:body
|
|
Body []api.PublicKey `json:"body"`
|
|
}
|
|
|
|
// GPGKey
|
|
// swagger:response GPGKey
|
|
type swaggerResponseGPGKey struct {
|
|
// in:body
|
|
Body api.GPGKey `json:"body"`
|
|
}
|
|
|
|
// GPGKeyList
|
|
// swagger:response GPGKeyList
|
|
type swaggerResponseGPGKeyList struct {
|
|
// in:body
|
|
Body []api.GPGKey `json:"body"`
|
|
}
|
|
|
|
// DeployKey
|
|
// swagger:response DeployKey
|
|
type swaggerResponseDeployKey struct {
|
|
// in:body
|
|
Body api.DeployKey `json:"body"`
|
|
}
|
|
|
|
// DeployKeyList
|
|
// swagger:response DeployKeyList
|
|
type swaggerResponseDeployKeyList struct {
|
|
// in:body
|
|
Body []api.DeployKey `json:"body"`
|
|
|
|
// The total number of deploy keys
|
|
TotalCount int64 `json:"X-Total-Count"`
|
|
}
|