From 4906547568e52e5400df93f9f419921551ac0d0b Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Tue, 29 Aug 2023 08:55:39 -0700 Subject: [PATCH 1/9] add name to file --- README.md | 2 +- spec/petStore.json | 2 +- tsoa.json | 4 +--- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 266d8a6..f137bb5 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Revalidate: This script is a combination of the generate and lint steps. Useful npm run revalidate ``` -generatePostman: creates the postman collection from the OpenAPI Document +generatePostman: creates the postman collection from the OpenAPI Document ```bash npm run generatePostman diff --git a/spec/petStore.json b/spec/petStore.json index 20c429e..8877e7d 100644 --- a/spec/petStore.json +++ b/spec/petStore.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "title": "", + "title": "PetStore", "version": "1.0.0-rev1", "description": "This is the API for the Pet Store.", "license": { diff --git a/tsoa.json b/tsoa.json index 10500d9..b36181c 100644 --- a/tsoa.json +++ b/tsoa.json @@ -9,9 +9,7 @@ "specVersion": 3, "specFileBaseName": "petStore", "description": "This is the API for the Pet Store.", - "info": { - "title": "Pet Store" - }, + "name": "PetStore", "license": "Apache 2.0", "contact": { "name": "Dan Tolbert: dantolbe@cisco.com", From 2fe6225077cc60df9eba0e128fdaf578d4fa471a Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 19:16:21 -0400 Subject: [PATCH 2/9] update readme to be more flexible --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f137bb5..66cc6bc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# IMPACT23-API-Lifecycle +# API-Quality-Lifecycle -Demo Workshop for 2023 Cisco IMPACT +Demo Workshop for leveraging open source tools to deploy and check APIs for quality gates. ## Overview @@ -20,6 +20,7 @@ Demo Workshop for 2023 Cisco IMPACT - [Postman](https://www.postman.com/) - [NPM](https://npmjs.com) - [TypeScript](https://www.typescriptlang.org/) +- [Kong](https://konghq.com/) ## Generating and running @@ -32,13 +33,13 @@ Demo Workshop for 2023 Cisco IMPACT Clone the Repository: First, clone the repository to your local machine: ```bash -git clone https://github.com/dtolb/IMPACT23-API-Lifecycle.git +git clone https://github.com/dtolb/API-Quality-Lifecycle.git ``` Navigate to the Project Directory: ```bash -cd IMPACT23-API-Lifecycle +cd API-Quality-Lifecycle ``` Install Dependencies: Now, install the necessary project dependencies using Yarn: From 5ee608044b67d3fc24fcfaec04376c2e0eddaa26 Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 19:37:44 -0400 Subject: [PATCH 3/9] add kong to ci/cd --- .github/workflows/spectral.yaml | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index 1919ac3..b31fe6d 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -1,4 +1,4 @@ -name: Spectral Lint +name: Quality Pipeline permissions: write-all on: pull_request: @@ -41,3 +41,31 @@ jobs: env: POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }} if: github.event_name == 'release' + + # Ping to your Kong instance + - name: decK ping + id: decK_ping + uses: ikeike443/decK-action@master + with: + command: "ping" + options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" + if: github.event_name == 'release' + + # Generate Config File to sync + - name: decK file openapi2kong + id: deck_file_openapi2kong + uses: ikeike443/decK-action@master + with: + command: "file openapi2kong" + options: "--spec spec/petStore.json output-file petStoreKong.yaml" + if: github.event_name == 'release' + + # Sync the state of the files to the Kong instance and update the deployment status in your repo by GitHub Deployment API + - name: decK sync + id: decK_sync + uses: ikeike443/decK-action@master + with: + command: "sync -s petStoreKong.yaml" + options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" + github_token: ${{ secrets.GITHUB_TOKEN }} + if: github.event_name == 'release' From b78184715168c026a7f357afff365a14b35b941a Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 19:50:38 -0400 Subject: [PATCH 4/9] update kong workspace --- .github/workflows/spectral.yaml | 12 ++++++++ kong/petKong.yaml | 52 +++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 kong/petKong.yaml diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index b31fe6d..a4fea11 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -46,6 +46,10 @@ jobs: - name: decK ping id: decK_ping uses: ikeike443/decK-action@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} + DECK_PAT: ${{ secrets.DECK_PAT }} with: command: "ping" options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" @@ -55,6 +59,10 @@ jobs: - name: decK file openapi2kong id: deck_file_openapi2kong uses: ikeike443/decK-action@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} + DECK_PAT: ${{ secrets.DECK_PAT }} with: command: "file openapi2kong" options: "--spec spec/petStore.json output-file petStoreKong.yaml" @@ -64,6 +72,10 @@ jobs: - name: decK sync id: decK_sync uses: ikeike443/decK-action@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} + DECK_PAT: ${{ secrets.DECK_PAT }} with: command: "sync -s petStoreKong.yaml" options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" diff --git a/kong/petKong.yaml b/kong/petKong.yaml new file mode 100644 index 0000000..cf4757d --- /dev/null +++ b/kong/petKong.yaml @@ -0,0 +1,52 @@ +_format_version: "3.0" +services: +- host: localhost + id: 6ce82fd3-ffaa-564d-a98e-7b6cf11d7b5a + name: petstore + path: /v1 + plugins: [] + port: 3000 + protocol: http + routes: + - id: fcabe360-daec-5fbf-a2be-50f393c23e38 + methods: + - GET + name: petstore_listpets + paths: + - ~/pets$ + plugins: [] + regex_priority: 200 + strip_path: false + tags: [] + - id: b3862911-a318-51f8-99e7-5f6f3685c61f + methods: + - POST + name: petstore_createpet + paths: + - ~/pets$ + plugins: [] + regex_priority: 200 + strip_path: false + tags: [] + - id: 0ef5ebf6-6973-5d23-a051-ab9367803be3 + methods: + - GET + name: petstore_getpet + paths: + - ~/pets/(?[^#?/]+)$ + plugins: [] + regex_priority: 100 + strip_path: false + tags: [] + - id: 7f1a9c95-7df0-5a54-8619-a59ace7f5604 + methods: + - PUT + name: petstore_updatepet + paths: + - ~/pets/(?[^#?/]+)$ + plugins: [] + regex_priority: 100 + strip_path: false + tags: [] + tags: [] +upstreams: [] From 086a11b4e994970b5171f6d2acd4a8d829b1cc13 Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 19:51:24 -0400 Subject: [PATCH 5/9] update workflow --- .github/workflows/spectral.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index a4fea11..1296bec 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -65,7 +65,7 @@ jobs: DECK_PAT: ${{ secrets.DECK_PAT }} with: command: "file openapi2kong" - options: "--spec spec/petStore.json output-file petStoreKong.yaml" + options: "--spec ./spec/petStore.json output-file ./kong/petStoreKong.yaml" if: github.event_name == 'release' # Sync the state of the files to the Kong instance and update the deployment status in your repo by GitHub Deployment API From bde3f45b60e0c5a61cec3df42295554c65631c6f Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 20:02:57 -0400 Subject: [PATCH 6/9] update actions to download deck --- .github/workflows/spectral.yaml | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index 1296bec..7ccc145 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -42,42 +42,39 @@ jobs: POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }} if: github.event_name == 'release' + - name: Setup Deck + run: | + curl -sL https://github.com/kong/deck/releases/download/v1.25.0/deck_1.25.0_linux_amd64.tar.gz -o deck.tar.gz + tar -xf deck.tar.gz -C /tmp + sudo cp /tmp/deck /usr/local/bin/ + + # Ping to your Kong instance - name: decK ping id: decK_ping - uses: ikeike443/decK-action@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} DECK_PAT: ${{ secrets.DECK_PAT }} - with: - command: "ping" - options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" + run: deck ping --konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }} if: github.event_name == 'release' # Generate Config File to sync - name: decK file openapi2kong id: deck_file_openapi2kong - uses: ikeike443/decK-action@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} DECK_PAT: ${{ secrets.DECK_PAT }} - with: - command: "file openapi2kong" - options: "--spec ./spec/petStore.json output-file ./kong/petStoreKong.yaml" + run: deck file openapi2kong --spec ./spec/petStore.json output-file ./kong/petStoreKong.yaml if: github.event_name == 'release' # Sync the state of the files to the Kong instance and update the deployment status in your repo by GitHub Deployment API - name: decK sync id: decK_sync - uses: ikeike443/decK-action@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} DECK_PAT: ${{ secrets.DECK_PAT }} - with: - command: "sync -s petStoreKong.yaml" - options: "--konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }}" - github_token: ${{ secrets.GITHUB_TOKEN }} + run: deck sync -s petStoreKong.yaml --konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }} if: github.event_name == 'release' From 24d9bb12c1ee8249e600b0aa3b347579edbd7bed Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 20:05:29 -0400 Subject: [PATCH 7/9] typo --- .github/workflows/spectral.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index 7ccc145..33413bd 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -66,7 +66,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} DECK_PAT: ${{ secrets.DECK_PAT }} - run: deck file openapi2kong --spec ./spec/petStore.json output-file ./kong/petStoreKong.yaml + run: deck file openapi2kong --spec ./spec/petStore.json --output-file ./kong/petStoreKong.yaml if: github.event_name == 'release' # Sync the state of the files to the Kong instance and update the deployment status in your repo by GitHub Deployment API @@ -76,5 +76,5 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DECK_GROUP_NAME: ${{ secrets.DECK_GROUP_NAME }} DECK_PAT: ${{ secrets.DECK_PAT }} - run: deck sync -s petStoreKong.yaml --konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }} + run: deck sync -s ./kong/petStoreKong.yaml --konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }} if: github.event_name == 'release' From 70cb43985fcc2f09b8d527380e656e5063f7007c Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 20:11:39 -0400 Subject: [PATCH 8/9] update url --- .github/workflows/spectral.yaml | 5 ++--- tsoa.json | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/spectral.yaml b/.github/workflows/spectral.yaml index 33413bd..5042274 100644 --- a/.github/workflows/spectral.yaml +++ b/.github/workflows/spectral.yaml @@ -48,8 +48,7 @@ jobs: tar -xf deck.tar.gz -C /tmp sudo cp /tmp/deck /usr/local/bin/ - - # Ping to your Kong instance + # Ping to your Kong instance - name: decK ping id: decK_ping env: @@ -59,7 +58,7 @@ jobs: run: deck ping --konnect-runtime-group-name ${{ secrets.DECK_GROUP_NAME }} --konnect-token ${{ secrets.DECK_PAT }} if: github.event_name == 'release' - # Generate Config File to sync + # Generate Config File to sync - name: decK file openapi2kong id: deck_file_openapi2kong env: diff --git a/tsoa.json b/tsoa.json index b36181c..3365dea 100644 --- a/tsoa.json +++ b/tsoa.json @@ -3,7 +3,7 @@ "noImplicitAdditionalProperties": "throw-on-extras", "controllerPathGlobs": ["./src/controllers/**/*Controller.ts"], "spec": { - "host": "localhost:3000", + "host": "pet-store-kong-3abae03b4c44.herokuapp.com", "basePath": "/v1/", "outputDirectory": "./spec", "specVersion": 3, From 62f4be944fb0b2dbc0a9a72b80ef9c14d813c521 Mon Sep 17 00:00:00 2001 From: Dan Tolbert Date: Thu, 7 Sep 2023 20:19:51 -0400 Subject: [PATCH 9/9] updates --- collection.json | 2106 +++++++++++++++--------------- kong/petKong.yaml | 96 +- petStore-Postman-collection.json | 2096 ++++++++++++++--------------- 3 files changed, 2077 insertions(+), 2221 deletions(-) diff --git a/collection.json b/collection.json index 44ad877..dc42d24 100644 --- a/collection.json +++ b/collection.json @@ -1,1111 +1,1039 @@ { - "item": [ + "item": [ + { + "name": "Read", + "description": "Read operations", + "item": [ { - "name": "Read", - "description": "Read operations", - "item": [ + "id": "fcfd808f-2e58-42f0-8a0c-b71ccb083aa2", + "name": "list Pets", + "request": { + "name": "list Pets", + "description": { + "content": "Lists all pets in the PetStore", + "type": "text/plain" + }, + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "fcfd808f-2e58-42f0-8a0c-b71ccb083aa2", - "name": "list Pets", - "request": { - "name": "list Pets", - "description": { - "content": "Lists all pets in the PetStore", - "type": "text/plain" - }, - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "1f2c0200-3335-4a54-bbac-1b3a244b3458", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" }, - "response": [ - { - "id": "1f2c0200-3335-4a54-bbac-1b3a244b3458", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "ListPetsHeaders", - "value": "TrackingId,,Date,,link," - } - ], - "body": "{\n \"items\": [\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d40e4548-f99e-4a03-a839-2c13d3c903f0", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d8307240-84f8-457f-a9cb-11f736e7d512", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" }, { - "id": "a28f8b54-ee7e-4a71-8ab8-47169c0010a2", - "name": "get Pet", - "request": { - "name": "get Pet", - "description": { - "content": "Get a pet by its id", - "type": "text/plain" - }, - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "id", - "disabled": false - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "ListPetsHeaders", + "value": "TrackingId,,Date,,link," + } + ], + "body": "{\n \"items\": [\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d40e4548-f99e-4a03-a839-2c13d3c903f0", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" }, - "response": [ - { - "id": "b78cc56b-1774-4241-acb5-fe717b316788", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "ListPetsHeaders", - "value": "TrackingId,,Date,,link," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "55e763ad-bc61-4180-96de-59f52a75261f", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d60376b1-8d84-4607-8ea7-1c3076f72a12", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8307240-84f8-457f-a9cb-11f736e7d512", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," } - ] + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "name": "Write", - "description": "Write operations", - "item": [ + "id": "a28f8b54-ee7e-4a71-8ab8-47169c0010a2", + "name": "get Pet", + "request": { + "name": "get Pet", + "description": { + "content": "Get a pet by its id", + "type": "text/plain" + }, + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [ { - "id": "d9536a34-0b3b-4c27-a53c-0f0ce5264d88", - "name": "create Pet", - "request": { - "name": "create Pet", - "description": { - "content": "Create a new pet with its adorable name", - "type": "text/plain" - }, - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "58d8e8f1-969f-4074-b284-e31a26a4cd96", - "name": "Created", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Created", - "code": 201, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "183bbbdd-f13b-49e5-b6a3-001c4da8ab3d", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e263895b-16f0-440c-b4c5-309a30f21156", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "b78cc56b-1774-4241-acb5-fe717b316788", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ { - "id": "ff652121-23bf-4c8e-8fd6-8a8af09470e0", - "name": "update Pet", - "request": { - "name": "update Pet", - "description": { - "content": "Update the pet information by its id", - "type": "text/plain" - }, - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "id", - "disabled": false - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "ec74bba3-cbb2-46b7-a449-41cb5e32ee8f", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e05ae59e-b419-47f8-8cb9-5a89ca64e801", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "782ea701-4a4e-469d-830d-77fbdf00f29f", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "ListPetsHeaders", + "value": "TrackingId,,Date,,link," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "55e763ad-bc61-4180-96de-59f52a75261f", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d60376b1-8d84-4607-8ea7-1c3076f72a12", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," } - ] + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } } - ], - "event": [], - "variable": [ + ] + }, + { + "name": "Write", + "description": "Write operations", + "item": [ { - "key": "baseUrl", - "value": "http://localhost:3000/v1" - } - ], - "info": { - "_postman_id": "98f99bc7-4dcf-4e67-a49b-7a6d74f29e64", - "name": "Imported from OpenAPI", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "description": { - "content": "This is the API for the Pet Store.\n\nContact Support:\n Name: Dan Tolbert: dantolbe@cisco.com", - "type": "text/plain" + "id": "d9536a34-0b3b-4c27-a53c-0f0ce5264d88", + "name": "create Pet", + "request": { + "name": "create Pet", + "description": { + "content": "Create a new pet with its adorable name", + "type": "text/plain" + }, + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "58d8e8f1-969f-4074-b284-e31a26a4cd96", + "name": "Created", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "183bbbdd-f13b-49e5-b6a3-001c4da8ab3d", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e263895b-16f0-440c-b4c5-309a30f21156", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ff652121-23bf-4c8e-8fd6-8a8af09470e0", + "name": "update Pet", + "request": { + "name": "update Pet", + "description": { + "content": "Update the pet information by its id", + "type": "text/plain" + }, + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "ec74bba3-cbb2-46b7-a449-41cb5e32ee8f", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e05ae59e-b419-47f8-8cb9-5a89ca64e801", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "782ea701-4a4e-469d-830d-77fbdf00f29f", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } } + ] + } + ], + "event": [], + "variable": [ + { + "key": "baseUrl", + "value": "http://localhost:3000/v1" + } + ], + "info": { + "_postman_id": "98f99bc7-4dcf-4e67-a49b-7a6d74f29e64", + "name": "Imported from OpenAPI", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "This is the API for the Pet Store.\n\nContact Support:\n Name: Dan Tolbert: dantolbe@cisco.com", + "type": "text/plain" } -} \ No newline at end of file + } +} diff --git a/kong/petKong.yaml b/kong/petKong.yaml index cf4757d..001f471 100644 --- a/kong/petKong.yaml +++ b/kong/petKong.yaml @@ -1,52 +1,52 @@ -_format_version: "3.0" +_format_version: '3.0' services: -- host: localhost - id: 6ce82fd3-ffaa-564d-a98e-7b6cf11d7b5a - name: petstore - path: /v1 - plugins: [] - port: 3000 - protocol: http - routes: - - id: fcabe360-daec-5fbf-a2be-50f393c23e38 - methods: - - GET - name: petstore_listpets - paths: - - ~/pets$ + - host: localhost + id: 6ce82fd3-ffaa-564d-a98e-7b6cf11d7b5a + name: petstore + path: /v1 plugins: [] - regex_priority: 200 - strip_path: false + port: 3000 + protocol: http + routes: + - id: fcabe360-daec-5fbf-a2be-50f393c23e38 + methods: + - GET + name: petstore_listpets + paths: + - ~/pets$ + plugins: [] + regex_priority: 200 + strip_path: false + tags: [] + - id: b3862911-a318-51f8-99e7-5f6f3685c61f + methods: + - POST + name: petstore_createpet + paths: + - ~/pets$ + plugins: [] + regex_priority: 200 + strip_path: false + tags: [] + - id: 0ef5ebf6-6973-5d23-a051-ab9367803be3 + methods: + - GET + name: petstore_getpet + paths: + - ~/pets/(?[^#?/]+)$ + plugins: [] + regex_priority: 100 + strip_path: false + tags: [] + - id: 7f1a9c95-7df0-5a54-8619-a59ace7f5604 + methods: + - PUT + name: petstore_updatepet + paths: + - ~/pets/(?[^#?/]+)$ + plugins: [] + regex_priority: 100 + strip_path: false + tags: [] tags: [] - - id: b3862911-a318-51f8-99e7-5f6f3685c61f - methods: - - POST - name: petstore_createpet - paths: - - ~/pets$ - plugins: [] - regex_priority: 200 - strip_path: false - tags: [] - - id: 0ef5ebf6-6973-5d23-a051-ab9367803be3 - methods: - - GET - name: petstore_getpet - paths: - - ~/pets/(?[^#?/]+)$ - plugins: [] - regex_priority: 100 - strip_path: false - tags: [] - - id: 7f1a9c95-7df0-5a54-8619-a59ace7f5604 - methods: - - PUT - name: petstore_updatepet - paths: - - ~/pets/(?[^#?/]+)$ - plugins: [] - regex_priority: 100 - strip_path: false - tags: [] - tags: [] upstreams: [] diff --git a/petStore-Postman-collection.json b/petStore-Postman-collection.json index 517093a..07c8226 100644 --- a/petStore-Postman-collection.json +++ b/petStore-Postman-collection.json @@ -1,1111 +1,1039 @@ { - "item": [ + "item": [ + { + "name": "pets", + "description": "", + "item": [ { - "name": "pets", - "description": "", - "item": [ + "id": "50871564-5290-4cce-976e-32461e2a28f1", + "name": "list Pets", + "request": { + "name": "list Pets", + "description": { + "content": "Lists all pets in the PetStore", + "type": "text/plain" + }, + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "50871564-5290-4cce-976e-32461e2a28f1", - "name": "list Pets", - "request": { - "name": "list Pets", - "description": { - "content": "Lists all pets in the PetStore", + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "c828bdbd-2410-4436-b99a-f0eed6cf4c03", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "ListPetsHeaders", + "value": "TrackingId,,Date,,link," + } + ], + "body": "{\n \"items\": [\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b84571c-6ac9-4012-8f5d-65bec047e249", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be9fd090-a87d-40f0-95e7-78e31337a68f", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "disabled": false, + "description": { + "content": "Maximum number of items to return", + "type": "text/plain" + }, + "key": "max", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorting order", + "type": "text/plain" + }, + "key": "order", + "value": "asc" + }, + { + "disabled": false, + "description": { + "content": "offset id to get next page", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ce45d782-678e-4632-9e82-0624738bde5e", + "name": "create Pet", + "request": { + "name": "create Pet", + "description": { + "content": "Create a new pet with its adorable name", + "type": "text/plain" + }, + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "848581ec-c2f6-4615-b52b-bef9c736b79d", + "name": "Created", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e436c76c-b21a-45b1-84b4-f27ad8491542", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a82f721-cb48-42a7-acdd-3cef1c91dfdf", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "0c9d26fd-3848-4cc9-a803-83044d350d05", + "name": "get Pet", + "request": { + "name": "get Pet", + "description": { + "content": "Get a pet by its id", + "type": "text/plain" + }, + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "990de3d1-7ed3-4431-b85c-e0c82d9f287d", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", "type": "text/plain" - }, - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] + }, + "key": "api_key", + "value": "" } + ], + "variable": [] }, - "response": [ - { - "id": "c828bdbd-2410-4436-b99a-f0eed6cf4c03", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "ListPetsHeaders", - "value": "TrackingId,,Date,,link," - } - ], - "body": "{\n \"items\": [\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8b84571c-6ac9-4012-8f5d-65bec047e249", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "ListPetsHeaders", + "value": "TrackingId,,Date,,link," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a00b7622-0035-4239-a84d-5ead0bc6ec05", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "be9fd090-a87d-40f0-95e7-78e31337a68f", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "Maximum number of items to return", - "type": "text/plain" - }, - "key": "max", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Sorting order", - "type": "text/plain" - }, - "key": "order", - "value": "asc" - }, - { - "disabled": false, - "description": { - "content": "offset id to get next page", - "type": "text/plain" - }, - "key": "offset", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" }, { - "id": "ce45d782-678e-4632-9e82-0624738bde5e", - "name": "create Pet", - "request": { - "name": "create Pet", - "description": { - "content": "Create a new pet with its adorable name", + "id": "fb6a7472-5f05-43b4-9fb9-586bf59431ad", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", "type": "text/plain" - }, - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] + }, + "key": "api_key", + "value": "" } + ], + "variable": [] }, - "response": [ - { - "id": "848581ec-c2f6-4615-b52b-bef9c736b79d", - "name": "Created", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Created", - "code": 201, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e436c76c-b21a-45b1-84b4-f27ad8491542", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "38f9c9ed-0795-4d2f-9ad5-b47bc62b2f50", + "name": "update Pet", + "request": { + "name": "update Pet", + "description": { + "content": "Update the pet information by its id", + "type": "text/plain" + }, + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "api_key" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "query" + } + ] + } + }, + "response": [ + { + "id": "78b1c573-2a73-42c8-9fb3-d9f3be1897d3", + "name": "OK", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "4a82f721-cb48-42a7-acdd-3cef1c91dfdf", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"species\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" }, { - "name": "{id}", - "description": "", - "item": [ + "id": "1aed5391-e647-41d9-9a7d-c071a7b303ec", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "0c9d26fd-3848-4cc9-a803-83044d350d05", - "name": "get Pet", - "request": { - "name": "get Pet", - "description": { - "content": "Get a pet by its id", - "type": "text/plain" - }, - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "id", - "disabled": false - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "990de3d1-7ed3-4431-b85c-e0c82d9f287d", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "ListPetsHeaders", - "value": "TrackingId,,Date,,link," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "a00b7622-0035-4239-a84d-5ead0bc6ec05", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fb6a7472-5f05-43b4-9fb9-586bf59431ad", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcec4fc4-4918-4e1e-874d-c124f82ecb71", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": ["pets", ":id"], + "host": ["{{baseUrl}}"], + "query": [ { - "id": "38f9c9ed-0795-4d2f-9ad5-b47bc62b2f50", - "name": "update Pet", - "request": { - "name": "update Pet", - "description": { - "content": "Update the pet information by its id", - "type": "text/plain" - }, - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "id", - "disabled": false - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "api_key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "78b1c573-2a73-42c8-9fb3-d9f3be1897d3", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"name\": \"\",\n \"species\": \"\",\n \"id\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1aed5391-e647-41d9-9a7d-c071a7b303ec", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "bcec4fc4-4918-4e1e-874d-c124f82ecb71", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "pets", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "api_key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "disabled": false, - "description": { - "content": "Common Headers Returned", - "type": "text/plain" - }, - "key": "CommonResponseHeader", - "value": "TrackingId,,Date," - } - ], - "body": "{\n \"message\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "api_key", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Common Headers Returned", + "type": "text/plain" + }, + "key": "CommonResponseHeader", + "value": "TrackingId,,Date," + } + ], + "body": "{\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" } - ] - } - ], - "event": [], - "variable": [ - { - "key": "baseUrl", - "value": "http://localhost:3000/v1" - } - ], - "info": { - "_postman_id": "8cb3e43f-23cf-4d45-a918-c70732e1945f", - "name": "Imported from OpenAPI", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "description": { - "content": "This is the API for the Pet Store.\n\nContact Support:\n Name: Dan Tolbert: dantolbe@cisco.com", - "type": "text/plain" + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] } + ] + } + ], + "event": [], + "variable": [ + { + "key": "baseUrl", + "value": "http://localhost:3000/v1" + } + ], + "info": { + "_postman_id": "8cb3e43f-23cf-4d45-a918-c70732e1945f", + "name": "Imported from OpenAPI", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "This is the API for the Pet Store.\n\nContact Support:\n Name: Dan Tolbert: dantolbe@cisco.com", + "type": "text/plain" } -} \ No newline at end of file + } +}