vgs_api_client 0.0.1.alpha202205200950 → 0.0.1.alpha202205210037

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c8b746c3f1c04d4410df24893e94efd6b69e3c90cc63ba5f2d202b9a486a5a5
-  data.tar.gz: 7500803b62c824b7220d17b964547b532b0e8e75de82baf742ee1eb8b8121bdd
+  metadata.gz: 4a214dfab7ad3680888ed40e5368a9f3cbb4d0a135b2231cb2c077e2d9473c1c
+  data.tar.gz: f54f72e6a21d85323a6d59f7e2b10ee52ccf5658f9e1917089f210eb7ece279c
 SHA512:
-  metadata.gz: 304c7608e13af0b744135e30da5c688ada9f169ba0dc510eb8e345d73fdcfd852f001e8b1d08dd677039d573ab09bac6c56a35faa62dc01fc23c596d1799a507
-  data.tar.gz: e49055b987656d01176d82e2b4e18b6965fdb2df84d19e038d07111165f958522b87a72d93490a5982de477df5a64b02a4ce0b96390febd7ebd8e02805b97114
+  metadata.gz: abfae7fdf60285421e457fffd5320ad13fa43f75eb9ea6c5f5d15fc7d2cb4d5e79311365b40241d2b73a174cd94545b43218fb41f980e3bdfa4b6d887caf9ddd
+  data.tar.gz: 40b9e9eac3ccce0a8d313d9afeeab00ccf25b749e48b79cdcda492aa70845e2f320adbe3a1d2fd6ae4a7e921692221150a29c4dd75985a77a1e0b425ec2ab01b

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha202205200950
+0.0.1.alpha202205210037

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,268 @@ 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
+              description: Stream of bytes base64 encoded up to XX KB in size
+          application/http:
+            schema:
+              type: object
+              properties:
+                method:
+                  type: string
+                  enum: 
+                  - POST
+                  - PATCH
+                  - DELETE
+                  - PUT
+                  - GET
+                  - HEAD
+                uri:
+                  type: string
+                  format: uri
+                  example: https://example.com/software/htp/cics/index.html
+                version: 
+                  type: string
+                  enum: 
+                  - "1.0"
+                  - "1.1"
+                headers:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      key: 
+                        type: string
+                      value:
+                        type: string
+                body:
+                  type: string
+                  format: string
+              
+              description: https://www.iana.org/assignments/media-types/media-types.xhtml
+            examples:
+              A:
+                summary: Invoke a function with a HTTP request payload
+                value:
+                  method: GET
+                  uri: https://example.com/software/htp/cics/index.html
+                  version: 1.0
+
+          "*":
+            schema:
+              type: string
+              format: binary?
+              description: Stream of bytes up to XX KB in size
+      responses:
+        '200':
+          description: OK
+          content:
+            application/http:
+              schema: 
+                type: object
+                properties:
+                  method:
+                    type: string
+                    enum: 
+                    - POST
+                    - PATCH
+                    - DELETE
+                    - PUT
+                    - GET
+                    - HEAD
+                  uri:
+                    type: string
+                    format: uri
+                    example: https://example.com/software/htp/cics/index.html
+                  version: 
+                    type: string
+                    enum: 
+                    - "1.0"
+                    - "1.1"
+                  headers:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        key: 
+                          type: string
+                        value:
+                          type: string
+                  body:
+                    type: string
+                    format: string
+                
+                description: https://www.iana.org/assignments/media-types/media-types.xhtml
+              example:
+                method: POST
+                uri: https://example.com/software/htp/cics/index.html
+                version: 1.0
+                headers:
+                  - key: Content-Type
+                    value: text/plain
+            "text/plain":
+              schema:
+                type: string
+                description: Stream of bytes base64 up to XX KB in size
+              example:
+                aGVsbG8gd29ybGQK
+            "*":
+              schema:
+                type: string
+                format: binary
+                description: Stream of bytes up to XX KB in size
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
   /aliases:
     post:
       operationId: createAliases
@@ -345,16 +605,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 +650,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 +826,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",