Skip to content

feat: upgrade swagger and replace all perPage params #158

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

Merged
lucasepe merged 1 commit into from
Sep 18, 2025
Merged

feat: upgrade swagger and replace all perPage params #158

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
90 changes: 90 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,24 @@ const docTemplate = `{
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -189,6 +207,24 @@ const docTemplate = `{
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -268,6 +304,24 @@ const docTemplate = `{
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -347,6 +401,24 @@ const docTemplate = `{
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -426,6 +498,24 @@ const docTemplate = `{
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down
90 changes: 90 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,24 @@
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -182,6 +200,24 @@
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -261,6 +297,24 @@
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -340,6 +394,24 @@
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down Expand Up @@ -419,6 +491,24 @@
"in": "query",
"required": true
},
{
"type": "string",
"description": "Pagination desired page",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Pagination desired per page items",
"name": "perPage",
"in": "query"
},
{
"type": "string",
"description": "JSON encoded map of extra params",
"name": "extras",
"in": "query"
},
{
"description": "Object",
"name": "data",
Expand Down
60 changes: 60 additions & 0 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,18 @@ paths:
name: namespace
required: true
type: string
- description: Pagination desired page
in: query
name: page
type: string
- description: Pagination desired per page items
in: query
name: perPage
type: string
- description: JSON encoded map of extra params
in: query
name: extras
type: string
- description: Object
in: body
name: data
Expand Down Expand Up @@ -214,6 +226,18 @@ paths:
name: namespace
required: true
type: string
- description: Pagination desired page
in: query
name: page
type: string
- description: Pagination desired per page items
in: query
name: perPage
type: string
- description: JSON encoded map of extra params
in: query
name: extras
type: string
- description: Object
in: body
name: data
Expand Down Expand Up @@ -268,6 +292,18 @@ paths:
name: namespace
required: true
type: string
- description: Pagination desired page
in: query
name: page
type: string
- description: Pagination desired per page items
in: query
name: perPage
type: string
- description: JSON encoded map of extra params
in: query
name: extras
type: string
- description: Object
in: body
name: data
Expand Down Expand Up @@ -322,6 +358,18 @@ paths:
name: namespace
required: true
type: string
- description: Pagination desired page
in: query
name: page
type: string
- description: Pagination desired per page items
in: query
name: perPage
type: string
- description: JSON encoded map of extra params
in: query
name: extras
type: string
- description: Object
in: body
name: data
Expand Down Expand Up @@ -376,6 +424,18 @@ paths:
name: namespace
required: true
type: string
- description: Pagination desired page
in: query
name: page
type: string
- description: Pagination desired per page items
in: query
name: perPage
type: string
- description: JSON encoded map of extra params
in: query
name: extras
type: string
- description: Object
in: body
name: data
Expand Down
7 changes: 5 additions & 2 deletions internal/handlers/call.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ type callHandler struct {
// @Param resource query string true "Resource Plural"
// @Param name query string true "Resource name"
// @Param namespace query string true "Resource namespace"
// @Param page query string false "Pagination desired page"
// @Param perPage query string false "Pagination desired per page items"
// @Param extras query string false "JSON encoded map of extra params"
// @Param data body string false "Object"
// @Produce json
// @Success 200 {object} map[string]any
Expand Down Expand Up @@ -145,7 +148,7 @@ func (r *callHandler) validateRequest(req *http.Request) (opts callOptions, err
return
}

if val := req.URL.Query().Get("per_page"); val != "" {
if val := req.URL.Query().Get("perPage"); val != "" {
opts.perPage, err = strconv.Atoi(val)
if err != nil {
return
Expand Down Expand Up @@ -202,7 +205,7 @@ func buildURIPath(opts callOptions) (string, error) {
// Aggiunta dei query parametri, se necessario
query := url.Values{}
if opts.perPage > 0 {
query.Set("per_page", strconv.Itoa(opts.perPage))
query.Set("perPage", strconv.Itoa(opts.perPage))
}
if opts.page > 0 {
query.Set("page", strconv.Itoa(opts.page))
Expand Down
4 changes: 2 additions & 2 deletions internal/handlers/dispatchers/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ func fetchObject(req *http.Request) (got objects.Result) {
func paginationInfo(log *slog.Logger, req *http.Request) (perPage, page int) {
perPage, page = -1, -1

if val := req.URL.Query().Get("perpage"); val != "" {
if val := req.URL.Query().Get("perPage"); val != "" {
var err error
perPage, err = strconv.Atoi(val)
if err != nil {
log.Error("unable convert per_page parameter to int",
log.Error("unable convert perPage parameter to int",
slog.Any("err", err))
}
}
Expand Down
Loading