Method index

api/pkg/handlers/phone_api_key_handler.go:69–94

@Summary Get the phone API keys of a user @Description Get list phone API keys which a user has registered on the httpSMS application @Security ApiKeyAuth @Tags PhoneAPIKeys @Accept json @Produce json @Param skip query int false "number of phone api keys to skip"

(c fiber.Ctx)

// @Failure      500		{object}	responses.InternalServerError
// @Router       /phone-api-keys [get]
func (h *PhoneAPIKeyHandler) index(c fiber.Ctx) error {
	ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
	defer span.End()

	var request requests.PhoneAPIKeyIndex
	if err := c.Bind().Query(&request); err != nil {
		msg := fmt.Sprintf("cannot marshall params [%s] into %T", c.OriginalURL(), request)
		ctxLogger.Warn(stacktrace.Propagate(err, msg))
		return h.responseBadRequest(c, err)
	}

	if errors := h.validator.ValidateIndex(ctx, request.Sanitize()); len(errors) != 0 {
		msg := fmt.Sprintf("validation errors [%s], while fetching phone API keys [%+#v]", spew.Sdump(errors), request)
		ctxLogger.Warn(stacktrace.NewError(msg))
		return h.responseUnprocessableEntity(c, errors, "validation errors while fetching phone API keys")
	}

	apiKeys, err := h.service.Index(ctx, h.userIDFomContext(c), request.ToIndexParams())
	if err != nil {
		msg := fmt.Sprintf("cannot index phone API keys with params [%+#v]", request)
		ctxLogger.Error(stacktrace.Propagate(err, msg))
		return h.responseInternalServerError(c)
	}

	return h.responseOK(c, fmt.Sprintf("fetched %d phone API %s", len(apiKeys), h.pluralize("key", len(apiKeys))), apiKeys)
}

// @Summary      Store phone API key
// @Description  Creates a new phone API key which can be used to log in to the httpSMS app on your Android phone