Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 39 additions & 3 deletions api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1036,15 +1036,40 @@ paths:
schema:
type: string
description: Query string to do full text search in schema types and attributes.
- in: query
name: page
schema:
type: integer
format: uint
minimum: 1
example: 1
- in: query
name: max_results
schema:
type: integer
format: uint
example: 50
default: 50
description: Number of items to fetch on each page. Minimum is 10. Default is 50. No maximum by the moment.
- in: query
name: sort
style: form
explode: false
schema:
type: array
items:
type: string
enum: [ "importDate", "-importDate", "schemaType", "-schemaType", "schemaVersion", "-schemaVersion" ]
default: "-importDate"
description: >
The minus sign (-) before field means descending order.
responses:
'200':
description: Schema collection
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Schema'
$ref: '#/components/schemas/SchemasPaginated'
'400':
$ref: '#/components/responses/400'
'500':
Expand Down Expand Up @@ -1672,6 +1697,17 @@ components:
type: string
example: "1.0.0"

SchemasPaginated:
type: object
required: [ items, meta ]
properties:
items:
type: array
items:
$ref: '#/components/schemas/Schema'
meta:
$ref: '#/components/schemas/PaginatedMetadata'

Schema:
type: object
required:
Expand Down
50 changes: 49 additions & 1 deletion internal/api/api.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 64 additions & 2 deletions internal/api/schemas.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/polygonid/sh-id-platform/internal/core/ports"
"github.com/polygonid/sh-id-platform/internal/core/services"
"github.com/polygonid/sh-id-platform/internal/log"
"github.com/polygonid/sh-id-platform/internal/sqltools"
)

// ImportSchema is the UI endpoint to import schema metadata
Expand Down Expand Up @@ -60,12 +61,29 @@ func (s *Server) GetSchemas(ctx context.Context, request GetSchemasRequestObject
log.Error(ctx, "parsing issuer did", "err", err, "did", request.Identifier)
return GetSchemas400JSONResponse{N400JSONResponse{Message: "invalid issuer did"}}, nil
}
col, err := s.schemaService.GetAll(ctx, *issuerDID, request.Params.Query)

filter, err := getFilter(request)
if err != nil {
log.Error(ctx, "getting filter", "err", err)
return GetSchemas400JSONResponse{N400JSONResponse{Message: err.Error()}}, nil
}

col, total, err := s.schemaService.GetAll(ctx, *issuerDID, *filter)
if err != nil {
log.Error(ctx, "loading schemas", "err", err)
return GetSchemas500JSONResponse{N500JSONResponse{Message: err.Error()}}, nil
}
return GetSchemas200JSONResponse(schemaCollectionResponse(col)), nil

response := GetSchemas200JSONResponse{
Items: schemaCollectionResponse(col),
Meta: PaginatedMetadata{
Total: total,
Page: filter.Page,
MaxResults: filter.MaxResults,
},
}

return response, nil
}

func guardImportSchemaReq(req *ImportSchemaJSONRequestBody) error {
Expand All @@ -83,3 +101,47 @@ func guardImportSchemaReq(req *ImportSchemaJSONRequestBody) error {
}
return nil
}

func getFilter(req GetSchemasRequestObject) (*ports.SchemasFilter, error) {
filter := ports.SchemasFilter{}
filter.MaxResults = 50
if req.Params.MaxResults != nil {
if *req.Params.MaxResults <= 0 {
filter.MaxResults = 10
} else {
filter.MaxResults = *req.Params.MaxResults
}
}

if req.Params.Query != nil {
filter.Query = req.Params.Query
}

filter.Page = uint(1)
if req.Params.Page != nil {
filter.Page = *req.Params.Page
}

orderBy := sqltools.OrderByFilters{}
if req.Params.Sort != nil {
for _, sortBy := range *req.Params.Sort {
var err error
field, desc := strings.CutPrefix(strings.TrimSpace(string(sortBy)), "-")
switch GetSchemasParamsSort(field) {
case ImportDate:
err = orderBy.Add(ports.SchemaImportDateFilterField, desc)
case SchemaType:
err = orderBy.Add(ports.SchemaTypeFilterField, desc)
case SchemaVersion:
err = orderBy.Add(ports.SchemaVersionFilterField, desc)
default:
return nil, errors.New("wrong sort field")
}
if err != nil {
return nil, errors.New("repeated sort by value field")
}
}
}
filter.OrderBy = orderBy
return &filter, nil
}
Loading