Merge pull request #106 from symphonyoss/specs-update-20.12.0

Jenkins Swagger specifications update 20.12.0
finos · Apr 12, 2021 · c77caf5 · c77caf5
2 parents 61a906e + bb9c265
commit c77caf5
Show file tree

Hide file tree

Showing 8 changed files with 1,755 additions and 1,844 deletions.
diff --git a/agent/agent-api-public-deprecated.yaml b/agent/agent-api-public-deprecated.yaml
diff --git a/agent/agent-api-public.yaml b/agent/agent-api-public.yaml
diff --git a/authenticator/authenticator-api-public-deprecated.yaml b/authenticator/authenticator-api-public-deprecated.yaml
@@ -1,6 +1,6 @@
 swagger: '2.0'
 info:
-  version: '20.10.0'
+  version: '20.12.1'
   title: Authenticator API
   description: |
     For bots and other on-premise processes to authenticate. Once
@@ -175,44 +175,44 @@ paths:
           schema:
             $ref: '#/definitions/Error'
   '/v1/app/username/{username}/authenticate':
-    post:
-      summary: PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
-      parameters:
-        - name: username
-          description: username
-          in: path
-          required: true
-          type: string
-        - name: sessionToken
-          description: Authorization token obtains from app/authenicate API
-          in: header
-          required: true
-          type: string
-      produces:
-        - application/json
-      tags:
-        - CertificateAuthentication
-      responses:
-        '200':
-          description: OK.
-          schema:
-            $ref: '#/definitions/OboAuthResponse'
-        '400':
-          description: 'Client error.'
-          schema:
-            $ref: '#/definitions/Error'
-        '403':
-          description: 'Forbidden: Certificate authentication is not allowed for the requested user.'
-          schema:
-            $ref: '#/definitions/Error'
-        '404':
-          description: 'Username not found'
-          schema:
-            $ref: '#/definitions/Error'
-        '500':
-          description: 'Server error, see response body for further details.'
-          schema:
-            $ref: '#/definitions/Error'
+      post:
+        summary: PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
+        parameters:
+          - name: username
+            description: username
+            in: path
+            required: true
+            type: string
+          - name: sessionToken
+            description: Authorization token obtains from app/authenicate API
+            in: header
+            required: true
+            type: string
+        produces:
+          - application/json
+        tags:
+          - CertificateAuthentication
+        responses:
+          '200':
+            description: OK.
+            schema:
+              $ref: '#/definitions/OboAuthResponse'
+          '400':
+            description: 'Client error.'
+            schema:
+              $ref: '#/definitions/Error'
+          '403':
+            description: 'Forbidden: Certificate authentication is not allowed for the requested user.'
+            schema:
+              $ref: '#/definitions/Error'
+          '404':
+            description: 'Username not found'
+            schema:
+              $ref: '#/definitions/Error'
+          '500':
+            description: 'Server error, see response body for further details.'
+            schema:
+              $ref: '#/definitions/Error'
   '/v1/logout':
     post:
       summary: Logout.
@@ -245,11 +245,11 @@ paths:
           description: 'Server error, see response body for further details.'
           schema:
             $ref: '#/definitions/Error'
-
+
 #
 # Deprecated paths
 #
-
+
 definitions:
   Error:
     type: object
@@ -274,12 +274,12 @@ definitions:
           the client. It is not intended to conatain any data interpretable by the
           client. The format is secret and subject to change without notice.
   ExtensionAppAuthenticateRequest:
-    type: object
-    description: Request body for extension app authentication
-    properties:
-      appToken:
-        type: string
-        description: application generated token
+      type: object
+      description: Request body for extension app authentication
+      properties:
+        appToken:
+          type: string
+          description: application generated token
   ExtensionAppTokens:
     type: object
     properties:
@@ -313,8 +313,8 @@ definitions:
       certificate:
         description: Certificate in PEM format
         type: string
-
+
 #
 # Deprecated definitions
 #
-
+
diff --git a/authenticator/authenticator-api-public.yaml b/authenticator/authenticator-api-public.yaml
@@ -1,6 +1,6 @@
 swagger: '2.0'
 info:
-  version: '20.10.0'
+  version: '20.12.1'
   title: Authenticator API
   description: |
     For bots and other on-premise processes to authenticate. Once
@@ -175,44 +175,44 @@ paths:
           schema:
             $ref: '#/definitions/Error'
   '/v1/app/username/{username}/authenticate':
-    post:
-      summary: PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
-      parameters:
-        - name: username
-          description: username
-          in: path
-          required: true
-          type: string
-        - name: sessionToken
-          description: Authorization token obtains from app/authenicate API
-          in: header
-          required: true
-          type: string
-      produces:
-        - application/json
-      tags:
-        - CertificateAuthentication
-      responses:
-        '200':
-          description: OK.
-          schema:
-            $ref: '#/definitions/OboAuthResponse'
-        '400':
-          description: 'Client error.'
-          schema:
-            $ref: '#/definitions/Error'
-        '403':
-          description: 'Forbidden: Certificate authentication is not allowed for the requested user.'
-          schema:
-            $ref: '#/definitions/Error'
-        '404':
-          description: 'Username not found'
-          schema:
-            $ref: '#/definitions/Error'
-        '500':
-          description: 'Server error, see response body for further details.'
-          schema:
-            $ref: '#/definitions/Error'
+      post:
+        summary: PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
+        parameters:
+          - name: username
+            description: username
+            in: path
+            required: true
+            type: string
+          - name: sessionToken
+            description: Authorization token obtains from app/authenicate API
+            in: header
+            required: true
+            type: string
+        produces:
+          - application/json
+        tags:
+          - CertificateAuthentication
+        responses:
+          '200':
+            description: OK.
+            schema:
+              $ref: '#/definitions/OboAuthResponse'
+          '400':
+            description: 'Client error.'
+            schema:
+              $ref: '#/definitions/Error'
+          '403':
+            description: 'Forbidden: Certificate authentication is not allowed for the requested user.'
+            schema:
+              $ref: '#/definitions/Error'
+          '404':
+            description: 'Username not found'
+            schema:
+              $ref: '#/definitions/Error'
+          '500':
+            description: 'Server error, see response body for further details.'
+            schema:
+              $ref: '#/definitions/Error'
   '/v1/logout':
     post:
       summary: Logout.
@@ -245,7 +245,7 @@ paths:
           description: 'Server error, see response body for further details.'
           schema:
             $ref: '#/definitions/Error'
-
+
 definitions:
   Error:
     type: object
@@ -270,12 +270,12 @@ definitions:
           the client. It is not intended to conatain any data interpretable by the
           client. The format is secret and subject to change without notice.
   ExtensionAppAuthenticateRequest:
-    type: object
-    description: Request body for extension app authentication
-    properties:
-      appToken:
-        type: string
-        description: application generated token
+      type: object
+      description: Request body for extension app authentication
+      properties:
+        appToken:
+          type: string
+          description: application generated token
   ExtensionAppTokens:
     type: object
     properties:
@@ -309,4 +309,4 @@ definitions:
       certificate:
         description: Certificate in PEM format
         type: string
-
+
diff --git a/login/login-api-public.yaml b/login/login-api-public.yaml
@@ -1,6 +1,6 @@
 swagger: '2.0'
 info:
-  version: '20.10.0'
+  version: '20.12.1'
   title: Login API
   description: |
     For bots and other on-premise processes to authenticate. Once
@@ -83,7 +83,7 @@ paths:
         '400':
           description: 'Request object is invalid'
           schema:
-            $ref: '#/definitions/Error'
+            $ref: '#/definitions/Error'            
         '401':
           description: 'Client is unauthorized to access this resource'
           schema:
@@ -204,7 +204,7 @@ paths:
         '500':
           description: 'Server error, see response body for further details.'
           schema:
-            $ref: '#/definitions/Error'
+            $ref: '#/definitions/Error'
 definitions:
   Error:
     type: object
@@ -229,38 +229,38 @@ definitions:
           the client. It is not intended to contain any data interpretable by the
           client. The format is secret and subject to change without notice.
   AuthenticateRequest:
-    type: object
-    description: Request body for pubkey authentication
-    properties:
-      token:
-        type: string
-        description: a JWT containing the caller's username or application appGroupId and an expiration date, signed by the caller's private key.
+      type: object
+      description: Request body for pubkey authentication
+      properties:
+        token:
+          type: string
+          description: a JWT containing the caller's username or application appGroupId and an expiration date, signed by the caller's private key.
   AuthenticateExtensionAppRequest:
-    type: object
-    description: Request body for extension app authentication
-    properties:
-      appToken:
-        type: string
-        description: application generated token
-      authToken:
-        type: string
-        description: a JWT containing the caller's username and an expiration date, signed by the caller's private key.
+      type: object
+      description: Request body for extension app authentication
+      properties:
+        appToken:
+          type: string
+          description: application generated token
+        authToken:
+          type: string
+          description: a JWT containing the caller's username and an expiration date, signed by the caller's private key.   
   ExtensionAppTokens:
-    type: object
-    properties:
-      appId:
-        description: Application ID
-        type: string
-      appToken:
-        description: |
-          This token generated by the application when calling authentication endpoint
-        type: string
-      symphonyToken:
-        type: string
-        description: |
-          This token generated by Symphony and should be used by the application to verify that it's talking to Symphony.
-      expireAt:
-        type: integer
-        format: int64
-        description: unix timestamp when the token expired
-
+      type: object
+      properties:
+        appId:
+          description: Application ID
+          type: string
+        appToken:
+          description: |
+            This token generated by the application when calling authentication endpoint
+          type: string
+        symphonyToken:
+          type: string
+          description: |
+            This token generated by Symphony and should be used by the application to verify that it's talking to Symphony.
+        expireAt:
+          type: integer
+          format: int64
+          description: unix timestamp when the token expired
+