!!io.swagger.models.auth.OAuth2Definition\nauthorizationUrl: http://petstore.swagger.io/oauth/dialog\ndescription: null\nflow: implicit\nscopes:\n write:pets: modify pets in your account\n read:pets: read your pets\ntokenUrl: null\ntype: oauth2\nvendorExtensions: {\n }\n"
- },
- {
- "name": "api_key",
- "description": "!!io.swagger.models.auth.ApiKeyAuthDefinition\ndescription: null\nin: HEADER\nname: api_key\ntype: apiKey\nvendorExtensions: {\n }\n"
- }
- ],
- "properties": [
- {
- "name": "Contact Email",
- "key": "Contact Email",
- "value": "apiteam@swagger.io",
- "type": "STRING"
- },
- {
- "name": "External Document Description",
- "key": "External Document Description",
- "value": "Find out more about Swagger",
- "type": "STRING"
- },
- {
- "name": "Terms Of Service",
- "key": "Terms Of Service",
- "value": "http://swagger.io/terms/",
- "type": "STRING"
- },
- {
- "name": "License Name",
- "key": "License Name",
- "value": "Apache 2.0",
- "type": "STRING"
- },
- {
- "name": "External Document Url",
- "key": "External Document Url",
- "value": "http://swagger.io",
- "type": "STRING"
- },
- {
- "name": "License URL",
- "key": "License URL",
- "value": "http://www.apache.org/licenses/LICENSE-2.0.html",
- "type": "STRING"
- }
- ],
- "providerRef": "5390f906-1334-44cd-b251-7087f4d4e6ce",
- "inputContentType": "[]",
- "outputContentType": "[]",
- "components": [
- {
- "schema": [
- {
- "name": "Order",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"petId\":{\"type\":\"integer\",\"format\":\"int64\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\"},\"shipDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"status\":{\"type\":\"string\",\"description\":\"Order Status\",\"enum\":[\"placed\",\"approved\",\"delivered\"]},\"complete\":{\"type\":\"boolean\",\"default\":false}},\"xml\":{\"name\":\"Order\"}}",
- "description": ""
- },
- {
- "name": "Category",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"}},\"xml\":{\"name\":\"Category\"}}",
- "description": ""
- },
- {
- "name": "User",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"username\":{\"type\":\"string\"},\"firstName\":{\"type\":\"string\"},\"lastName\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"phone\":{\"type\":\"string\"},\"userStatus\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"User Status\"}},\"xml\":{\"name\":\"User\"}}",
- "description": ""
- },
- {
- "name": "Tag",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"}},\"xml\":{\"name\":\"Tag\"}}",
- "description": ""
- },
- {
- "name": "Pet",
- "schema": "{\"type\":\"object\",\"required\":[\"name\",\"photoUrls\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"category\":{\"$ref\":\"#/definitions/Category\",\"originalRef\":\"#/definitions/Category\"},\"name\":{\"type\":\"string\",\"example\":\"doggie\"},\"photoUrls\":{\"type\":\"array\",\"xml\":{\"name\":\"photoUrl\",\"wrapped\":true},\"items\":{\"type\":\"string\"}},\"tags\":{\"type\":\"array\",\"xml\":{\"name\":\"tag\",\"wrapped\":true},\"items\":{\"$ref\":\"#/definitions/Tag\",\"originalRef\":\"#/definitions/Tag\"}},\"status\":{\"type\":\"string\",\"description\":\"pet status in the store\",\"enum\":[\"available\",\"pending\",\"sold\"]}},\"xml\":{\"name\":\"Pet\"}}",
- "description": ""
- },
- {
- "name": "ApiResponse",
- "schema": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"type\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"}}}",
- "description": ""
- }
- ]
- }
- ],
- "resourceIds": [
- "bef97b8d-fb7c-4bfc-bcfb-176077c79352"
- ],
- "hybridAPI": false,
- "protected": true,
- "secured": true,
- "summary": "This is a sample server Petstore server.",
- "description": "This is a sample server Petstore server.",
- "externalRefKey": "71a172a4-ac3f-457f-a150-82e704242c0e"
- }
- ],
- "count": 1,
- "_links" : {
- "_self": "rest/v1/apis?page=0"
- }
- }
- '403':
- $ref: '#/components/responses/Forbidden'
- '401':
- $ref: '#/components/responses/Unauthorized'
- post:
- summary: Publish an API to an APIPortal
- description: |-
- Endpoint to publish an API to an API Portal. API can be imported in following ways,
- - Import API using the Swagger/OpeanAPI/RAML/WSDL file
- 
- - Import API using the external URL API Definition
- 
- - Import API using the API Definition
- 
-
- *Endpoint can be accessed only by a user having **Administrator** or **Provider** role*
- requestBody:
- content:
- multipart/formdata:
- schema:
- type: object
- properties:
- name:
- type: string
- description: Name of an API can be provided, this will override the name in API Definition
- example: Pet store
- tenant:
- type: string
- description: Tenant to which the API needs to be published. If the parameter is not provided then based upon user session tenant will be decided.
- example: default
- data:
- type: string
- description: API definition file in binary format
- api-content:
- type: string
- description: API Definition in Swagger/OpenAPI/RAML/WSDL format. This parameter is used for inline API publish
- url:
- type: string
- description: URL of API Definition in Swagger/OpenAPI/RAML/WSDL format
- example: https://petstore.swagger.io/v2/swagger.json
- root-file:
- type: string
- description: If an zip file containing API definitions is been used for publishing then the root file name needs to be provided.
- version:
- type: string
- description: Represent current version of the API
- versionof:
- type: string
- description: Represent Version family of APIs
- examples:
- Publish API using URL:
- value: |-
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ
- Content-Disposition: form-data; name="name"
-
- Pet
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ
- Content-Disposition: form-data; name="url"
-
- https://petstore.swagger.io/v2/swagger.json
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ--
- Publish API using Inline content:
- value: |-
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP
- Content-Disposition: form-data; name="name"
-
- InlineAPI
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP
- Content-Disposition: form-data; name="api-content"
-
- {
- "swagger" : "2.0",
- "info" : {
- "version" : "1.0",
- "title" : "HTTPBin_Format_API"
- },
- "host" : "httpbin.org",
- "basePath" : "/",
- "schemes" : [ "http" ],
- "paths" : {
- "/xml" : {
- "get" : {
- "consumes" : [ ],
- "parameters" : [ ]
- }
- },
- "/json" : {
- "get" : {
- "consumes" : [ ],
- "parameters" : [ ]
- }
- }
- }
- }
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP--
- Publish API using the file:
- value: |-
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="name"
-
- FileImport
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="version"
-
- 1.0
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="data"; filename="HTTPBin_Format_API.json"
- Content-Type: application/json
-
-
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA--
-
- parameters:
- - name: type
- in: query
- description: Type of an API that is being published
- required: true
- allowEmptyValue: false
- schema:
- type: string
- enum:
- - swagger
- - raml
- - wsdl
- - openapi
- - name: async
- in: query
- description: Defines whether the API needs to be published synchronously or asynchronously. By default the API will be published asynchronously.
- required: false
- allowEmptyValue: false
- schema:
- type: boolean
- enum:
- - true
- - false
- - name: locale
- in: query
- description: The language of an API definition can be provided. By default 'English' would be considered.
- required: false
- allowEmptyValue: false
- example: en
- schema:
- type: string
- - name: providerid
- in: query
- description: GUID of provider to which the API to be associated
- required: false
- allowEmptyValue: false
- example: 3bdf8005-5685-3ef5-b132-de4681963fb6
- schema:
- type: string
- - name: communities
- in: query
- description: GUID of communities to which the API to be associated
- required: false
- allowEmptyValue: false
- example: 3bdf8005-5685-3ef5-b132-de4681963fb6, 63df8005-5685-3ef5-b132-de4681963fb6
- schema:
- type: string
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- id:
- type: string
- processedCount:
- type: integer
- pendingCount:
- type: integer
- skippedCount:
- type: integer
- message:
- type: string
- status:
- type: string
- fileSize:
- type: integer
- elapsedTime:
- type: integer
- examples:
- async:
- value:
- id: 83d0b5e7-5f70-47e2-b89e-883f4857f056
- processedCount: 0
- pendingCount: 0
- skippedCount: 0
- message: Parsing Source File
- status: PARSING
- fileSize: 0
- elapsedTime: 0
- sync:
- value:
- id: c98d046b-1356-4216-8904-d89035ea66df
- _self: /rest/v1/apis/c98d046b-1356-4216-8904-d89035ea66df
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- 400:
- $ref: '#/components/examples/400'
-
- '/apis/_count':
- get:
- summary: Retrieve the count of APIs in API Portal
- description: |-
- Endpoint to get the number of APIs available in API Portal
- responses:
- '200':
- description: Retrieval of Count of APIs Successful
- content:
- plain/text:
- example: 10
-
- '/apis/filter':
- get:
- summary: Retrieve possible filter criterias of an APIs
- description: |-
- Endpoint to get the possible filter values that can be used to search or group an APIs
- parameters:
- - name: tenant
- in: query
- description: Filter values based on the API of the provided tenant will be returned. If the parameter is not provided then based upon user session tenant will be decided.
- required: false
- allowEmptyValue: false
- example: default
- schema:
- type: string
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiFilter'
- example: |-
- {
- "categories": [],
- "maturityStatus": [
- "Beta"
- ],
- "tags": [
- "Administrative",
- "Approvals",
- "API",
- "events",
- "Flow"
- ],
- "businessTerms": [],
- "type": [
- "ODATA",
- "REST",
- "SOAP"
- ]
- }
-
- '/apis/{id}':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: Retrieve an API by an ID
- description: |-
- Endpoint to obtain details of particular API based on ID
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/API'
- examples:
- 200:
- $ref: '#/components/examples/API'
-
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '403':
- $ref: '#/components/responses/Forbidden'
- '401':
- $ref: '#/components/responses/Unauthorized'
-
- put:
- summary: Update an API in API Portal
- description: |-
- Endpoint to re-publish an API to an API Portal. API can be updated in following ways,
- - Update API using the Swagger/OpeanAPI/RAML/WSDL file
- 
- - Update API using the external URL API Definition
- 
- - Update API using the API Definition
- 
-
- *Endpoint can be accessed only by a user having **Administrator** or **Provider** role*
- parameters:
- - name: type
- in: query
- description: Type of an API that is being published
- required: true
- allowEmptyValue: false
- schema:
- type: string
- enum:
- - swagger
- - raml
- - wsdl
- - openapi
- - name: async
- in: query
- description: Defines whether the API needs to be published synchronously or asynchronously. By default the API will be published asynchronously.
- required: false
- allowEmptyValue: false
- schema:
- type: boolean
- enum:
- - true
- - false
- - name: locale
- in: query
- description: The language of an API definition can be provided. By default 'English' would be considered.
- required: false
- allowEmptyValue: false
- example: en
- schema:
- type: string
- - name: providerid
- in: query
- description: GUID of provider to which the API to be associated
- required: false
- allowEmptyValue: false
- example: 3bdf8005-5685-3ef5-b132-de4681963fb6
- schema:
- type: string
- - name: communities
- in: query
- description: GUID of communities to which the API to be associated
- required: false
- allowEmptyValue: false
- example: 3bdf8005-5685-3ef5-b132-de4681963fb6, 63df8005-5685-3ef5-b132-de4681963fb6
- schema:
- type: string
- requestBody:
- content:
- multipart/formdata:
- schema:
- type: object
- properties:
- name:
- type: string
- description: Name of an API can be provided, this will override the name in API Definition
- example: Pet store
- tenant:
- type: string
- description: Tenant to which the API needs to be published. If the parameter is not provided then based upon user session tenant will be decided.
- example: default
- data:
- type: string
- description: API definition file in binary format
- api-content:
- type: string
- description: API Definition in Swagger/OpenAPI/RAML/WSDL format. This parameter is used for inline API publish
- url:
- type: string
- description: URL of API Definition in Swagger/OpenAPI/RAML/WSDL format
- example: https://petstore.swagger.io/v2/swagger.json
- root-file:
- type: string
- description: If an zip file containing API definitions is been used for publishing then the root file name needs to be provided.
- version:
- type: string
- description: Represent current version of the API
- versionof:
- type: string
- description: Represent Version family of APIs
- examples:
- Publish API using URL:
- value: |-
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ
- Content-Disposition: form-data; name="name"
-
- Pet
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ
- Content-Disposition: form-data; name="url"
-
- https://petstore.swagger.io/v2/swagger.json
- ------WebKitFormBoundaryW3ScWDgMrYIFpLVZ--
- Publish API using Inline content:
- value: |-
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP
- Content-Disposition: form-data; name="name"
-
- InlineAPI
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP
- Content-Disposition: form-data; name="api-content"
-
- {
- "swagger" : "2.0",
- "info" : {
- "version" : "1.0",
- "title" : "HTTPBin_Format_API"
- },
- "host" : "httpbin.org",
- "basePath" : "/",
- "schemes" : [ "http" ],
- "paths" : {
- "/xml" : {
- "get" : {
- "consumes" : [ ],
- "parameters" : [ ]
- }
- },
- "/json" : {
- "get" : {
- "consumes" : [ ],
- "parameters" : [ ]
- }
- }
- }
- }
- ------WebKitFormBoundarypaYOOLBaB3Dn59rP--
- Publish API using the file:
- value: |-
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="name"
-
- FileImport
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="version"
-
- 1.0
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA
- Content-Disposition: form-data; name="data"; filename="HTTPBin_Format_API.json"
- Content-Type: application/json
-
-
- ------WebKitFormBoundaryOBl7vP7ee7F5cESA--
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- id:
- type: string
- processedCount:
- type: integer
- pendingCount:
- type: integer
- skippedCount:
- type: integer
- message:
- type: string
- status:
- type: string
- fileSize:
- type: integer
- elapsedTime:
- type: integer
- examples:
- async:
- value:
- id: 83d0b5e7-5f70-47e2-b89e-883f4857f056
- processedCount: 0
- pendingCount: 0
- skippedCount: 0
- message: Parsing Source File
- status: PARSING
- fileSize: 0
- elapsedTime: 0
- sync:
- $ref: '#/components/examples/API'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- 400:
- $ref: '#/components/examples/400'
-
- delete:
- summary: Unpublish an API by an ID
- description: |-
- Endpoint to un-publish/delete an API from an API Portal.
-
- *Endpoint can be accessed only by a user having **Administrator** or **Provider** role*
- responses:
- '204':
- description: 'No content'
-
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/available':
- get:
- summary: Retrieve the APIs to be linked to an API Provider
- description: |-
- Endpoint to obtain list of APIs that can be linked to an API Provider
-
- *Endpoint can be accessed only by a user having **Administrator** or **Provider** role*
- parameters:
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- responses:
- '200':
- description: Successfully retrieved the APIs
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponse'
- example: |-
- {
- "result": [
- {
- "id": "a7f0f278-5620-4c0e-b1d2-052fd9585843",
- "name": "Import API",
- "icon": {
- "url": "/public/assets/images/rest-api-icon.svg",
- "type": "INTERNAL"
- },
- "version": "1.0",
- "type": "REST",
- "externalRefKey": "71ac978f-e665-4061-bddb-79338f76faba"
- },
- {
- "id": "d21466d7-f4e1-46e9-93de-3323a594a656",
- "name": "Portal Approval API",
- "summary": "API to manage workflow in portal. List of available operations are as follows\n- Create, update and list a flow\n- List available approval flows in Portal\n- List available pending approval requests\n- Approve/Reject approval request",
- "icon": {
- "url": "/public/assets/images/rest-api-icon.svg",
- "type": "INTERNAL"
- },
- "version": "10.11",
- "type": "REST",
- "externalRefKey": "8d59eb88-8a9b-4c41-8c38-e670db725038"
- }
- ],
- "count": 2,
- "_links": {
- "_self": "/rest/v1/apis/available?page=0"
- }
- }
-
- '/apis/{id}/communities':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: 'Get Communities linked with the API'
- description: |-
- Endpoint to obtain list of communites that are linked with an API
-
- *Endpoint can be accessed only by a user having **Administrator** or **Provider** role*
- responses:
- '200':
- $ref: '#/components/responses/Community'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/topics':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- get:
- summary: Get Topics linked with the API
- description: |-
- Endpoint to obtain list of topics that are linked with an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponseTopics'
- examples:
- 200:
- $ref: '#/components/examples/SearchResponseTopicSummary'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/{id}/applications':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- get:
- summary: Get Applications linked with the API
- description: |-
- Endpoint to obtain list of applications that are linked with an API
-
- responses:
- '200':
- $ref: '#/components/responses/Application'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/{id}/subscriptions':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: status
- in: query
- description: Optional parameter. Query based on the status of subscription. Default value is LIVE
- required: false
- schema:
- type: string
- default: LIVE
- get:
- summary: Get Subscriptions linked with the API
- description: |-
- Endpoint to obtain list of subscriptions that are linked with an API
-
- responses:
- '200':
- $ref: '#/components/responses/Subscriptions'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/{id}/versions':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: 'Get versions of the API'
- description: |-
- Endpoint to obtain list of versions of an API
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/APISummary'
- example:
- - id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- name: HTTPBin_Format_API
- summary: ''
- icon:
- url: /public/assets/images/rest-api-icon.svg
- type: INTERNAL
- version: '1.0'
- type: REST
- externalRefKey: a76728ed-f760-4fff-a4b6-993b99356d07
-
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/stages':
- parameters:
- - $ref: '#/components/parameters/apiId'
-
- get:
- summary: 'Get stages of the API'
- description: |-
- Endpoint to obtain different stages of an API
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/APISummary'
- example:
- - id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- name: HTTPBin_Format_API
- summary: ''
- icon:
- url: /public/assets/images/rest-api-icon.svg
- type: INTERNAL
- version: '1.0'
- type: REST
- stage: API Portal Dev
- externalRefKey: a76728ed-f760-4fff-a4b6-993b99356d07
- - id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- name: HTTPBin_Format_API
- summary: ''
- icon:
- url: /public/assets/images/rest-api-icon.svg
- type: INTERNAL
- version: '1.0'
- type: REST
- stage: API Portal QA
- externalRefKey: a76728ed-f760-4fff-a4b6-993b99356d07
-
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/api/{id}/followers':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- default: 0
- get:
- summary: Get followers of an API
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: object
- properties:
- result:
- type: array
- items:
- type: object
- properties:
- firstname:
- type: string
- lastname:
- type: string
- picture:
- type: string
- id:
- type: string
- count:
- type: number
- links:
- type: object
- properties:
- _self:
- type: string
- _next:
- type: string
- _previous:
- type: string
- examples:
- Followers:
- value:
- result:
- - id: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- firstname: Administrator
- lastname: System
- pictureUrl: null
- count: 1
- _links:
- _self: /rest/v1/apis/0938f456-d34f-49ea-8a32-dc72ee13a8a3/followers?page=0
- description: |-
- Endpoint to obtain followers list of an API
- put:
- summary: Follow/ Un-Follow API
- description: |-
- Endpoint to follow or unfollow an API
-
- responses:
- '200':
- description: 'The response when the follow/ un-follow is successfully'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UpdationResponse'
- examples:
- updated:
- summary: Example
- value:
- code: 200
- message: Follow entity successful
-
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: 'The response when the requested API is not found in API Portal'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the API with id [fefcfc8f-0a77-4976-b5aasd4-eeaa53884f3b]
-
- '/apis/{id}/packages':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- get:
- summary: 'Get packages linked with the API'
- description: |-
- Endpoint to obtain list of communites that are linked with an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponsePackage'
- examples:
- 200:
- $ref: '#/components/examples/SearchResponsePackageSummary'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/groups':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: 'Get API methods by group'
- description: |-
- Endpoint to obtain methods of an API segregated by groups
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Groups'
- examples:
- 200:
- $ref: '#/components/examples/Groups'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/applications/available':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- get:
- summary: Get Applications that can be linked with the API
- description: |-
- Endpoint to obtain list of applications that can be linked with an API
-
- responses:
- '200':
- $ref: '#/components/responses/Application'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/{id}/rate':
- parameters:
- - $ref: '#/components/parameters/apiId'
- put:
- summary: Rate an API
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/RatingRequest'
- examples:
- RatingRequest:
- $ref: '#/components/examples/RatingRequest'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/RatingResponse'
- examples:
- RatingResponse:
- $ref: '#/components/examples/RatingResponse'
- description: |-
- Endpoint to rate an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- get:
- summary: Get the rating for an API
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/RatingResponse'
- examples:
- RatingResponse:
- $ref: '#/components/examples/RatingResponse'
- description: |-
- Endpoint to get rating of an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
-
- '/apis/{id}/followers/_count':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: Retrieve the count of followers for an API
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: number
- description: Number of followers in the API
- example:
- 3
- description: |-
- Endpoint to get the number of followers fo an API
-
- '/apis/{id}/bookmarks':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: page
- in: query
- description: Optional parameter. Defines the page number to be retrieved for the collection. If not specified default value 0 is assumed. By default collection responses are paginated with batches of 10.
- required: false
- schema:
- type: integer
- default: 0
- - name: limit
- in: query
- description: Optional parameter. Defines the number of results to be fetched for the current page. If not specified default value configured in system settings will be considered.
- required: false
- schema:
- type: integer
- get:
- summary: Get bookmarked topics linked with the API
- description: |-
- Endpoint to obtain list of bookmarked topics that are linked with an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponseTopics'
- examples:
- 200:
- $ref: '#/components/examples/SearchResponseTopicSummary'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
-
- '/apis/{id}/try':
- parameters:
- - $ref: '#/components/parameters/apiId'
- post:
- summary: Test an API
- description: |-
- Endpoint to test the resource or operation of an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TryAPIRequest'
- examples:
- SOAPTryRequest:
- $ref: '#/components/examples/SOAPTryRequest'
- RestTryRequest:
- $ref: '#/components/examples/RestTryRequest'
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TryAPIResponse'
- examples:
- TryAPIResponse:
- $ref: '#/components/examples/TryAPIResponse'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
-
- '/apis/{id}/fileTypeTry':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - $ref: '#/components/parameters/tryendpoint'
- post:
- summary: To test the multipart or binary type resources of API
- description: |-
- Endpoint to test the multipart or binary type resourcesof an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- additionalProperties: true
- application/octet-stream:
- schema:
- type: string
- format: binary
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TryAPIResponse'
- examples:
- TryAPIResponse:
- $ref: '#/components/examples/TryAPIResponse'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
-
- '/apis/{id}/try/history':
- parameters:
- - $ref: '#/components/parameters/apiId'
- get:
- summary: Get tryout history
- description: |-
- Endpoint to get the history of tryout conducted for an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponseAudits'
- example: |-
- {
- "result": [
- {
- "id": "d2fe3af8-236d-41d5-8178-f47f44518c00",
- "parameters": {
- "api_id": "29d04ad2-35c5-4c4b-aa3b-bf363557ea39",
- "try_out_response": {
- "headers": {
- "Cache-Control": [
- "max-age=0"
- ],
- "Server": [
- "Microsoft-IIS/7.5"
- ],
- "X-AspNet-Version": [
- "2.0.50727"
- ],
- "Content-Length": [
- "326"
- ],
- "Date": [
- "25 Jun 2020 07:31:09 GMT"
- ],
- "Content-Type": [
- "text/xml; charset=utf-8"
- ],
- "X-Powered-By": [
- "ASP.NET"
- ]
- },
- "response": {
- "type": "TEXT",
- "response": "!!io.swagger.models.auth.OAuth2Definition\nauthorizationUrl: http://petstore.swagger.io/oauth/dialog\ndescription: null\nflow: implicit\nscopes:\n write:pets: modify pets in your account\n read:pets: read your pets\ntokenUrl: null\ntype: oauth2\nvendorExtensions: {\n }\n"
- },
- {
- "name": "api_key",
- "description": "!!io.swagger.models.auth.ApiKeyAuthDefinition\ndescription: null\nin: HEADER\nname: api_key\ntype: apiKey\nvendorExtensions: {\n }\n"
- }
- ],
- "properties": [
- {
- "name": "Contact Email",
- "key": "Contact Email",
- "value": "apiteam@swagger.io",
- "type": "STRING"
- },
- {
- "name": "External Document Description",
- "key": "External Document Description",
- "value": "Find out more about Swagger",
- "type": "STRING"
- },
- {
- "name": "Terms Of Service",
- "key": "Terms Of Service",
- "value": "http://swagger.io/terms/",
- "type": "STRING"
- },
- {
- "name": "License Name",
- "key": "License Name",
- "value": "Apache 2.0",
- "type": "STRING"
- },
- {
- "name": "External Document Url",
- "key": "External Document Url",
- "value": "http://swagger.io",
- "type": "STRING"
- },
- {
- "name": "License URL",
- "key": "License URL",
- "value": "http://www.apache.org/licenses/LICENSE-2.0.html",
- "type": "STRING"
- }
- ],
- "providerRef": "5390f906-1334-44cd-b251-7087f4d4e6ce",
- "inputContentType": "[]",
- "outputContentType": "[]",
- "components": [
- {
- "schema": [
- {
- "name": "Order",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"petId\":{\"type\":\"integer\",\"format\":\"int64\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\"},\"shipDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"status\":{\"type\":\"string\",\"description\":\"Order Status\",\"enum\":[\"placed\",\"approved\",\"delivered\"]},\"complete\":{\"type\":\"boolean\",\"default\":false}},\"xml\":{\"name\":\"Order\"}}",
- "description": ""
- },
- {
- "name": "Category",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"}},\"xml\":{\"name\":\"Category\"}}",
- "description": ""
- },
- {
- "name": "User",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"username\":{\"type\":\"string\"},\"firstName\":{\"type\":\"string\"},\"lastName\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"phone\":{\"type\":\"string\"},\"userStatus\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"User Status\"}},\"xml\":{\"name\":\"User\"}}",
- "description": ""
- },
- {
- "name": "Tag",
- "schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"}},\"xml\":{\"name\":\"Tag\"}}",
- "description": ""
- },
- {
- "name": "Pet",
- "schema": "{\"type\":\"object\",\"required\":[\"name\",\"photoUrls\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"category\":{\"$ref\":\"#/definitions/Category\",\"originalRef\":\"#/definitions/Category\"},\"name\":{\"type\":\"string\",\"example\":\"doggie\"},\"photoUrls\":{\"type\":\"array\",\"xml\":{\"name\":\"photoUrl\",\"wrapped\":true},\"items\":{\"type\":\"string\"}},\"tags\":{\"type\":\"array\",\"xml\":{\"name\":\"tag\",\"wrapped\":true},\"items\":{\"$ref\":\"#/definitions/Tag\",\"originalRef\":\"#/definitions/Tag\"}},\"status\":{\"type\":\"string\",\"description\":\"pet status in the store\",\"enum\":[\"available\",\"pending\",\"sold\"]}},\"xml\":{\"name\":\"Pet\"}}",
- "description": ""
- },
- {
- "name": "ApiResponse",
- "schema": "{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"type\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"}}}",
- "description": ""
- }
- ]
- }
- ],
- "resourceIds": [
- "bef97b8d-fb7c-4bfc-bcfb-176077c79352"
- ],
- "hybridAPI": false,
- "protected": true,
- "secured": true,
- "summary": "This is a sample server Petstore server.",
- "description": "This is a sample server Petstore server.",
- "externalRefKey": "71a172a4-ac3f-457f-a150-82e704242c0e"
- }
- ],
- "count": 1,
- "_links" : {
- "_self": "rest/v1/search?page=0"
- }
- }
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/export':
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: type
- in: query
- description: Export format can be specified. The supported types are json and yaml
- required: false
- schema:
- type: string
- default: json
- get:
- summary: 'Export an API'
- description: |-
- Endpoint to export an API
-
- *Endpoint can be accessed only by a user having **API READ** permission*
- responses:
- '200':
- description: ''
- content:
- application/json:
- example: |-
- {
- "openapi": "3.0.1",
- "info": {
- "title": "HTTPBin_Format_API",
- "description": "",
- "version": "1.0"
- },
- "servers": [
- {
- "url": "http://SAG-56ZNM13:5555/gateway/HTTPBin_Format_API/1.0"
- }
- ],
- "paths": {
- "/json": {
- "summary": "",
- "description": "",
- "get": {
- "summary": "",
- "description": "",
- "operationId": "GET",
- "responses": {},
- "security": [
- {}
- ]
- }
- },
- "/xml": {
- "summary": "",
- "description": "",
- "get": {
- "summary": "",
- "description": "",
- "operationId": "GET",
- "responses": {},
- "security": [
- {}
- ]
- }
- }
- },
- "components": {
- "securitySchemes": {
- "x-Gateway-APIKey": {
- "type": "apiKey",
- "name": "x-Gateway-APIKey",
- "in": "header"
- }
- }
- }
- }
-
- application/x-yaml:
- example: |-
- openapi: 3.0.1
- info:
- title: HTTPBin_Format_API
- description: ""
- version: "1.0"
- servers:
- - url: http://SAG-56ZNM13:5555/gateway/HTTPBin_Format_API/1.0
- paths:
- /json:
- summary: ""
- description: ""
- get:
- summary: ""
- description: ""
- operationId: GET
- responses: {}
- security:
- - {}
- /xml:
- summary: ""
- description: ""
- get:
- summary: ""
- description: ""
- operationId: GET
- responses: {}
- security:
- - {}
- components:
- securitySchemes:
- x-Gateway-APIKey:
- type: apiKey
- name: x-Gateway-APIKey
- in: header
-
- '404':
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- updated:
- summary: Example
- value:
- code: 404
- message: Unable to find the requested API
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
-
- '/apis/{id}/preferences':
- put:
- summary: Used to update the view preference of a hybrid API
- description: Used to update the view preference of a hybrid API
- responses:
- '200':
- $ref: '#/components/responses/UpdatePreference'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
- parameters:
- - $ref: '#/components/parameters/apiId'
- - name: type
- in: query
- required: true
- schema:
- type: string
- enum:
- - REST
- - SOAP
-
- '/apis/{id}/edits':
- put:
- summary: Edit the details of APIs and its associated resources
- description: |-
- Endpoint that is used to edit the basic details of an API, Resources or Methods
- requestBody:
- description: API patch payload
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PatchDTO'
- examples:
- PatchPayload:
- $ref: '#/components/examples/PatchPayload'
- responses:
- '200':
- description: Patch created successfully
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
- parameters:
- - $ref: '#/components/parameters/apiId'
-
- '/apis/{id}/logo':
- put:
- summary: Update the logo of the given API
- description: Endpoint that is used to update the logo of the given API
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- file:
- type: object
- description: New Logo of the API to be uploaded.
- example: |
- ------WebKitFormBoundaryWh7YIEN5mdUWFbkh
- Content-Disposition: form-data; name="file"; filename="Logo.jpg"
- Content-Type: image/jpeg
-
-
- ------WebKitFormBoundaryWh7YIEN5mdUWFbkh--
- responses:
- '200':
- $ref: '#/components/responses/CreationResponse'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
- parameters:
- - $ref: '#/components/parameters/apiId'
-
- '/apis/{id}/attachments':
- put:
- summary: Update the attachments of the given API
- description: Endpoint that is used to update the attachments of the given API
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- file:
- type: object
- description: New attachment of the API to be uploaded.
- example: |
- ------WebKitFormBoundaryWh7YIEN5mdUWFbkh
- Content-Disposition: form-data; name="file"; filename="Spec.json"
- Content-Type: application/json
-
-
- ------WebKitFormBoundaryWh7YIEN5mdUWFbkh--
- responses:
- '200':
- $ref: '#/components/responses/CreationResponse'
- '401':
- $ref: '#/components/responses/Unauthorized'
- '403':
- $ref: '#/components/responses/Forbidden'
- '404':
- $ref: '#/components/responses/NotFound'
- parameters:
- - $ref: '#/components/parameters/apiId'
-
-components:
- securitySchemes:
- accesstoken:
- type: apiKey
- in: cookie
- name: accesstoken
- bearerAuth:
- type: http
- scheme: bearer
- bearerFormat: JWT
- responses:
- Unauthorized:
- description: Unauthorized
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- 401:
- $ref: '#/components/examples/401'
- Forbidden:
- description: Forbidden
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- 403:
- $ref: '#/components/examples/403'
- NotFound:
- description: The specified resource was not found
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- examples:
- 404:
- $ref: '#/components/examples/404'
- Community:
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Community'
- examples:
- 200:
- $ref: '#/components/examples/Community'
- Topic:
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Topic'
- examples:
- 200:
- $ref: '#/components/examples/Topic'
- Application:
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponseApplication'
- examples:
- 200:
- $ref: '#/components/examples/Application'
- Subscriptions:
- description: ''
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponseSubscription'
- examples:
- 200:
- $ref: '#/components/examples/Subscription'
- SearchResponse:
- description: ok
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SearchResponse'
- UpdatePreference:
- description: Update preference response
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UpdationResponse'
- examples:
- UpdatePreference:
- $ref: '#/components/examples/UpdatePreference'
- CreationResponse:
- description: The response when an entity is created successfully
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CreatedResponse'
- examples:
- CreationResponse:
- $ref: '#/components/examples/CreatedResponse'
-
- schemas:
- CreatedResponse:
- type: object
- properties:
- id:
- description: Identifier of the newly created object
- type: string
- _self:
- description: Self reference of the newly created object
- type: string
- UpdationResponse:
- type: object
- properties:
- code:
- type: integer
- message:
- type: string
- SearchResponse:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/APISummary'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- SearchResponseApplication:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/Application'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- SearchResponseSubscription:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/Subscription'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- SearchResponseTopics:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/Topic'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- SearchResponsePackage:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/Package'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- SearchResponseAudits:
- type: object
- properties:
- result:
- type: array
- items:
- $ref: '#/components/schemas/AuditEventRepositoryObject'
- count:
- type: integer
- _links:
- type: object
- additionalProperties:
- type: string
- AuditEventRepositoryObject:
- allOf:
- - $ref: '#/components/schemas/RepositoryObject'
- type: object
- properties:
- parameters:
- description: Event meta data
- type: object
- additionalProperties:
- type: object
- example:
- api_name: AccuWeather
- type:
- description: Type of the event
- type: object
- enum:
- - $ref: '#/components/schemas/EventType'
- RatingRequest:
- type: object
- properties:
- rating:
- type: integer
- RatingResponse:
- type: object
- properties:
- total:
- type: integer
- average:
- type: number
- format: double
- rating:
- type: number
- format: double
- RepositoryObject:
- type: object
- properties:
- id:
- type: string
- format: uuid
- name:
- type: string
- summary:
- type: string
- description:
- type: string
- owner:
- type: string
- modified:
- type: string
- format: 'yyyy-MM-dd HH:mm'
- created:
- type: string
- format: 'yyyy-MM-dd HH:mm'
- EventType:
- title: Type of the event
- type: string
- example: API_TRY_EVENT
- enum:
- - API_PUBLISH_EVENT
- - API_REPUBLISH_EVENT
- - API_UN_PUBLISH_EVENT
- - PROVIDER_PUBLISH_EVENT
- - PROVIDER_REPUBLISH_EVENT
- - PROVIDER_UNPUBLISH_EVENT
- - SIGN_UP_EVENT
- - APPLICATION_REQUEST_EVENT
- - APPLICATION_CREATION_REQUEST_EVENT
- - APPLICATION_REQUEST_APPROVED_EVENT
- - APPLICATION_REQUEST_REJECTED_EVENT
- - COMMUNITY_CREATION_EVENT
- - COMMUNITY_DELETION_EVENT
- - COMMUNITY_MEMBERSHIP_CHANGE_EVENT
- - COMMUNITY_SCOPE_CHANGE_EVENT
- - IN_APP_NOTIFICATION_EVENT
- - EMAIL_NOTIFICATION_EVENT
- - API_TRY_EVENT
- Error:
- type: object
- properties:
- code:
- type: integer
- message:
- type: string
- Status:
- type: object
- properties:
- id:
- type: string
- description: unique identification
- processed:
- type: integer
- description: processed api/s count
- pending:
- type: integer
- description: processed api/s count
- message:
- type: string
- description: Publish message
- status:
- type: string
- description: Publish status
- enum:
- - PENDING
- - PARSING
- - INPROGRESS
- - SUCCEEDED
- - FAILED
- successes:
- description: Id and name of API/s successfully published - key value pair
- type: object
- additionalProperties:
- type: string
- failures:
- description: Id and name of API/s failed to publish - key value pair
- type: object
- additionalProperties:
- type: string
- ApiFilter:
- type: object
- properties:
- categories:
- type: array
- description: Represent Categories of APIs
- items:
- type: string
- maturityStatus:
- type: array
- description: Represent Maturity Status of APIs
- items:
- type: string
- tags:
- type: array
- description: Represent Tags of APIs
- items:
- type: string
- businessTerms:
- type: array
- description: Represent Business Terms of APIs
- items:
- type: string
- type:
- type: array
- description: Type of an APIs
- items:
- type: string
- Community:
- type: object
- properties:
- id:
- type: string
- description: Unique identification of Community
- name:
- type: string
- description: Name of the Community
- owner:
- type: string
- description: owner of the Community
- description:
- type: string
- description: Description of the Community
- apis:
- type: array
- description: APIS associated with the community
- items:
- type: string
- groups:
- type: array
- description: Group associated with the community
- items:
- type: string
- users:
- type: array
- description: Users associated with the community
- items:
- type: string
- API:
- allOf:
- - $ref: '#/components/schemas/APISummary'
- - type: object
- properties:
- tags:
- type: array
- items:
- type: string
- endPoints:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- description: The URL to invoke
- baseUrl:
- type: string
- apiProperties:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- key:
- type: string
- value:
- type: string
- resources:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- description: Resource name
- id:
- type: string
- description: GUID of an resource object
- path:
- type: string
- description: Resource path
- tags:
- type: array
- items:
- type: string
- requestBody:
- type: object
- restMethods:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- httpMethod:
- type: string
- secured:
- type: boolean
- parameters:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- cname:
- type: string
- paramType:
- type: string
- dataType:
- type: string
- mandatory:
- type: boolean
- possibleValues:
- type: array
- items:
- type: string
- multivalue:
- type: boolean
- summary:
- type: string
- description:
- type: string
- summary:
- type: string
- requestBody:
- type: object
- tags:
- type: array
- items:
- type: string
- responses:
- type: object
- properties:
- key:
- type: object
- properties:
- summary:
- type: string
- responses:
- type: object
- properties:
- key:
- type: object
- properties:
- summary:
- type: string
- Groups:
- type: object
- properties:
- groupName:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- apiId:
- type: string
- description:
- type: string
- id:
- type: string
- cname:
- type: string
- httpMethod:
- type: string
- parameters:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- cname:
- type: string
- paramType:
- type: string
- dataType:
- type: string
- mandatory:
- type: boolean
- possibleValues:
- type: array
- items:
- type: string
- multivalue:
- type: boolean
- summary:
- type: string
- description:
- type: string
- summary:
- type: string
- requestBody:
- type: object
- tags:
- type: array
- items:
- type: string
- responses:
- type: object
- properties:
- key:
- type: object
- properties:
- summary:
- type: string
-
- APISummary:
- type: object
- properties:
- id:
- type: string
- description: Unique identification of API
- name:
- type: string
- description: Name of the API
- description:
- type: string
- description: Summary of the API
- version:
- type: string
- description: Version of the API
- type:
- type: string
- description: Type of the API
- enum:
- - REST
- - ODATA
- - SOAP
- externalRefKey:
- type: string
- description: Reference key of the API
- providerRef:
- type: string
- description: Provider reference key
- systemVersion:
- type: string
- description: Internal version reference
- versionFamilyRef:
- type: string
- description: Version family group unique GUID
- icon:
- type: object
- properties:
- url:
- type: string
- description: location of an icon file
- type:
- type: string
- communities:
- type: array
- items:
- type: string
- description: GUID of the communities
- attachments:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- description: Name of the attachment file
- uri:
- type: string
- description: REST path to download the file
- maturityStatus:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- cname:
- type: string
- policies:
- type: array
- items:
- type: object
- properties:
- name:
- type: string
- description: Name of the policy
- summary:
- type: string
- description:
- type: string
- securitySchemes:
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- description: Type of the security scheme
- name:
- type: string
- in:
- type: string
- endpointIds:
- type: array
- items:
- type: string
- description: GUID of the endpoint object
- rating:
- type: integer
- description: Rating of an API
- resourceIds:
- type: array
- items:
- type: string
- description: GUID of an resource object
- componentIds:
- type: array
- items:
- type: string
- description: GUID of an component object
- hybrid:
- type: boolean
- description: Determines is it an hybrid API. Example REST on SOAP API
- Topic:
- type: object
- required:
- - name
- properties:
- owner:
- type: string
- id:
- type: string
- modified:
- type: string
- created:
- type: string
- flagged:
- type: boolean
- content:
- type: object
- properties:
- value:
- type: string
- type:
- type: string
- comments:
- type: integer
- pinned:
- type: boolean
- stream:
- type: object
- properties:
- type:
- type: string
- id:
- type: string
- tags:
- type: array
- items:
- type: string
- Package:
- type: object
- required:
- - name
- properties:
- id:
- type: string
- name:
- type: string
- description:
- type: string
- providerRef:
- type: string
- deprecated:
- type: boolean
- icon:
- type: object
- communities:
- type: array
- items:
- type: string
- apis:
- type: array
- items:
- type: string
- plans:
- type: array
- items:
- type: string
- externalRefKey:
- type: string
-
- Application:
- type: object
- properties:
- id:
- type: string
- description: Unique identification of Application
- name:
- type: string
- description: Name of the Application
- owner:
- type: string
- description: owner of the Application
- description:
- type: string
- description: Description of the Application
- apis:
- type: array
- description: APIS associated with the Application
- items:
- type: string
- stage:
- type: string
- description: Stage from which Application is published
- packageId:
- type: string
- description: Id of package associated with the Application
- planId:
- type: string
- description: Id of plan associated with the Application
- app_type:
- type: string
- description: Type of Application
- enum:
- - API
- - SUBSCRIPTION
- access:
- $ref: '#/components/schemas/AccessControlList'
- details:
- $ref: '#/components/schemas/Details'
- Subscription:
- type: object
- properties:
- id:
- type: string
- description: Unique identification of Application
- name:
- type: string
- description: Name of the Application
- owner:
- type: string
- description: owner of the Application
- description:
- type: string
- description: Description of the Application
- apis:
- type: array
- description: APIS associated with the Application
- items:
- type: string
- stage:
- type: string
- description: Stage from which Application is published
- status:
- type: string
- description: Status of an Application
- deleted:
- type: boolean
- packageId:
- type: string
- description: Id of package associated with the Application
- planId:
- type: string
- description: Id of plan associated with the Application
- app_type:
- type: string
- description: Type of Application
- enum:
- - API
- - SUBSCRIPTION
- access:
- $ref: '#/components/schemas/AccessControlList'
- details:
- $ref: '#/components/schemas/Details'
- AccessControlList:
- type: object
- description: Applications access information.
- properties:
- TEAMS_REF:
- type: string
- description: Refernce Id of Team
- created:
- type: string
- format: date
- description: Created date
- modified:
- type: string
- format: date
- description: Modified date
- teams:
- type: array
- description: Teams associated with the Application
- items:
- type: string
- users:
- type: array
- description: Users associated with the Application
- items:
- type: string
- Details:
- type: object
- description: Access details of application.
- properties:
- IdentifierType:
- type: string
- description: Type of access detail
- enum:
- - APIKey
- - OAuth2
- - JWT
-
- ApplicationCredential:
- type: object
-
- APIKeyCredential:
- type: object
- properties:
- expiry:
- type: string
- format: date
- description: expiry date
- apiKey:
- type: string
- description: Key for the api
-
- JwtCredential:
- type: object
- properties:
- claimsets:
- type: array
- items:
- $ref: '#/components/schemas/ClaimSet'
-
- OAuthCredential:
- type: object
- properties:
- clientId:
- type: string
- description: Unique identification of the client
- clientSecret:
- type: string
- description: Secret key of the client
- token_lifetime:
- type: integer
- description: Lifetime of the token
- token_refresh_limit:
- type: integer
- description: No of times refresh of the token is allowed
- scopes:
- type: array
- description: Scope of this token
- items:
- type: string
- authorization_uris:
- type: array
- description: authorization_uris
- items:
- type: string
- access_token_uris:
- type: array
- description: access_token_uris
- items:
- type: string
- redirect_uris:
- type: array
- description: redirect_uris
- items:
- type: string
- refreshtoken_uris:
- type: array
- description: refreshtoken_uris
- items:
- type: string
- ClaimSet:
- type: object
- properties:
- name:
- type: string
- description: Name of the Claim Set
- claims:
- type: array
- items:
- type: string
- TryAPIRequest:
- type: object
- properties:
- operation:
- type: string
- endpoint:
- type: string
- headers:
- type: object
- additionalProperties: true
- body:
- $ref: '#/components/schemas/TryoutBody'
- type:
- type: string
- required:
- - operation
- - endpoint
- - headers
- - body
- - type
- TryoutBody:
- anyOf:
- - $ref: '#/components/schemas/SoapTryoutBody'
- - $ref: '#/components/schemas/RestTryoutBody'
- SoapTryoutBody:
- type: object
- properties:
- request_type:
- type: string
- payload:
- type: string
- namespaceUri:
- type: object
- additionalProperties: true
- security:
- type: object
- properties:
- wssUserToken:
- type: object
- properties:
- username:
- type: string
- password:
- type: string
- required:
- - username
- - password
- required:
- - request_type
- - payload
- RestTryoutBody:
- type: object
- additionalProperties: true
- TryAPIResponse:
- type: object
- properties:
- headers:
- type: object
- additionalProperties: true
- response:
- type: object
- properties:
- type:
- type: string
- response:
- type: string
- contentType:
- type: string
- required:
- - type
- - response
- - contentType
- status:
- type: object
- properties:
- code:
- type: integer
- reason:
- type: string
- required:
- - code
- - reason
- metrics:
- type: object
- properties:
- time:
- type: integer
- ip:
- type: string
- required:
- - time
- - ip
- required:
- - headers
- - response
- - status
- - metrics
- PatchDTO:
- type: object
- properties:
- api:
- allOf:
- - $ref: '#/components/schemas/PatchDefinition'
- - type: object
- properties:
- apiId:
- type: string
- methods:
- type: object
- additionalProperties: true
- paths:
- type: object
- additionalProperties: true
- paths:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PatchDefinition'
- - type: object
- properties:
- path:
- type: string
- methodsMap:
- type: object
- additionalProperties: true
- methods:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PatchDefinition'
- - type: object
- properties:
- path:
- type: string
- operation:
- type: string
- enum:
- - POST
- - PUT
- - GET
- - DELETE
- - PATCH
- - HEAD
- - OPTIONS
- - SOAP11
- - SOAP1
- PatchDefinition:
- type: object
- properties:
- insert:
- type: array
- items:
- $ref: '#/components/schemas/PatchStep'
- update:
- type: array
- items:
- $ref: '#/components/schemas/PatchStep'
- delete:
- type: array
- items:
- $ref: '#/components/schemas/PatchStep'
- PatchStep:
- type: object
- properties:
- attribute:
- type: string
- oneOf:
- - enum:
- - NAME
- - SUMMARY
- - DESCRIPTION
- - ICON
- - TAG
- - CATEGORIES
- - BUSINESS_TERMS
- - MATURITY_STATUS
- - ATTACHMENT
- locale:
- type: string
- value:
- type: string
-
- examples:
- CreatedResponse:
- value:
- id: 52c0b766-8bdc-4932-93f2-c7bcb8a16750
- _self: /rest/v1/files/52c0b766-8bdc-4932-93f2-c7bcb8a16750
- PatchPayload:
- value:
- api:
- update:
- - attribute: NAME
- locale: en
- value: Modified name
- insert:
- - attribute: ATTACHMENT
- value: /rest/v1/files/5d248c0b-4ec7-4eb5-b514-7c2e726afb4d
- UpdatePreference:
- value:
- code: 200
- message: Preferences updated successfully
- 401:
- value:
- code: 401
- message: Invalid credentials
- 403:
- value:
- code: 403
- message: Insufficient privileges
- 404:
- value:
- code: 404
- message: Unable to find the requested API
- 400:
- value:
- code: 400
- message: Invalid file
- Community:
- value:
- - id: 3bdf8005-5685-3ef5-b132-de4681963fb6
- name: New Commnunity
- description: This community has been created newly
- owner: 52c0b766-8bdc-4932-93f2-c7bcb8a16750
- apis:
- - 80b2c6d2-30e5-4b2f-82ce-07f9205941cb
- - ebf986ac-cb6c-405b-b047-67202706c42e
- groups:
- - 568ecf56-5fdc-4d2a-a3f7-64a6d824a21d
- users:
- - 52c0b766-8bdc-4932-93f2-c7bcb8a16750
- - 6b8e787f-142d-4675-901d-21999b8dc6e2
- Topic:
- value:
- owner: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- id: 8e38ee64-2306-4208-823a-ac9aab5cc43b
- modified: 1617013155719
- created: 1617013155719
- flagged: false
- stream:
- type: API
- id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- content:
- value: '{"ops":[{"insert":"TestTopic2\n"}]}'
- type: rich
- pinned: false
- person:
- id: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- firstName: Administrator
- lastName: System
- comments: 0
- TopicSummary:
- value:
- owner: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- id: 8e38ee64-2306-4208-823a-ac9aab5cc43b
- modified: 1617013155719
- created: 1617013155719
- flagged: false
- stream:
- type: API
- id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- content:
- value: '{"ops":[{"insert":"TestTopic2\n"}]}'
- type: rich
- pinned: false
- person:
- id: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- firstName: Administrator
- lastName: System
- comments: 0
- Application:
- value:
- result:
- - name: HTTPApp
- owner: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- id: 21236a05-dbd0-44cd-a62d-df16b7798892
- providerRef: a1b3a59c-0639-4260-a9a6-c75c78fcb62d
- access:
- teams: [ ]
- users: [ ]
- apis:
- - d6376456-9d08-4a3e-b44d-7f40bb206d51
- - 58436a0d-df78-4c9b-968f-2d8d1c082283
- credentials:
- - expiry: null
- apiKey: f0d88156-e62b-4679-8519-ef40365c4155
- type: APIKey
- - clientId: 9e99de65-7168-48b7-8af3-578882417cf0
- clientSecret: b5cfadb5-dc56-4fbe-8912-c4a369e831c9
- scopes: [ ]
- tokenLifeTime: 3600
- tokenRefreshLimit: 0
- authorizationUris:
- - 'http://host.docker.internal:5555/invoke/pub.apigateway.oauth2/authorize'
- accessTokenUris:
- - 'http://host.docker.internal:5555/invoke/pub.apigateway.oauth2/getAccessToken'
- redirectUris:
- - /rest/v1/oauth/callback
- refreshTokenUris:
- - 'http://host.docker.internal:5555/invoke/pub.oauth/refreshAccessToken'
- type: OAuth2
- claimsets:
- - name: JWT default claims set
- claims:
- - key: app_id
- value: cc4ef914-3e6b-439b-bed6-2fd63af3ead2
- - accesstoken_uris: null
- type: JWT
- status: LIVE
- slots:
- $stage: API Portal
- deleted: false
- externalRefKey: cc4ef914-3e6b-439b-bed6-2fd63af3ead2
- app_type: API
- count: 1
- _links:
- _self: /rest/v1/apis/cb996fe0-95c5-4ba3-8212-148ddd99c15b/applications?page=0
- Subscription:
- value:
- result:
- - name: PlanSubscribe
- owner: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- id: a8660172-7ad4-491c-8a51-3b6dcb64f9e1
- providerRef: a1b3a59c-0639-4260-a9a6-c75c78fcb62d
- access:
- teams: [ ]
- users: [ ]
- apis: [ ]
- packageId: 41ed0fb4-3c9e-47b4-aab0-119c674c997f
- planId: 4738b319-7de5-47e9-b869-1967a042e075
- credentials:
- - expiry: null
- apiKey: 2f757170-4a3f-47ca-b4ac-5845ad40ec43
- type: APIKey
- - clientId: 39ae0aee-67d5-4e62-bb95-2bab469317e1
- clientSecret: 4c24dbb6-a8f7-4b16-88cb-9ab6526067cd
- scopes: [ ]
- tokenLifeTime: 3600
- tokenRefreshLimit: 0
- authorizationUris:
- - 'http://host.docker.internal:5555/invoke/pub.apigateway.oauth2/authorize'
- accessTokenUris:
- - 'http://host.docker.internal:5555/invoke/pub.apigateway.oauth2/getAccessToken'
- redirectUris:
- - /rest/v1/oauth/callback
- refreshTokenUris:
- - 'http://host.docker.internal:5555/invoke/pub.oauth/refreshAccessToken'
- type: OAuth2
- status: LIVE
- slots:
- $stage: API Portal
- deleted: false
- externalRefKey: 30f1a040-b76f-4bd5-99b7-f18c0c5c9f6e
- app_type: SUBSCRIPTION
- count: 1
- _links:
- _self: /rest/v1/apis/cb996fe0-95c5-4ba3-8212-148ddd99c15b/subscriptions?page=0
- RatingRequest:
- value:
- rating: 3
- RatingResponse:
- value:
- total: 3
- average: 3.5
- rating: 4
- SearchResponseTopicSummary:
- value:
- result:
- - owner: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- id: 8e38ee64-2306-4208-823a-ac9aab5cc43b
- modified: 1617013155719
- created: 1617013155719
- flagged: false
- stream:
- type: API
- id: d6376456-9d08-4a3e-b44d-7f40bb206d51
- content:
- value: '{"ops":[{"insert":"TestTopic2\n"}]}'
- type: rich
- pinned: false
- person:
- id: 200ceb26-807d-3bf9-9fd6-f4f0d1ca54d4
- firstName: Administrator
- lastName: System
- comments: 0
- count: 1
- _links:
- _self: /rest/v1/apis/cb996fe0-95c5-4ba3-8212-148ddd99c15b/topics?page=0
- SearchResponsePackageSummary:
- value:
- result:
- - id: 41ed0fb4-3c9e-47b4-aab0-119c674c997f
- name: TestPkg
- description: TestDesc
- providerRef: a1b3a59c-0639-4260-a9a6-c75c78fcb62d
- deprecated: false
- icon: null
- communities:
- - 3bdf8005-5685-3ef5-b132-de4681963fb6
- apis:
- - d6376456-9d08-4a3e-b44d-7f40bb206d51
- plans:
- - 4738b319-7de5-47e9-b869-1967a042e075
- externalRefKey: 0f74a7e2-058c-42d5-b162-9a078dbcc390
- count: 1
- _links:
- _self: /rest/v1/apis/cb996fe0-95c5-4ba3-8212-148ddd99c15b/packages?page=0
- SOAPTryRequest:
- value:
- operation: SOAP11
- endpoint: 'http://VMSIQADEM0O01:4444/ws/Calculator/1'
- headers:
- SOAPAction: 'http://tempuri.org/Add'
- body:
- request_type: soap
- payload: '${this.api.name}
+${this.api.summary}
+ View details >>
+ `
+ }
+
+ private getPredefinedDataTemplate() {
+ return `
+
+
+
+ `
+ }
+
+}
\ No newline at end of file
diff --git a/samples/web-components/api-gallery-group/src/components/gallery-page-component.ts b/samples/web-components/api-gallery-group/src/components/gallery-page-component.ts
new file mode 100644
index 0000000..21db8dc
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/components/gallery-page-component.ts
@@ -0,0 +1,259 @@
+import {AbstractPortalElement} from "../abstract.portal.element";
+import {ApiElement} from "./api.element";
+import {RequestDataService} from "../service/request.service";
+import {ApiModel} from "../model/data/api.model";
+import {List} from "../model/list";
+
+export class GalleryPageComponent extends AbstractPortalElement {
+
+ apisModels: ApiModel[] = null;
+ constructor() {
+ super();
+ }
+
+ connectedCallback() {
+ this.attachShadow({mode: 'open'});
+ }
+
+ async render(): Promise
+ 
+
+
+ GMail
+Headline : The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. The API can be used by Gmail and Google Apps users alike as an alternative to IMAP. It is intended primarily for programmatic, batch mailbox access as a we
+
+
+
+
+
+ GMail
+Headline : The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. The API can be used by Gmail and Google Apps users alike as an alternative to IMAP. It is intended primarily for programmatic, batch mailbox access as a we
+
+
+
+
+
+ GMail
+Headline : The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. The API can be used by Gmail and Google Apps users alike as an alternative to IMAP. It is intended primarily for programmatic, batch mailbox access as a we
+
+
+
+
+
+ GMail
+Headline : The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. The API can be used by Gmail and Google Apps users alike as an alternative to IMAP. It is intended primarily for programmatic, batch mailbox access as a we
+
+
+
+ `
+ }
+
+
+}
\ No newline at end of file
diff --git a/samples/web-components/api-gallery-group/src/index.ts b/samples/web-components/api-gallery-group/src/index.ts
new file mode 100644
index 0000000..4798514
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/index.ts
@@ -0,0 +1,5 @@
+import {GalleryPageComponent} from "./components/gallery-page-component";
+import {ApiElement} from "./components/api.element";
+
+customElements.define("api-gallery", GalleryPageComponent)
+customElements.define("api-gallery-api", ApiElement)
\ No newline at end of file
diff --git a/samples/web-components/api-gallery-group/src/model/context.model.ts b/samples/web-components/api-gallery-group/src/model/context.model.ts
new file mode 100644
index 0000000..39793d4
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/model/context.model.ts
@@ -0,0 +1,5 @@
+export class ContextModel {
+ getData: () => any;
+ navigate: (path: string) => void;
+ getLocaleString: (key: string) => string;
+}
diff --git a/samples/web-components/api-gallery-group/src/model/data/api.model.ts b/samples/web-components/api-gallery-group/src/model/data/api.model.ts
new file mode 100644
index 0000000..cfc6e58
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/model/data/api.model.ts
@@ -0,0 +1,11 @@
+import {RepositoryModel} from './repository.model';
+
+export class ApiModel extends RepositoryModel {
+
+ type: string;
+
+ constructor(name: string, id: string, summary: string, description: string, type: string) {
+ super(name, id, summary, description);
+ this.type = type;
+ }
+}
diff --git a/samples/web-components/api-gallery-group/src/model/data/filter.model.ts b/samples/web-components/api-gallery-group/src/model/data/filter.model.ts
new file mode 100644
index 0000000..d2c32b1
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/model/data/filter.model.ts
@@ -0,0 +1,7 @@
+export class FilterModel {
+ categories: string[] = [];
+ maturityStatus: string[] = [];
+ tags: string[] = [];
+ businessTerms: string[] = [];
+ type: string[] = [];
+}
\ No newline at end of file
diff --git a/samples/web-components/api-gallery-group/src/model/data/repository.model.ts b/samples/web-components/api-gallery-group/src/model/data/repository.model.ts
new file mode 100644
index 0000000..901906f
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/model/data/repository.model.ts
@@ -0,0 +1,14 @@
+export class RepositoryModel {
+ name: string;
+ id: string;
+ summary: string;
+ description: string;
+
+
+ constructor(name: string, id: string, summary: string, description: string) {
+ this.name = name;
+ this.id = id;
+ this.summary = summary;
+ this.description = description;
+ }
+}
diff --git a/samples/web-components/api-gallery-group/src/model/list.ts b/samples/web-components/api-gallery-group/src/model/list.ts
new file mode 100644
index 0000000..32ab8a6
--- /dev/null
+++ b/samples/web-components/api-gallery-group/src/model/list.ts
@@ -0,0 +1,5 @@
+export class ListAPI gallery
+
+
+
+
+ Maturity Status
+ API Group
+ Business Terms
+
+ ${this.asset.name}
+${this.asset.summary}
+ View details >>
+ `
+ }
+
+
+}
diff --git a/samples/web-components/asset-gallery/src/components/gallery-page-component.ts b/samples/web-components/asset-gallery/src/components/gallery-page-component.ts
new file mode 100644
index 0000000..3c0aa2d
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/components/gallery-page-component.ts
@@ -0,0 +1,221 @@
+import {AbstractPortalElement} from "../abstract.portal.element";
+import {AssetBox} from "./asset-box";
+import {RequestDataService} from "../service/request.service";
+import {ApiModel} from "../model/data/api.model";
+import {List} from "../model/list";
+
+export class GalleryPageComponent extends AbstractPortalElement {
+
+ assetModels: any[] = null;
+ constructor() {
+ super();
+ }
+
+ connectedCallback() {
+ this.attachShadow({mode: 'open'});
+ }
+
+ async render(): Promise
+
+ `
+ }
+
+
+}
\ No newline at end of file
diff --git a/samples/web-components/asset-gallery/src/index.ts b/samples/web-components/asset-gallery/src/index.ts
new file mode 100644
index 0000000..5c53b37
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/index.ts
@@ -0,0 +1,4 @@
+import {AssetBox} from "./components/asset-box";
+
+
+customElements.define("wc-asset-box", AssetBox)
diff --git a/samples/web-components/asset-gallery/src/model/context.model.ts b/samples/web-components/asset-gallery/src/model/context.model.ts
new file mode 100644
index 0000000..39793d4
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/model/context.model.ts
@@ -0,0 +1,5 @@
+export class ContextModel {
+ getData: () => any;
+ navigate: (path: string) => void;
+ getLocaleString: (key: string) => string;
+}
diff --git a/samples/web-components/asset-gallery/src/model/data/api.model.ts b/samples/web-components/asset-gallery/src/model/data/api.model.ts
new file mode 100644
index 0000000..cfc6e58
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/model/data/api.model.ts
@@ -0,0 +1,11 @@
+import {RepositoryModel} from './repository.model';
+
+export class ApiModel extends RepositoryModel {
+
+ type: string;
+
+ constructor(name: string, id: string, summary: string, description: string, type: string) {
+ super(name, id, summary, description);
+ this.type = type;
+ }
+}
diff --git a/samples/web-components/asset-gallery/src/model/data/filter.model.ts b/samples/web-components/asset-gallery/src/model/data/filter.model.ts
new file mode 100644
index 0000000..d2c32b1
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/model/data/filter.model.ts
@@ -0,0 +1,7 @@
+export class FilterModel {
+ categories: string[] = [];
+ maturityStatus: string[] = [];
+ tags: string[] = [];
+ businessTerms: string[] = [];
+ type: string[] = [];
+}
\ No newline at end of file
diff --git a/samples/web-components/asset-gallery/src/model/data/repository.model.ts b/samples/web-components/asset-gallery/src/model/data/repository.model.ts
new file mode 100644
index 0000000..901906f
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/model/data/repository.model.ts
@@ -0,0 +1,14 @@
+export class RepositoryModel {
+ name: string;
+ id: string;
+ summary: string;
+ description: string;
+
+
+ constructor(name: string, id: string, summary: string, description: string) {
+ this.name = name;
+ this.id = id;
+ this.summary = summary;
+ this.description = description;
+ }
+}
diff --git a/samples/web-components/asset-gallery/src/model/list.ts b/samples/web-components/asset-gallery/src/model/list.ts
new file mode 100644
index 0000000..32ab8a6
--- /dev/null
+++ b/samples/web-components/asset-gallery/src/model/list.ts
@@ -0,0 +1,5 @@
+export class ListAsset gallery
+
+
+
+
+ Tickets
+ Hackathon
+ Beta
+
+