vgs_api_client 0.0.1.alpha202205200945 → 0.0.1.alpha202205202346

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4147aaef863022f5ca5a652fd16c6970f8c97768da846d86fb81cf7340acdb4c
-  data.tar.gz: 5046ec2e5494651b9cc1a4c3c323e4429ca92c6462f37dc13d5444d1f06cb640
+  metadata.gz: 8e6d83fe6298887d7e460c976ae4893f62c879659b93d849196a27183411347b
+  data.tar.gz: a920f5df37f5b382968d59837983e4159446188fcff6e847a89c64ebd541fa71
 SHA512:
-  metadata.gz: 8c1f05a85362eeeb353a2ff3fdd7237dcba3b49cd90280ca5f1174732b7a20c38bdbc1298707563ae7b30154c9fa99a67d2016f54c7d550b96770e9a1eda8da5
-  data.tar.gz: f9826867fdde6a15342fad4c23374c616b9a3ee0bc91146f9cba0e447d15665c0aa80e1269bf2806f10746cf9bd752be1c4801c9169a806f544d983ebbca2705
+  metadata.gz: 8c8c2bd408a0f7f6aec0ea52ed31cdd4779c2998b9ffed6296e87600817687332c25778e931ca6c1225d94e6ece9defcd9a24713418fcdf9833b2d816200992d
+  data.tar.gz: ad3525b0f3c50c2933c0632c65153f9e6e582caab34c24355f4bbf2266539f973ce9bacc929baee1948f6705ceb532e8667b5969ebe5be48fde01ef219dbc1ef

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha202205200945
+0.0.1.alpha202205202346

data/api.yaml

@@ -80,13 +80,14 @@ info:
   contact:
     email: support@verygoodsecurity.com
   x-logo:
-    url: images/vgs-logo.png
+    url: https://www.verygoodsecurity.com/img/press-and-assets/vgs-logo-color.png
     href: https://www.verygoodsecurity.com
     altText: VGS Logo
+  termsOfService: https://www.verygoodsecurity.com/terms-and-conditions
 
 externalDocs:
-  description: Find out more about VGS
-  url: https://www.verygoodsecurity.com/
+  description: Visit the VGS documentation homepage
+  url: https://www.verygoodsecurity.com/docs/
 
 servers:
   - url: https://api.sandbox.verygoodvault.com
@@ -111,9 +112,177 @@ x-tagGroups:
       - aliases
 
 security:
-  - basicAuth: []
+  - BasicAuth: []
 
 paths:
+  /functions:
+    post:
+      operationId: createFunction
+      summary: Creates a new function
+      tags:
+        - functions
+      description: |
+        Creates a new function.
+      requestBody:
+        content:
+          application/json:
+            schema: 
+              $ref: '#/components/schemas/CreateFunctionRequest'
+            examples:
+              A:
+                summary: Create a new function
+                value:
+                  data:
+                    - src: |
+                        def process(input, ctx):
+                          return input
+                      lang: larky
+                      name: my-function
+      responses:
+        '201':
+          description: Created
+          content: 
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: A retrieved function.
+                    minItems: 1
+                    maxItems: 20
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+    get:
+      operationId: listFunctions
+      summary: Lists all functions
+      tags:
+        - functions
+      description: |
+        Lists all functions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: A retrieved function.
+                    minItems: 1
+                    maxItems: 20
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+  /functions/{functionName}:
+    parameters:
+      - $ref: '#/components/parameters/functionName'
+    get:
+      operationId: getFunction
+      tags:
+        - functions
+      summary: Retrieve a single function
+      description: |
+        Retrieves a function
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: The retrieved function.
+                    minItems: 1
+                    maxItems: 1
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+    put:
+      operationId: updateFunction
+      tags:
+        - functions
+      summary: Update function
+      description: |
+        Update an existing function definition
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateFunctionRequestPayload'
+      responses:
+        '200':
+          description: No Content
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+    delete:
+      operationId: deleteFunction
+      tags:
+        - functions
+      summary: Deletes a function
+      description: |
+        Removes a single alias.
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      responses:
+        '204':
+          description: No Content
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+  /functions/{functionName}/invocations:
+    parameters:
+      - $ref: '#/components/parameters/functionName'
+    post:
+      operationId: invokeFunction
+      tags:
+        - functions
+      summary: Invoke a function
+      description: |
+        Invokes a function
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      requestBody:
+        content:
+          "text/plain":
+            schema:
+              type: string
+              format: byte
+              example:
+                aGVsbG8gd29ybGQK
+          "*":
+            schema:
+              type: string
+              format: binary?
+      responses:
+        '200':
+          description: OK
+          content:
+            "text/plain":
+              schema:
+                type: string
+              example:
+                aGVsbG8gd29ybGQK
+            "*":
+              schema:
+                type: string
+                format: binary
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
   /aliases:
     post:
       operationId: createAliases
@@ -345,16 +514,41 @@ paths:
              -X DELETE \
              -u "$USERNAME:$PASSWORD"
 
-
 components:
 
   # See the following links for details:
   # - https://swagger.io/docs/specification/authentication/basic-authentication/
+  # https://swagger.io/docs/specification/authentication/
   securitySchemes:
-    basicAuth:
+    BasicAuth:
       type: http
       scheme: basic
-      description: The default authentication schema.
+      description: |
+        The default authentication scheme for [Data API](#data-apis) based requests
+        is [Basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
+    OAuth2:
+      type: oauth2
+      flows:
+        authorizationCode:
+          authorizationUrl: https://auth.verygoodsecurity.com/auth/realms/vgs/protocol/openid-connect/auth
+          tokenUrl: https://auth.verygoodsecurity.io/auth/realms/vgs/protocol/openid-connect/token
+          scopes:
+            credentials:read: Read vault credentials without reading secrets
+            credentials:write: Add, delete and manage credentials of vault
+            routes:read: Read your vault routes
+            routes:write: Create, read, update, delete your vault routes
+            vaults:read: Read details of your vaults
+            vaults:write: Read, create, update and delete your vaults
+            upstreams:read: Read your upstreams for SFTP routes
+            upstreams:write: Create and update upstreams for SFTP routes
+            certificates:read: Read certificates setup for your routes
+            certificates:write: Upload and delete certificates for routes
+            hostnames:read: Read/List Custom Hostnames of your vault routes
+            hostnames:write: Create/Delete Custom Hostname of your vault routes
+            functions:read: Read/List Functions
+            functions:write: Create/Delete Functions
+      description: |
+        The default authentication schema for [Management API](#management-apis) based requests.
 
   parameters:
     alias:
@@ -365,6 +559,15 @@ components:
       schema:
         type: string
         example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
+        
+    functionName:
+      name: functionName
+      in: path
+      required: true
+      description: Name of function to operate on
+      schema:
+        type: string
+        example: my-function-46Juzcyx
 
   responses:
     ApiErrorsResponse:
@@ -532,3 +735,69 @@ components:
             - classifiers
       required:
         - data
+
+    CreateFunctionRequest:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            oneOf:
+              - $ref: '#/components/schemas/CreateFunctionRequestPayload'
+          minItems: 1
+          maxItems: 20
+      required:
+        - data
+
+    CreateFunctionRequestPayload:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Prefix to name your function
+          pattern: "[a-zA-Z]+([A-Za-z0-9\\-_]){5,28}[a-zA-Z0-9]"
+          example: my-function
+        src:
+          type: string
+          description: Definition of function body
+          example: |
+            def process(input, ctx):
+              return input
+        lang:
+          type: string
+          enum:
+            - larky
+          default: larky
+          description: |
+            Language to write your function in.
+      required:
+        - name
+        - src
+        
+    Function:
+      type: object
+      properties:
+        name:
+          type: string
+          example: my-function-46Juzcyx
+        src:
+          type: string
+          description: Definition of function body
+          example: |
+            def process(input, ctx):
+              return input
+        lang:
+          type: string
+          enum:
+            - larky
+          default: larky
+          description: |
+            Language to write your function in.
+        hash:
+          type: string
+          description: SHA256 representation of the function definition
+          example: bc1f0c3322091740cead407000af9acc692e7fefd0d96446e07900dcd0f8e308
+      required:
+        - value
+        - format
+        

data/lib/openapi_client/api/aliases_api.rb

@@ -64,7 +64,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse201'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.create_aliases",
@@ -127,7 +127,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.delete_alias",
@@ -190,7 +190,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse2001'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.reveal_alias",
@@ -254,7 +254,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse200'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.reveal_multiple_aliases",
@@ -324,7 +324,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.update_alias",