docs(serverless): enrich the token part (#99)

Author: scaleway-bot

packages/clients/src/api/container/v1beta1/api.gen.ts

@@ -691,6 +691,12 @@ export class ContainerV1Beta1GenAPI extends API {
       unmarshalToken,
     )
 
+  /**
+   * Create a new revocable token
+   *
+   * @param request - The request {@link CreateTokenRequest}
+   * @returns A Promise of Token
+   */
   createToken = (request: Readonly<CreateTokenRequest> = {}) =>
     this.client.fetch<Token>(
       {
@@ -707,6 +713,12 @@ export class ContainerV1Beta1GenAPI extends API {
       unmarshalToken,
     )
 
+  /**
+   * Get a token
+   *
+   * @param request - The request {@link GetTokenRequest}
+   * @returns A Promise of Token
+   */
   getToken = (request: Readonly<GetTokenRequest>) =>
     this.client.fetch<Token>(
       {
@@ -761,9 +773,21 @@ export class ContainerV1Beta1GenAPI extends API {
       unmarshalListTokensResponse,
     )
 
+  /**
+   * List all tokens
+   *
+   * @param request - The request {@link ListTokensRequest}
+   * @returns A Promise of ListTokensResponse
+   */
   listTokens = (request: Readonly<ListTokensRequest> = {}) =>
     enrichForPagination('tokens', this.pageOfListTokens, request)
 
+  /**
+   * Delete a token
+   *
+   * @param request - The request {@link DeleteTokenRequest}
+   * @returns A Promise of Token
+   */
   deleteToken = (request: Readonly<DeleteTokenRequest>) =>
     this.client.fetch<Token>(
       {

packages/clients/src/api/container/v1beta1/types.gen.ts

@@ -202,18 +202,19 @@ export interface SecretHashedValue {
   hashedValue: string
 }
 
+/** Token */
 export interface Token {
+  id: string
   token: string
-  /** @deprecated */
-  publicKey?: string
   /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
   containerId?: string
   /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
   namespaceId?: string
-  id: string
+  /** @deprecated */
+  publicKey?: string
   status: TokenStatus
-  expiresAt?: Date
   description?: string
+  expiresAt?: Date
 }
 
 export type ListNamespacesRequest = {
@@ -434,8 +435,8 @@ export type CreateTokenRequest = {
   containerId?: string
   /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
   namespaceId?: string
-  expiresAt?: Date
   description?: string
+  expiresAt?: Date
 }
 
 export type GetTokenRequest = {

packages/clients/src/api/function/v1beta1/api.gen.ts

@@ -763,6 +763,12 @@ export class FunctionV1Beta1GenAPI extends API {
       unmarshalToken,
     )
 
+  /**
+   * Create a new revocable token
+   *
+   * @param request - The request {@link CreateTokenRequest}
+   * @returns A Promise of Token
+   */
   createToken = (request: Readonly<CreateTokenRequest> = {}) =>
     this.client.fetch<Token>(
       {
@@ -779,6 +785,12 @@ export class FunctionV1Beta1GenAPI extends API {
       unmarshalToken,
     )
 
+  /**
+   * Get a token
+   *
+   * @param request - The request {@link GetTokenRequest}
+   * @returns A Promise of Token
+   */
   getToken = (request: Readonly<GetTokenRequest>) =>
     this.client.fetch<Token>(
       {
@@ -833,9 +845,21 @@ export class FunctionV1Beta1GenAPI extends API {
       unmarshalListTokensResponse,
     )
 
+  /**
+   * List all tokens
+   *
+   * @param request - The request {@link ListTokensRequest}
+   * @returns A Promise of ListTokensResponse
+   */
   listTokens = (request: Readonly<ListTokensRequest> = {}) =>
     enrichForPagination('tokens', this.pageOfListTokens, request)
 
+  /**
+   * Delete a token
+   *
+   * @param request - The request {@link DeleteTokenRequest}
+   * @returns A Promise of Token
+   */
   deleteToken = (request: Readonly<DeleteTokenRequest>) =>
     this.client.fetch<Token>(
       {

packages/clients/src/api/function/v1beta1/types.gen.ts

@@ -249,18 +249,19 @@ export interface SecretHashedValue {
   hashedValue: string
 }
 
+/** Token */
 export interface Token {
+  id: string
   token: string
-  /** @deprecated */
-  publicKey?: string
   /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
   functionId?: string
   /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
   namespaceId?: string
-  id: string
+  /** @deprecated */
+  publicKey?: string
   status: TokenStatus
-  expiresAt?: Date
   description?: string
+  expiresAt?: Date
 }
 
 /** Upload url */
@@ -501,8 +502,8 @@ export type CreateTokenRequest = {
   functionId?: string
   /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
   namespaceId?: string
-  expiresAt?: Date
   description?: string
+  expiresAt?: Date
 }
 
 export type GetTokenRequest = {