extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-20 17:58:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

more spec lint; frontendId (#834)

Browse Source
This commit is contained in:
Michael Quigley 2025-02-04 16:37:45 -05:00
parent a71f9eb3b1
commit f7cf5430d7
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
19 changed files with 92 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
controller/frontendDetail.go
View File

@ -20,9 +20,9 @@ func (h *getFrontendDetailHandler) Handle(params metadata.GetFrontendDetailParam
return metadata.NewGetFrontendDetailInternalServerError() return metadata.NewGetFrontendDetailInternalServerError()
} }
defer func() { _ = trx.Rollback() }() defer func() { _ = trx.Rollback() }()
fe, err := str.GetFrontend(int(params.FeID), trx) fe, err := str.GetFrontend(int(params.FrontendID), trx)
if err != nil { if err != nil {
logrus.Errorf("error finding share '%d': %v", params.FeID, err) logrus.Errorf("error finding share '%d': %v", params.FrontendID, err)
return metadata.NewGetFrontendDetailNotFound() return metadata.NewGetFrontendDetailNotFound()
} }
envs, err := str.FindEnvironmentsForAccount(int(principal.ID), trx) envs, err := str.FindEnvironmentsForAccount(int(principal.ID), trx)

2
rest_client_zrok/account/change_password_responses.go
View File

@ -68,7 +68,7 @@ func NewChangePasswordOK() *ChangePasswordOK {
/* /*
ChangePasswordOK describes a response with status code 200, with default header values. ChangePasswordOK describes a response with status code 200, with default header values.
changed password password changed
*/ */
type ChangePasswordOK struct { type ChangePasswordOK struct {
} }

4
rest_client_zrok/account/reset_password_request_responses.go
View File

@ -53,7 +53,7 @@ func NewResetPasswordRequestCreated() *ResetPasswordRequestCreated {
/* /*
ResetPasswordRequestCreated describes a response with status code 201, with default header values. ResetPasswordRequestCreated describes a response with status code 201, with default header values.
forgot password request created reset password request created
*/ */
type ResetPasswordRequestCreated struct { type ResetPasswordRequestCreated struct {
} }
@ -109,7 +109,7 @@ func NewResetPasswordRequestBadRequest() *ResetPasswordRequestBadRequest {
/* /*
ResetPasswordRequestBadRequest describes a response with status code 400, with default header values. ResetPasswordRequestBadRequest describes a response with status code 400, with default header values.
forgot password request not created reset password request not created
*/ */
type ResetPasswordRequestBadRequest struct { type ResetPasswordRequestBadRequest struct {
} }

20
rest_client_zrok/metadata/get_frontend_detail_parameters.go
View File

@ -62,8 +62,8 @@ GetFrontendDetailParams contains all the parameters to send to the API endpoint
*/ */
type GetFrontendDetailParams struct { type GetFrontendDetailParams struct {
// FeID. // FrontendID.
FeID int64 FrontendID int64
timeout time.Duration timeout time.Duration
Context context.Context Context context.Context
@ -118,15 +118,15 @@ func (o *GetFrontendDetailParams) SetHTTPClient(client *http.Client) {
o.HTTPClient = client o.HTTPClient = client
} }
// WithFeID adds the feID to the get frontend detail params // WithFrontendID adds the frontendID to the get frontend detail params
func (o *GetFrontendDetailParams) WithFeID(feID int64) *GetFrontendDetailParams { func (o *GetFrontendDetailParams) WithFrontendID(frontendID int64) *GetFrontendDetailParams {
o.SetFeID(feID) o.SetFrontendID(frontendID)
return o return o
} }
// SetFeID adds the feId to the get frontend detail params // SetFrontendID adds the frontendId to the get frontend detail params
func (o *GetFrontendDetailParams) SetFeID(feID int64) { func (o *GetFrontendDetailParams) SetFrontendID(frontendID int64) {
o.FeID = feID o.FrontendID = frontendID
} }
// WriteToRequest writes these params to a swagger request // WriteToRequest writes these params to a swagger request
@ -137,8 +137,8 @@ func (o *GetFrontendDetailParams) WriteToRequest(r runtime.ClientRequest, reg st
} }
var res []error var res []error
// path param feId // path param frontendId
if err := r.SetPathParam("feId", swag.FormatInt64(o.FeID)); err != nil { if err := r.SetPathParam("frontendId", swag.FormatInt64(o.FrontendID)); err != nil {
return err return err
} }

18
rest_client_zrok/metadata/get_frontend_detail_responses.go
View File

@ -48,7 +48,7 @@ func (o *GetFrontendDetailReader) ReadResponse(response runtime.ClientResponse,
} }
return nil, result return nil, result
default: default:
return nil, runtime.NewAPIError("[GET /detail/frontend/{feId}] getFrontendDetail", response, response.Code()) return nil, runtime.NewAPIError("[GET /detail/frontend/{frontendId}] getFrontendDetail", response, response.Code())
} }
} }
@ -97,11 +97,11 @@ func (o *GetFrontendDetailOK) Code() int {
} }
func (o *GetFrontendDetailOK) Error() string { func (o *GetFrontendDetailOK) Error() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailOK %+v", 200, o.Payload) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailOK %+v", 200, o.Payload)
} }
func (o *GetFrontendDetailOK) String() string { func (o *GetFrontendDetailOK) String() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailOK %+v", 200, o.Payload) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailOK %+v", 200, o.Payload)
} }
func (o *GetFrontendDetailOK) GetPayload() *rest_model_zrok.Frontend { func (o *GetFrontendDetailOK) GetPayload() *rest_model_zrok.Frontend {
@ -164,11 +164,11 @@ func (o *GetFrontendDetailUnauthorized) Code() int {
} }
func (o *GetFrontendDetailUnauthorized) Error() string { func (o *GetFrontendDetailUnauthorized) Error() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailUnauthorized ", 401) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailUnauthorized ", 401)
} }
func (o *GetFrontendDetailUnauthorized) String() string { func (o *GetFrontendDetailUnauthorized) String() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailUnauthorized ", 401) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailUnauthorized ", 401)
} }
func (o *GetFrontendDetailUnauthorized) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { func (o *GetFrontendDetailUnauthorized) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error {
@ -220,11 +220,11 @@ func (o *GetFrontendDetailNotFound) Code() int {
} }
func (o *GetFrontendDetailNotFound) Error() string { func (o *GetFrontendDetailNotFound) Error() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailNotFound ", 404) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailNotFound ", 404)
} }
func (o *GetFrontendDetailNotFound) String() string { func (o *GetFrontendDetailNotFound) String() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailNotFound ", 404) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailNotFound ", 404)
} }
func (o *GetFrontendDetailNotFound) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { func (o *GetFrontendDetailNotFound) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error {
@ -276,11 +276,11 @@ func (o *GetFrontendDetailInternalServerError) Code() int {
} }
func (o *GetFrontendDetailInternalServerError) Error() string { func (o *GetFrontendDetailInternalServerError) Error() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailInternalServerError ", 500) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailInternalServerError ", 500)
} }
func (o *GetFrontendDetailInternalServerError) String() string { func (o *GetFrontendDetailInternalServerError) String() string {
return fmt.Sprintf("[GET /detail/frontend/{feId}][%d] getFrontendDetailInternalServerError ", 500) return fmt.Sprintf("[GET /detail/frontend/{frontendId}][%d] getFrontendDetailInternalServerError ", 500)
} }
func (o *GetFrontendDetailInternalServerError) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { func (o *GetFrontendDetailInternalServerError) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error {

2
rest_client_zrok/metadata/metadata_client.go
View File

@ -266,7 +266,7 @@ func (a *Client) GetFrontendDetail(params *GetFrontendDetailParams, authInfo run
op := &runtime.ClientOperation{ op := &runtime.ClientOperation{
ID: "getFrontendDetail", ID: "getFrontendDetail",
Method: "GET", Method: "GET",
PathPattern: "/detail/frontend/{feId}", PathPattern: "/detail/frontend/{frontendId}",
ProducesMediaTypes: []string{"application/zrok.v1+json"}, ProducesMediaTypes: []string{"application/zrok.v1+json"},
ConsumesMediaTypes: []string{"application/zrok.v1+json"}, ConsumesMediaTypes: []string{"application/zrok.v1+json"},
Schemes: []string{"http"}, Schemes: []string{"http"},

20
rest_server_zrok/embedded_spec.go
View File

@ -167,7 +167,7 @@ func init() {
], ],
"responses": { "responses": {
"200": { "200": {
"description": "changed password" "description": "password changed"
}, },
"400": { "400": {
"description": "password not changed" "description": "password not changed"
@ -265,7 +265,7 @@ func init() {
} }
} }
}, },
"/detail/frontend/{feId}": { "/detail/frontend/{frontendId}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -279,7 +279,7 @@ func init() {
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"name": "feId", "name": "frontendId",
"in": "path", "in": "path",
"required": true "required": true
} }
@ -1537,10 +1537,10 @@ func init() {
], ],
"responses": { "responses": {
"201": { "201": {
"description": "forgot password request created" "description": "reset password request created"
}, },
"400": { "400": {
"description": "forgot password request not created" "description": "reset password request not created"
}, },
"500": { "500": {
"description": "internal server error" "description": "internal server error"
@ -2364,7 +2364,7 @@ func init() {
], ],
"responses": { "responses": {
"200": { "200": {
"description": "changed password" "description": "password changed"
}, },
"400": { "400": {
"description": "password not changed" "description": "password not changed"
@ -2462,7 +2462,7 @@ func init() {
} }
} }
}, },
"/detail/frontend/{feId}": { "/detail/frontend/{frontendId}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -2476,7 +2476,7 @@ func init() {
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"name": "feId", "name": "frontendId",
"in": "path", "in": "path",
"required": true "required": true
} }
@ -3683,10 +3683,10 @@ func init() {
], ],
"responses": { "responses": {
"201": { "201": {
"description": "forgot password request created" "description": "reset password request created"
}, },
"400": { "400": {
"description": "forgot password request not created" "description": "reset password request not created"
}, },
"500": { "500": {
"description": "internal server error" "description": "internal server error"

2
rest_server_zrok/operations/account/change_password_responses.go
View File

@ -17,7 +17,7 @@ import (
const ChangePasswordOKCode int = 200 const ChangePasswordOKCode int = 200
/* /*
ChangePasswordOK changed password ChangePasswordOK password changed
swagger:response changePasswordOK swagger:response changePasswordOK
*/ */

4
rest_server_zrok/operations/account/reset_password_request_responses.go
View File

@ -15,7 +15,7 @@ import (
const ResetPasswordRequestCreatedCode int = 201 const ResetPasswordRequestCreatedCode int = 201
/* /*
ResetPasswordRequestCreated forgot password request created ResetPasswordRequestCreated reset password request created
swagger:response resetPasswordRequestCreated swagger:response resetPasswordRequestCreated
*/ */
@ -40,7 +40,7 @@ func (o *ResetPasswordRequestCreated) WriteResponse(rw http.ResponseWriter, prod
const ResetPasswordRequestBadRequestCode int = 400 const ResetPasswordRequestBadRequestCode int = 400
/* /*
ResetPasswordRequestBadRequest forgot password request not created ResetPasswordRequestBadRequest reset password request not created
swagger:response resetPasswordRequestBadRequest swagger:response resetPasswordRequestBadRequest
*/ */

2
rest_server_zrok/operations/metadata/get_frontend_detail.go
View File

@ -32,7 +32,7 @@ func NewGetFrontendDetail(ctx *middleware.Context, handler GetFrontendDetailHand
} }
/* /*
GetFrontendDetail swagger:route GET /detail/frontend/{feId} metadata getFrontendDetail GetFrontendDetail swagger:route GET /detail/frontend/{frontendId} metadata getFrontendDetail
GetFrontendDetail get frontend detail API GetFrontendDetail get frontend detail API
*/ */

14
rest_server_zrok/operations/metadata/get_frontend_detail_parameters.go
View File

@ -35,7 +35,7 @@ type GetFrontendDetailParams struct {
Required: true Required: true
In: path In: path
*/ */
FeID int64 FrontendID int64
} }
// BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface // BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface
@ -47,8 +47,8 @@ func (o *GetFrontendDetailParams) BindRequest(r *http.Request, route *middleware
o.HTTPRequest = r o.HTTPRequest = r
rFeID, rhkFeID, _ := route.Params.GetOK("feId") rFrontendID, rhkFrontendID, _ := route.Params.GetOK("frontendId")
if err := o.bindFeID(rFeID, rhkFeID, route.Formats); err != nil { if err := o.bindFrontendID(rFrontendID, rhkFrontendID, route.Formats); err != nil {
res = append(res, err) res = append(res, err)
} }
if len(res) > 0 { if len(res) > 0 {
@ -57,8 +57,8 @@ func (o *GetFrontendDetailParams) BindRequest(r *http.Request, route *middleware
return nil return nil
} }
// bindFeID binds and validates parameter FeID from path. // bindFrontendID binds and validates parameter FrontendID from path.
func (o *GetFrontendDetailParams) bindFeID(rawData []string, hasKey bool, formats strfmt.Registry) error { func (o *GetFrontendDetailParams) bindFrontendID(rawData []string, hasKey bool, formats strfmt.Registry) error {
var raw string var raw string
if len(rawData) > 0 { if len(rawData) > 0 {
raw = rawData[len(rawData)-1] raw = rawData[len(rawData)-1]
@ -69,9 +69,9 @@ func (o *GetFrontendDetailParams) bindFeID(rawData []string, hasKey bool, format
value, err := swag.ConvertInt64(raw) value, err := swag.ConvertInt64(raw)
if err != nil { if err != nil {
return errors.InvalidType("feId", "path", "int64", raw) return errors.InvalidType("frontendId", "path", "int64", raw)
} }
o.FeID = value o.FrontendID = value
return nil return nil
} }

12
rest_server_zrok/operations/metadata/get_frontend_detail_urlbuilder.go
View File

@ -16,7 +16,7 @@ import (
// GetFrontendDetailURL generates an URL for the get frontend detail operation // GetFrontendDetailURL generates an URL for the get frontend detail operation
type GetFrontendDetailURL struct { type GetFrontendDetailURL struct {
FeID int64 FrontendID int64
_basePath string _basePath string
// avoid unkeyed usage // avoid unkeyed usage
@ -42,13 +42,13 @@ func (o *GetFrontendDetailURL) SetBasePath(bp string) {
func (o *GetFrontendDetailURL) Build() (*url.URL, error) { func (o *GetFrontendDetailURL) Build() (*url.URL, error) {
var _result url.URL var _result url.URL
var _path = "/detail/frontend/{feId}" var _path = "/detail/frontend/{frontendId}"
feID := swag.FormatInt64(o.FeID) frontendID := swag.FormatInt64(o.FrontendID)
if feID != "" { if frontendID != "" {
_path = strings.Replace(_path, "{feId}", feID, -1) _path = strings.Replace(_path, "{frontendId}", frontendID, -1)
} else { } else {
return nil, errors.New("feId is required on GetFrontendDetailURL") return nil, errors.New("frontendId is required on GetFrontendDetailURL")
} }
_basePath := o._basePath _basePath := o._basePath

2
rest_server_zrok/operations/zrok_api.go
View File

@ -690,7 +690,7 @@ func (o *ZrokAPI) initHandlerCache() {
if o.handlers["GET"] == nil { if o.handlers["GET"] == nil {
o.handlers["GET"] = make(map[string]http.Handler) o.handlers["GET"] = make(map[string]http.Handler)
} }
o.handlers["GET"]["/detail/frontend/{feId}"] = metadata.NewGetFrontendDetail(o.context, o.MetadataGetFrontendDetailHandler) o.handlers["GET"]["/detail/frontend/{frontendId}"] = metadata.NewGetFrontendDetail(o.context, o.MetadataGetFrontendDetailHandler)
if o.handlers["GET"] == nil { if o.handlers["GET"] == nil {
o.handlers["GET"] = make(map[string]http.Handler) o.handlers["GET"] = make(map[string]http.Handler)
} }

14
sdk/nodejs/sdk/src/zrok/api/api/metadataApi.ts
View File

@ -442,11 +442,11 @@ export class MetadataApi {
} }
/** /**
* *
* @param feId * @param frontendId
*/ */
public async getFrontendDetail (feId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Frontend; }> { public async getFrontendDetail (frontendId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Frontend; }> {
const localVarPath = this.basePath + '/detail/frontend/{feId}' const localVarPath = this.basePath + '/detail/frontend/{frontendId}'
.replace('{' + 'feId' + '}', encodeURIComponent(String(feId))); .replace('{' + 'frontendId' + '}', encodeURIComponent(String(frontendId)));
let localVarQueryParameters: any = {}; let localVarQueryParameters: any = {};
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders); let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
const produces = ['application/zrok.v1+json']; const produces = ['application/zrok.v1+json'];
@ -458,9 +458,9 @@ export class MetadataApi {
} }
let localVarFormParams: any = {}; let localVarFormParams: any = {};
// verify required parameter 'feId' is not null or undefined // verify required parameter 'frontendId' is not null or undefined
if (feId === null || feId === undefined) { if (frontendId === null || frontendId === undefined) {
throw new Error('Required parameter feId was null or undefined when calling getFrontendDetail.'); throw new Error('Required parameter frontendId was null or undefined when calling getFrontendDetail.');
} }
(<any>Object).assign(localVarHeaderParams, options.headers); (<any>Object).assign(localVarHeaderParams, options.headers);

2
sdk/python/sdk/zrok/README.md
View File

@ -175,7 +175,7 @@ Class | Method | HTTP request | Description
*MetadataApi* | [**get_account_metrics**](docs/MetadataApi.md#get_account_metrics) | **GET** /metrics/account | *MetadataApi* | [**get_account_metrics**](docs/MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
*MetadataApi* | [**get_environment_detail**](docs/MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} | *MetadataApi* | [**get_environment_detail**](docs/MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
*MetadataApi* | [**get_environment_metrics**](docs/MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} | *MetadataApi* | [**get_environment_metrics**](docs/MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
*MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{feId} | *MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
*MetadataApi* | [**get_share_detail**](docs/MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} | *MetadataApi* | [**get_share_detail**](docs/MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
*MetadataApi* | [**get_share_metrics**](docs/MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} | *MetadataApi* | [**get_share_metrics**](docs/MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
*MetadataApi* | [**get_sparklines**](docs/MetadataApi.md#get_sparklines) | **POST** /sparklines | *MetadataApi* | [**get_sparklines**](docs/MetadataApi.md#get_sparklines) | **POST** /sparklines |

10
sdk/python/sdk/zrok/docs/MetadataApi.md
View File

@ -9,7 +9,7 @@ Method | HTTP request | Description
[**get_account_metrics**](MetadataApi.md#get_account_metrics) | **GET** /metrics/account | [**get_account_metrics**](MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
[**get_environment_detail**](MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} | [**get_environment_detail**](MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
[**get_environment_metrics**](MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} | [**get_environment_metrics**](MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
[**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{feId} | [**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
[**get_share_detail**](MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} | [**get_share_detail**](MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
[**get_share_metrics**](MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} | [**get_share_metrics**](MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
[**get_sparklines**](MetadataApi.md#get_sparklines) | **POST** /sparklines | [**get_sparklines**](MetadataApi.md#get_sparklines) | **POST** /sparklines |
@ -263,7 +263,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_frontend_detail** # **get_frontend_detail**
> Frontend get_frontend_detail(fe_id) > Frontend get_frontend_detail(frontend_id)
@ -283,10 +283,10 @@ configuration.api_key['x-token'] = 'YOUR_API_KEY'
# create an instance of the API class # create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration)) api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
fe_id = 56 # int | frontend_id = 56 # int |
try: try:
api_response = api_instance.get_frontend_detail(fe_id) api_response = api_instance.get_frontend_detail(frontend_id)
pprint(api_response) pprint(api_response)
except ApiException as e: except ApiException as e:
print("Exception when calling MetadataApi->get_frontend_detail: %s\n" % e) print("Exception when calling MetadataApi->get_frontend_detail: %s\n" % e)
@ -296,7 +296,7 @@ except ApiException as e:
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**fe_id** | **int**| | **frontend_id** | **int**| |
### Return type ### Return type

32
sdk/python/sdk/zrok/zrok_api/api/metadata_api.py
View File

@ -481,43 +481,43 @@ class MetadataApi(object):
_request_timeout=params.get('_request_timeout'), _request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats) collection_formats=collection_formats)
def get_frontend_detail(self, fe_id, **kwargs): # noqa: E501 def get_frontend_detail(self, frontend_id, **kwargs): # noqa: E501
"""get_frontend_detail # noqa: E501 """get_frontend_detail # noqa: E501
This method makes a synchronous HTTP request by default. To make an This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_frontend_detail(fe_id, async_req=True) >>> thread = api.get_frontend_detail(frontend_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool
:param int fe_id: (required) :param int frontend_id: (required)
:return: Frontend :return: Frontend
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
kwargs['_return_http_data_only'] = True kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'): if kwargs.get('async_req'):
return self.get_frontend_detail_with_http_info(fe_id, **kwargs) # noqa: E501 return self.get_frontend_detail_with_http_info(frontend_id, **kwargs) # noqa: E501
else: else:
(data) = self.get_frontend_detail_with_http_info(fe_id, **kwargs) # noqa: E501 (data) = self.get_frontend_detail_with_http_info(frontend_id, **kwargs) # noqa: E501
return data return data
def get_frontend_detail_with_http_info(self, fe_id, **kwargs): # noqa: E501 def get_frontend_detail_with_http_info(self, frontend_id, **kwargs): # noqa: E501
"""get_frontend_detail # noqa: E501 """get_frontend_detail # noqa: E501
This method makes a synchronous HTTP request by default. To make an This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_frontend_detail_with_http_info(fe_id, async_req=True) >>> thread = api.get_frontend_detail_with_http_info(frontend_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool
:param int fe_id: (required) :param int frontend_id: (required)
:return: Frontend :return: Frontend
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
all_params = ['fe_id'] # noqa: E501 all_params = ['frontend_id'] # noqa: E501
all_params.append('async_req') all_params.append('async_req')
all_params.append('_return_http_data_only') all_params.append('_return_http_data_only')
all_params.append('_preload_content') all_params.append('_preload_content')
@ -532,16 +532,16 @@ class MetadataApi(object):
) )
params[key] = val params[key] = val
del params['kwargs'] del params['kwargs']
# verify the required parameter 'fe_id' is set # verify the required parameter 'frontend_id' is set
if ('fe_id' not in params or if ('frontend_id' not in params or
params['fe_id'] is None): params['frontend_id'] is None):
raise ValueError("Missing the required parameter `fe_id` when calling `get_frontend_detail`") # noqa: E501 raise ValueError("Missing the required parameter `frontend_id` when calling `get_frontend_detail`") # noqa: E501
collection_formats = {} collection_formats = {}
path_params = {} path_params = {}
if 'fe_id' in params: if 'frontend_id' in params:
path_params['feId'] = params['fe_id'] # noqa: E501 path_params['frontendId'] = params['frontend_id'] # noqa: E501
query_params = [] query_params = []
@ -559,7 +559,7 @@ class MetadataApi(object):
auth_settings = ['key'] # noqa: E501 auth_settings = ['key'] # noqa: E501
return self.api_client.call_api( return self.api_client.call_api(
'/detail/frontend/{feId}', 'GET', '/detail/frontend/{frontendId}', 'GET',
path_params, path_params,
query_params, query_params,
header_params, header_params,

10
specs/zrok.yml
View File

@ -35,7 +35,7 @@ paths:
type: string type: string
responses: responses:
200: 200:
description: changed password description: password changed
400: 400:
description: password not changed description: password not changed
401: 401:
@ -191,9 +191,9 @@ paths:
type: string type: string
responses: responses:
201: 201:
description: forgot password request created description: reset password request created
400: 400:
description: forgot password request not created description: reset password request not created
500: 500:
description: internal server error description: internal server error
@ -723,7 +723,7 @@ paths:
500: 500:
description: internal server error description: internal server error
/detail/frontend/{feId}: /detail/frontend/{frontendId}:
get: get:
tags: tags:
- metadata - metadata
@ -731,7 +731,7 @@ paths:
- key: [] - key: []
operationId: getFrontendDetail operationId: getFrontendDetail
parameters: parameters:
- name: feId - name: frontendId
in: path in: path
type: integer type: integer
required: true required: true

10
ui/src/api/apis/MetadataApi.ts
View File

@ -66,7 +66,7 @@ export interface GetEnvironmentMetricsRequest {
} }
export interface GetFrontendDetailRequest { export interface GetFrontendDetailRequest {
feId: number; frontendId: number;
} }
export interface GetShareDetailRequest { export interface GetShareDetailRequest {
@ -257,10 +257,10 @@ export class MetadataApi extends runtime.BaseAPI {
/** /**
*/ */
async getFrontendDetailRaw(requestParameters: GetFrontendDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Frontend>> { async getFrontendDetailRaw(requestParameters: GetFrontendDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Frontend>> {
if (requestParameters['feId'] == null) { if (requestParameters['frontendId'] == null) {
throw new runtime.RequiredError( throw new runtime.RequiredError(
'feId', 'frontendId',
'Required parameter "feId" was null or undefined when calling getFrontendDetail().' 'Required parameter "frontendId" was null or undefined when calling getFrontendDetail().'
); );
} }
@ -273,7 +273,7 @@ export class MetadataApi extends runtime.BaseAPI {
} }
const response = await this.request({ const response = await this.request({
path: `/detail/frontend/{feId}`.replace(`{${"feId"}}`, encodeURIComponent(String(requestParameters['feId']))), path: `/detail/frontend/{frontendId}`.replace(`{${"frontendId"}}`, encodeURIComponent(String(requestParameters['frontendId']))),
method: 'GET', method: 'GET',
headers: headerParameters, headers: headerParameters,
query: queryParameters, query: queryParameters,