-
Notifications
You must be signed in to change notification settings - Fork 252
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #516 from Rajith90/master_new
Add quick start to README
- Loading branch information
Showing
4 changed files
with
356 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| [listenerConfig] | ||
| host="0.0.0.0" | ||
| httpPort=9090 | ||
| httpsPort=9095 | ||
| keyStore.path="${ballerina.home}/bre/security/ballerinaKeystore.p12" | ||
| keyStore.password="ballerina" | ||
| trustStore.path="${ballerina.home}/bre/security/ballerinaTruststore.p12" | ||
| trustStore.password="ballerina" | ||
| tokenListenerPort=9096 | ||
|
|
||
| [authConfig] | ||
| authorizationHeader="Authorization" | ||
| removeAuthHeaderFromOutMessage=true | ||
|
|
||
| [keyManager] | ||
| serverUrl="https://localhost:9443" | ||
| username="admin" | ||
| password="admin" | ||
| tokenContext="oauth2" | ||
| timestampSkew=5000 | ||
| verifyHostname=true | ||
|
|
||
| [jwtTokenConfig] | ||
| issuer="https://localhost:9443/oauth2/token" | ||
| audience="http://org.wso2.apimgt/gateway" | ||
| certificateAlias="wso2apim" | ||
|
|
||
|
|
||
| [jwtConfig] | ||
| header="X-JWT-Assertion" | ||
|
|
||
| [caching] | ||
| enabled=true | ||
| tokenCache.expiryTime=900000 | ||
| tokenCache.capacity=10000 | ||
| tokenCache.evictionFactor=0.25 | ||
|
|
||
| [analytics] | ||
| enable=false | ||
| uploadingTimeSpanInMillis=600000 | ||
| uploadingEndpoint="https://localhost:9444/analytics/v1.0/usage/upload-file" | ||
| rotatingPeriod=600000 | ||
| task.uploadFiles=true | ||
| username="admin" | ||
| password="admin" | ||
| verifyHostname=true | ||
|
|
||
| [http2] | ||
| enable=false | ||
|
|
||
| [mutualSSLConfig] | ||
| protocolName="TLS" | ||
| protocolVersions="TLSv1.2,TLSv1.1" | ||
| ciphers="TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256,TLS_DHE_RSA_WITH_AES_128_CBC_SHA256,TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA, TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDH_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 ,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 ,TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,SSL_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA,SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA, SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA,TLS_EMPTY_RENEGOTIATION_INFO_SCSV" | ||
| sslVerifyClient="not_require" | ||
|
|
||
| ["b7a.users"] | ||
| ["b7a.users.generalUser1"] | ||
| password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8" | ||
|
|
||
| [validationConfig] | ||
| enableRequestValidation = false | ||
| enableResponseValidation = false | ||
| absolutePathToSwagger = " " | ||
|
|
||
|
|
||
| [throttlingConfig] | ||
| enabledGlobalTMEventPublishing = false | ||
| jmsConnectioninitialContextFactory = "bmbInitialContextFactory" | ||
| jmsConnectionProviderUrl= "amqp://admin:admin@carbon/carbon?brokerlist='tcp://localhost:5672'" | ||
| jmsConnectionUsername = "" | ||
| jmsConnectionPassword = "" | ||
| throttleEndpointUrl = "https://localhost:9443/endpoints" | ||
| verifyHostname=true | ||
| throttleEndpointbase64Header = "admin:admin" | ||
|
|
||
| [tokenRevocationConfig] | ||
| [tokenRevocationConfig.realtime] | ||
| enableRealtimeMessageRetrieval = false | ||
| jmsConnectionTopic = "tokenRevocation" | ||
| jmsConnectioninitialContextFactory = "bmbInitialContextFactory" | ||
| jmsConnectionProviderUrl= "amqp://admin:admin@carbon/carbon?brokerlist='tcp://localhost:5672'" | ||
| jmsConnectionUsername = "" | ||
| jmsConnectionPassword = "" | ||
| [tokenRevocationConfig.persistent] | ||
| enablePersistentStorageRetrieval = false | ||
| useDefault = true | ||
| hostname = "https://127.0.0.1:2379/v2/keys/jti/" | ||
| username = "root" | ||
| password = "root" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| --- | ||
| openapi: 3.0.0 | ||
| servers: | ||
| - url: https://petstore.swagger.io/v2 | ||
| - url: http://petstore.swagger.io/v2 | ||
| info: | ||
| description: 'This is a sample server Petstore server. You can find out more about | ||
| Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For | ||
| this sample, you can use the api key `special-key` to test the authorization filters.' | ||
| version: 1.0.0 | ||
| title: Swagger Petstore New | ||
| termsOfService: http://swagger.io/terms/ | ||
| contact: | ||
| email: apiteam@swagger.io | ||
| license: | ||
| name: Apache 2.0 | ||
| url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
| tags: | ||
| - name: pet | ||
| description: Everything about your Pets | ||
| externalDocs: | ||
| description: Find out more | ||
| url: http://swagger.io | ||
| - name: store | ||
| description: Access to Petstore orders | ||
| - name: user | ||
| description: Operations about user | ||
| externalDocs: | ||
| description: Find out more about our store | ||
| url: http://swagger.io | ||
| x-mgw-basePath: /petstore/v1 | ||
| x-mgw-production-endpoints: | ||
| urls: | ||
| - https://petstore.swagger.io/v2 | ||
| paths: | ||
| "/pet/findByStatus": | ||
| get: | ||
| tags: | ||
| - pet | ||
| summary: Finds Pets by status | ||
| description: Multiple status values can be provided with comma separated strings | ||
| operationId: findPetsByStatus | ||
| parameters: | ||
| - name: status | ||
| in: query | ||
| description: Status values that need to be considered for filter | ||
| required: true | ||
| explode: true | ||
| schema: | ||
| type: array | ||
| items: | ||
| type: string | ||
| enum: | ||
| - available | ||
| - pending | ||
| - sold | ||
| default: available | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/xml: | ||
| schema: | ||
| type: array | ||
| items: | ||
| "$ref": "#/components/schemas/Pet" | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| "$ref": "#/components/schemas/Pet" | ||
| '400': | ||
| description: Invalid status value | ||
| "/pet/{petId}": | ||
| get: | ||
| tags: | ||
| - pet | ||
| summary: Find pet by ID | ||
| description: Returns a single pet | ||
| operationId: getPetById | ||
| parameters: | ||
| - name: petId | ||
| in: path | ||
| description: ID of pet to return | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| format: int64 | ||
| security: | ||
| - OAuth2: | ||
| - read | ||
| - write | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/xml: | ||
| schema: | ||
| "$ref": "#/components/schemas/Pet" | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/Pet" | ||
| '400': | ||
| description: Invalid ID supplied | ||
| '404': | ||
| description: Pet not found | ||
| components: | ||
| schemas: | ||
| Category: | ||
| type: object | ||
| properties: | ||
| id: | ||
| type: integer | ||
| format: int64 | ||
| name: | ||
| type: string | ||
| xml: | ||
| name: Category | ||
| Tag: | ||
| type: object | ||
| properties: | ||
| id: | ||
| type: integer | ||
| format: int64 | ||
| name: | ||
| type: string | ||
| xml: | ||
| name: Tag | ||
| Pet: | ||
| type: object | ||
| required: | ||
| - name | ||
| - photoUrls | ||
| properties: | ||
| id: | ||
| type: integer | ||
| format: int64 | ||
| category: | ||
| "$ref": "#/components/schemas/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": "#/components/schemas/Tag" | ||
| status: | ||
| type: string | ||
| description: pet status in the store | ||
| enum: | ||
| - available | ||
| - pending | ||
| - sold | ||
| xml: | ||
| name: Pet | ||
| securitySchemes: | ||
| OAuth2: | ||
| type: oauth2 | ||
| flows: | ||
| authorizationCode: | ||
| authorizationUrl: https://example.com/oauth/authorize | ||
| tokenUrl: https://example.com/oauth/token | ||
| scopes: | ||
| read: Grants read access | ||
| write: Grants write access | ||
| admin: Grants access to admin operations | ||
| mybasic: | ||
| type: basic | ||
| requestBodies: | ||
| Pet: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/Pet" | ||
| application/xml: | ||
| schema: | ||
| "$ref": "#/components/schemas/Pet" | ||
| description: Pet object that needs to be added to the store | ||
| required: true | ||
|
|
||
|
|