From c9c60b4dd1d0c4058080f9dcc24987b285a9ee0d Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Tue, 4 Feb 2025 17:07:28 -0500 Subject: [PATCH] description for access request (frontend) (#834) --- rest_client_zrok/share/access_responses.go | 3 ++ rest_model_zrok/frontend.go | 3 ++ rest_server_zrok/embedded_spec.go | 12 +++++++ rest_server_zrok/operations/share/access.go | 3 ++ .../sdk/src/zrok/api/model/accessRequest.ts | 6 ++++ sdk/nodejs/sdk/src/zrok/api/model/frontend.ts | 6 ++++ sdk/python/sdk/zrok/docs/AccessBody.md | 1 + sdk/python/sdk/zrok/docs/Frontend.md | 1 + .../sdk/zrok/zrok_api/models/access_body.py | 32 +++++++++++++++++-- .../sdk/zrok/zrok_api/models/frontend.py | 28 +++++++++++++++- specs/zrok.yml | 4 +++ ui/src/api/models/AccessRequest.ts | 8 +++++ ui/src/api/models/Frontend.ts | 8 +++++ 13 files changed, 111 insertions(+), 4 deletions(-) diff --git a/rest_client_zrok/share/access_responses.go b/rest_client_zrok/share/access_responses.go index f12c6189..91d6c8dc 100644 --- a/rest_client_zrok/share/access_responses.go +++ b/rest_client_zrok/share/access_responses.go @@ -294,6 +294,9 @@ swagger:model AccessBody */ type AccessBody struct { + // description + Description string `json:"description,omitempty"` + // env z Id EnvZID string `json:"envZId,omitempty"` diff --git a/rest_model_zrok/frontend.go b/rest_model_zrok/frontend.go index 9dc845de..71c8e2e2 100644 --- a/rest_model_zrok/frontend.go +++ b/rest_model_zrok/frontend.go @@ -20,6 +20,9 @@ type Frontend struct { // created at CreatedAt int64 `json:"createdAt,omitempty"` + // description + Description string `json:"description,omitempty"` + // fe token FeToken string `json:"feToken,omitempty"` diff --git a/rest_server_zrok/embedded_spec.go b/rest_server_zrok/embedded_spec.go index a122e537..6f7c916a 100644 --- a/rest_server_zrok/embedded_spec.go +++ b/rest_server_zrok/embedded_spec.go @@ -52,6 +52,9 @@ func init() { "in": "body", "schema": { "properties": { + "description": { + "type": "string" + }, "envZId": { "type": "string" }, @@ -1952,6 +1955,9 @@ func init() { "createdAt": { "type": "integer" }, + "description": { + "type": "string" + }, "feToken": { "type": "string" }, @@ -2249,6 +2255,9 @@ func init() { "in": "body", "schema": { "properties": { + "description": { + "type": "string" + }, "envZId": { "type": "string" }, @@ -4154,6 +4163,9 @@ func init() { "createdAt": { "type": "integer" }, + "description": { + "type": "string" + }, "feToken": { "type": "string" }, diff --git a/rest_server_zrok/operations/share/access.go b/rest_server_zrok/operations/share/access.go index be5e343d..68e7f008 100644 --- a/rest_server_zrok/operations/share/access.go +++ b/rest_server_zrok/operations/share/access.go @@ -78,6 +78,9 @@ func (o *Access) ServeHTTP(rw http.ResponseWriter, r *http.Request) { // swagger:model AccessBody type AccessBody struct { + // description + Description string `json:"description,omitempty"` + // env z Id EnvZID string `json:"envZId,omitempty"` diff --git a/sdk/nodejs/sdk/src/zrok/api/model/accessRequest.ts b/sdk/nodejs/sdk/src/zrok/api/model/accessRequest.ts index efa820b6..b02a5466 100644 --- a/sdk/nodejs/sdk/src/zrok/api/model/accessRequest.ts +++ b/sdk/nodejs/sdk/src/zrok/api/model/accessRequest.ts @@ -15,6 +15,7 @@ import { RequestFile } from './models'; export class AccessRequest { 'envZId'?: string; 'shareToken'?: string; + 'description'?: string; static discriminator: string | undefined = undefined; @@ -28,6 +29,11 @@ export class AccessRequest { "name": "shareToken", "baseName": "shareToken", "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" } ]; static getAttributeTypeMap() { diff --git a/sdk/nodejs/sdk/src/zrok/api/model/frontend.ts b/sdk/nodejs/sdk/src/zrok/api/model/frontend.ts index f3a09442..dbae7ead 100644 --- a/sdk/nodejs/sdk/src/zrok/api/model/frontend.ts +++ b/sdk/nodejs/sdk/src/zrok/api/model/frontend.ts @@ -16,6 +16,7 @@ export class Frontend { 'id'?: number; 'feToken'?: string; 'shareToken'?: string; + 'description'?: string; 'zId'?: string; 'createdAt'?: number; 'updatedAt'?: number; @@ -38,6 +39,11 @@ export class Frontend { "baseName": "shareToken", "type": "string" }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, { "name": "zId", "baseName": "zId", diff --git a/sdk/python/sdk/zrok/docs/AccessBody.md b/sdk/python/sdk/zrok/docs/AccessBody.md index d5546bf3..8b42a3ff 100644 --- a/sdk/python/sdk/zrok/docs/AccessBody.md +++ b/sdk/python/sdk/zrok/docs/AccessBody.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **env_zid** | **str** | | [optional] **share_token** | **str** | | [optional] +**description** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdk/python/sdk/zrok/docs/Frontend.md b/sdk/python/sdk/zrok/docs/Frontend.md index fb3f9754..79aa0d65 100644 --- a/sdk/python/sdk/zrok/docs/Frontend.md +++ b/sdk/python/sdk/zrok/docs/Frontend.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **id** | **int** | | [optional] **fe_token** | **str** | | [optional] **share_token** | **str** | | [optional] +**description** | **str** | | [optional] **z_id** | **str** | | [optional] **created_at** | **int** | | [optional] **updated_at** | **int** | | [optional] diff --git a/sdk/python/sdk/zrok/zrok_api/models/access_body.py b/sdk/python/sdk/zrok/zrok_api/models/access_body.py index 3c213723..ba3b148f 100644 --- a/sdk/python/sdk/zrok/zrok_api/models/access_body.py +++ b/sdk/python/sdk/zrok/zrok_api/models/access_body.py @@ -29,23 +29,28 @@ class AccessBody(object): """ swagger_types = { 'env_zid': 'str', - 'share_token': 'str' + 'share_token': 'str', + 'description': 'str' } attribute_map = { 'env_zid': 'envZId', - 'share_token': 'shareToken' + 'share_token': 'shareToken', + 'description': 'description' } - def __init__(self, env_zid=None, share_token=None): # noqa: E501 + def __init__(self, env_zid=None, share_token=None, description=None): # noqa: E501 """AccessBody - a model defined in Swagger""" # noqa: E501 self._env_zid = None self._share_token = None + self._description = None self.discriminator = None if env_zid is not None: self.env_zid = env_zid if share_token is not None: self.share_token = share_token + if description is not None: + self.description = description @property def env_zid(self): @@ -89,6 +94,27 @@ class AccessBody(object): self._share_token = share_token + @property + def description(self): + """Gets the description of this AccessBody. # noqa: E501 + + + :return: The description of this AccessBody. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this AccessBody. + + + :param description: The description of this AccessBody. # noqa: E501 + :type: str + """ + + self._description = description + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sdk/python/sdk/zrok/zrok_api/models/frontend.py b/sdk/python/sdk/zrok/zrok_api/models/frontend.py index 0a1bd429..289f9acc 100644 --- a/sdk/python/sdk/zrok/zrok_api/models/frontend.py +++ b/sdk/python/sdk/zrok/zrok_api/models/frontend.py @@ -31,6 +31,7 @@ class Frontend(object): 'id': 'int', 'fe_token': 'str', 'share_token': 'str', + 'description': 'str', 'z_id': 'str', 'created_at': 'int', 'updated_at': 'int' @@ -40,16 +41,18 @@ class Frontend(object): 'id': 'id', 'fe_token': 'feToken', 'share_token': 'shareToken', + 'description': 'description', 'z_id': 'zId', 'created_at': 'createdAt', 'updated_at': 'updatedAt' } - def __init__(self, id=None, fe_token=None, share_token=None, z_id=None, created_at=None, updated_at=None): # noqa: E501 + def __init__(self, id=None, fe_token=None, share_token=None, description=None, z_id=None, created_at=None, updated_at=None): # noqa: E501 """Frontend - a model defined in Swagger""" # noqa: E501 self._id = None self._fe_token = None self._share_token = None + self._description = None self._z_id = None self._created_at = None self._updated_at = None @@ -60,6 +63,8 @@ class Frontend(object): self.fe_token = fe_token if share_token is not None: self.share_token = share_token + if description is not None: + self.description = description if z_id is not None: self.z_id = z_id if created_at is not None: @@ -130,6 +135,27 @@ class Frontend(object): self._share_token = share_token + @property + def description(self): + """Gets the description of this Frontend. # noqa: E501 + + + :return: The description of this Frontend. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this Frontend. + + + :param description: The description of this Frontend. # noqa: E501 + :type: str + """ + + self._description = description + @property def z_id(self): """Gets the z_id of this Frontend. # noqa: E501 diff --git a/specs/zrok.yml b/specs/zrok.yml index f3b4192e..9891919e 100644 --- a/specs/zrok.yml +++ b/specs/zrok.yml @@ -1011,6 +1011,8 @@ paths: type: string shareToken: type: string + description: + type: string responses: 201: description: access created @@ -1219,6 +1221,8 @@ definitions: type: string shareToken: type: string + description: + type: string zId: type: string createdAt: diff --git a/ui/src/api/models/AccessRequest.ts b/ui/src/api/models/AccessRequest.ts index 73a0cce7..22e11a1f 100644 --- a/ui/src/api/models/AccessRequest.ts +++ b/ui/src/api/models/AccessRequest.ts @@ -31,6 +31,12 @@ export interface AccessRequest { * @memberof AccessRequest */ shareToken?: string; + /** + * + * @type {string} + * @memberof AccessRequest + */ + description?: string; } /** @@ -52,6 +58,7 @@ export function AccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boole 'envZId': json['envZId'] == null ? undefined : json['envZId'], 'shareToken': json['shareToken'] == null ? undefined : json['shareToken'], + 'description': json['description'] == null ? undefined : json['description'], }; } @@ -63,6 +70,7 @@ export function AccessRequestToJSON(value?: AccessRequest | null): any { 'envZId': value['envZId'], 'shareToken': value['shareToken'], + 'description': value['description'], }; } diff --git a/ui/src/api/models/Frontend.ts b/ui/src/api/models/Frontend.ts index c6e4c3a0..5509b51d 100644 --- a/ui/src/api/models/Frontend.ts +++ b/ui/src/api/models/Frontend.ts @@ -37,6 +37,12 @@ export interface Frontend { * @memberof Frontend */ shareToken?: string; + /** + * + * @type {string} + * @memberof Frontend + */ + description?: string; /** * * @type {string} @@ -77,6 +83,7 @@ export function FrontendFromJSONTyped(json: any, ignoreDiscriminator: boolean): 'id': json['id'] == null ? undefined : json['id'], 'feToken': json['feToken'] == null ? undefined : json['feToken'], 'shareToken': json['shareToken'] == null ? undefined : json['shareToken'], + 'description': json['description'] == null ? undefined : json['description'], 'zId': json['zId'] == null ? undefined : json['zId'], 'createdAt': json['createdAt'] == null ? undefined : json['createdAt'], 'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'], @@ -92,6 +99,7 @@ export function FrontendToJSON(value?: Frontend | null): any { 'id': value['id'], 'feToken': value['feToken'], 'shareToken': value['shareToken'], + 'description': value['description'], 'zId': value['zId'], 'createdAt': value['createdAt'], 'updatedAt': value['updatedAt'],