20 |
7 |
38 | `;
39 |
--------------------------------------------------------------------------------
/styles/config/_pm-icons.css:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: 'pm icons';
3 | src: url('../fonts/pm-icons.eot');
4 | src: url('../fonts/pm-icons.eot?#iefix') format('embedded-opentype'), url('../fonts/pm-icons.woff') format('woff'), url('../fonts/pm-icons.ttf') format('truetype'), url('../fonts/pm-icons.svg#pm-icons') format('svg');
5 | font-weight: normal;
6 | font-style: normal;
7 | font-display: swap;
8 | }
9 |
10 | [class*='pm-icon-']:before {
11 | display: inline-block;
12 | font-family: 'pm icons';
13 | font-style: normal;
14 | font-weight: normal;
15 | line-height: 1;
16 | -webkit-font-smoothing: antialiased;
17 | -moz-osx-font-smoothing: grayscale;
18 | }
19 |
20 | .pm-icon-chevron-down:before {
21 | content: '\e905';
22 | }
23 | .pm-icon-chevron-left:before {
24 | content: '\e906';
25 | }
26 | .pm-icon-chevron-right:before {
27 | content: '\e907';
28 | }
29 | .pm-icon-chevron-up:before {
30 | content: '\e908';
31 | }
--------------------------------------------------------------------------------
/src/components/Shared/DynamicLink.spec.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import renderer from 'react-test-renderer';
3 | import DynamicLink from './DynamicLink';
4 |
5 | describe('DynamicLink', () => {
6 | it('should have a class of dynamic-link__external for external links', () => {
7 | const tree = renderer
8 | .create(
10 | Prerequisites
11 |
12 |
15 |
19 | Download and Install
20 |
21 |
22 |
25 | Blog Posts
26 |
27 |
30 |
34 | home
35 |
36 |
37 |
11 |
22 |
12 |
21 |
13 |
15 |
16 |
20 | 404
17 |Oops! We can't find this page. It may have been moved or deleted.
18 | Back to Docs 19 |35 | 36 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 37 | -------------------------------------------------------------------------------- /src/pages/reference/cookie-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Cookie list" 3 | order: 1 4 | page_id: "cookie-list" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | The cookie list is an array of SSL [cookies](/reference/cookie/). 19 | 20 | #### Schema 21 | 22 | ```json 23 | { 24 | "$id": "#/definitions/cookie-list", 25 | "title": "Certificate List", 26 | "description": "A representation of a list of cookies", 27 | "type": "array", 28 | "items": { 29 | "$ref": "#/definitions/cookie" 30 | } 31 | } 32 | ``` 33 | 34 |
35 | 36 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 37 | -------------------------------------------------------------------------------- /src/components/ContextualLinks/ContextualLinks.spec.jsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import renderer from 'react-test-renderer'; 3 | import ContextualLinks from './ContextualLinks'; 4 | import Theme from '../../../styles/theme.jsx'; 5 | 6 | 7 | describe('ContextualLinks', () => { 8 | it('renders correctly', () => { 9 | const testLinks = [ 10 | { 11 | type: 'section', 12 | name: 'Prerequisites', 13 | }, 14 | { 15 | type: 'link', 16 | name: 'Download and Install', 17 | url: 'https://www.postman.com/downloads/', 18 | }, 19 | { 20 | type: 'subtitle', 21 | name: 'Blog Posts', 22 | 23 | }, 24 | { 25 | type: 'link', 26 | name: 'home', 27 | url: '/', 28 | }, 29 | ]; 30 | 31 | const tree = renderer 32 | .create(
21 | 22 | #### Schema 23 | 24 | ```json 25 | { 26 | "$id": "#/definitions/certificate-list", 27 | "title": "Certificate List", 28 | "description": "A representation of a list of SSL certificates", 29 | "type": "array", 30 | "items": { 31 | "$ref": "#/definitions/certificate" 32 | } 33 | } 34 | ``` 35 | 36 |
37 | 38 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 39 | -------------------------------------------------------------------------------- /_vale.ini: -------------------------------------------------------------------------------- 1 | StylesPath = vale-styles 2 | Vocab = LC 3 | MinAlertLevel = suggestion 4 | 5 | [*.md] 6 | 7 | BasedOnStyles = Postman, Microsoft, write-good 8 | 9 | # Turn off these rules. See TW-357 (and others) for a discussion on this. 10 | Microsoft.GeneralURL = NO 11 | Microsoft.HeadingAcronyms = NO 12 | Microsoft.Auto = NO 13 | Microsoft.Acronyms = NO 14 | Microsoft.Wordiness = NO # Postman.TooWordy, which was based on WriteGood, is better. 15 | write-good.ThereIs = NO 16 | write-good.E-Prime = NO 17 | write-good.Passive = NO # This is redundant with Microsoft.passive 18 | Microsoft.Passive = NO 19 | Microsoft.Vocab = NO 20 | 21 | # These rules are replaced by a Postman-customized version 22 | Microsoft.ComplexWords = NO 23 | write-good.TooWordy = NO 24 | write-good.Weasel = NO 25 | Microsoft.We = NO 26 | Microsoft.Adverbs = NO # Postman.Weasel now has every unique word from this added to it. 27 | Microsoft.Terms = NO 28 | Microsoft.Avoid = NO 29 | 30 | # Things we don't want for the LC anymore 31 | Postman.TooWordy = NO # Postman.ComplexWords covers most of this, but with substitution suggestions. 32 | Postman.Readability = NO # This suddenly started throwing errors on 11/17/22 -------------------------------------------------------------------------------- /src/pages/reference/protocol-profile-behavior.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Protocol profile behavior" 3 | order: 1 4 | page_id: "protocol-profile-behavior" 5 | warning: false 6 | updated: 2023-01-17 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | This set of configuration is used to change the behavior of sending the request. 19 | 20 | #### Schema 21 | 22 | ```json 23 | { 24 | "$schema": "http://json-schema.org/draft-07/schema#", 25 | "type": "object", 26 | "title": "Protocol Profile Behavior", 27 | "$id": "#/definitions/protocol-profile-behavior", 28 | "description": "Set of configurations used to alter the usual behavior of sending the request" 29 | } 30 | ``` 31 | 32 |
33 | 34 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 35 | -------------------------------------------------------------------------------- /vale-styles/Postman/Terms.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | level: warning 4 | ignorecase: true 5 | action: 6 | name: replace 7 | swap: 8 | '(?:drive C:|drive C>|C: drive)': drive C 9 | '(?:internet bot|web robot)s?': bot(s) 10 | '(?:mobile|smart) ?phone': phone 11 | '24/7': every day 12 | 'audio(?:-| )book': audiobook 13 | 'back(?:-| )light': backlight 14 | 'chat ?bots?': chatbot(s) 15 | adaptor: adapter 16 | administrate: administer 17 | afterwards: afterward 18 | alphabetic: alphabetical 19 | alphanumerical: alphanumeric 20 | anti-aliasing: antialiasing 21 | anti-malware: antimalware 22 | anti-spyware: antispyware 23 | anti-virus: antivirus 24 | appendixes: appendices 25 | artificial intelligence: artificial intelligence 26 | assembler: assembly language 27 | bpp: bpp 28 | bps: bps 29 | caap: CaaP 30 | conversation-as-a-platform: conversation as a platform 31 | click: select 32 | hit: select 33 | eb: EB 34 | gb: GB 35 | gbps: Gbps 36 | kb: KB 37 | keypress: keystroke 38 | mb: MB 39 | pb: PB 40 | tb: TB 41 | zb: ZB 42 | viz: namely 43 | ergo: therefore 44 | entity: element 45 | trash icon: trash 46 | trash can: trash 47 | -------------------------------------------------------------------------------- /src/pages/reference/event-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Event list" 3 | order: 1 4 | page_id: "certificate" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | The event list is an array of [events](/reference/event/). 19 | 20 | #### Schema 21 | 22 | ```json 23 | { 24 | "$id": "#/definitions/event-list", 25 | "title": "Event List", 26 | "type": "array", 27 | "$schema": "http://json-schema.org/draft-07/schema#", 28 | "description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.", 29 | "items": { 30 | "$ref": "#/definitions/event" 31 | } 32 | } 33 | ``` 34 | 35 |
36 | 37 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 38 | -------------------------------------------------------------------------------- /.github/workflows/manual-rerun.yml: -------------------------------------------------------------------------------- 1 | 2 | name: manually re-running actions 3 | 4 | on: repository_dispatch 5 | 6 | jobs: 7 | manual_deploy: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v1 11 | - uses: actions/setup-node@master 12 | with: 13 | node-version: '18.20.5' 14 | - name: lint all markdownfiles 15 | env: 16 | PM_TECH_RT: ${{secrets.PM_TECH_RT}} 17 | run: | 18 | npm config set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}} 19 | npm run npm 20 | node_modules/.bin/markdownlint ./ --ignore node_modules 21 | - name: check for image url 22 | run: | 23 | if grep -lri 's3.amazonaws.com/postman-static-getpostman-com' ./src/pages/docs ; 24 | then echo "Invalid s3 references found. Please use format 'https://assets.postman.com/postman-docs/[filename-in-s3]'"; 25 | exit 1; 26 | else echo "no s3 references found"; 27 | fi 28 | - name: running unit tests 29 | env: 30 | PM_TECH_RT: ${{secrets.PM_TECH_RT}} 31 | run: | 32 | npm config set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}} 33 | npm run npm 34 | npm run clean 35 | npm run test:update 36 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - develop 7 | 8 | jobs: 9 | build: 10 | 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - uses: actions/checkout@v1 15 | - uses: actions/setup-node@master 16 | with: 17 | node-version: '18.20.5' 18 | - name: lint all markdownfiles 19 | env: 20 | PM_TECH_RT: ${{secrets.PM_TECH_RT}} 21 | run: | 22 | npm config set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}} 23 | npm run npm 24 | node_modules/.bin/markdownlint ./ --ignore node_modules --fix 25 | - name: check for image url 26 | run: | 27 | if grep -lri 's3.amazonaws.com/postman-static-getpostman-com' ./src/pages/docs ; 28 | then echo "Invalid s3 references found. Please use format 'https://assets.postman.com/postman-docs/[filename-in-s3]'"; 29 | exit 1; 30 | else echo "no s3 references found"; 31 | fi 32 | - name: running unit tests 33 | env: 34 | PM_TECH_RT: ${{secrets.PM_TECH_RT}} 35 | run: | 36 | npm config set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}} 37 | npm run npm 38 | npm run clean 39 | npm run test:update 40 | 41 | -------------------------------------------------------------------------------- /src/components/Shared/Button.jsx: -------------------------------------------------------------------------------- 1 | import styled from 'styled-components'; 2 | import {theme} from '../../../styles/theme'; 3 | 4 | const Button = styled.button` 5 | align-items: center; 6 | appearance: none; 7 | border: 1px solid transparent; 8 | border-radius: 4px; 9 | cursor: pointer; 10 | display: inline-block; 11 | font-size: 16px; 12 | font-weight: 600; 13 | line-height: 1.5; 14 | padding: 8px 16px; 15 | margin: 0 16px 0 0; 16 | user-select: none; 17 | transition: all 0.2s ease-in-out; 18 | text-align: center; 19 | 20 | &:hover, 21 | &:active { 22 | text-decoration: none; 23 | } 24 | 25 | &:focus { 26 | outline: none; 27 | } 28 | 29 | &:disabled, 30 | &.isDisabled { 31 | color: #EDEDED; 32 | cursor: not-allowed; 33 | background-image: none !important; 34 | background: #EDEDED; 35 | border-color: transparent; 36 | } 37 | 38 | &.secondary { 39 | border: 1px solid ${theme.colors.grey_40}; 40 | color: ${theme.colors.grey_60} !important; 41 | background-color: transparent; 42 | &:hover, 43 | &:active { 44 | border: 1px solid ${theme.colors.grey_60}; 45 | } 46 | } 47 | ` 48 | 49 | export default Button; -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug report 2 | description: Report typos, broken links, or other documentation errors 3 | title: 'Marketing Template Doc bug report' 4 | labels: ["bug"] 5 | assignees: 6 | - Gbahdeyboh 7 | body: 8 | - type: checkboxes 9 | attributes: 10 | label: Is this an issue with the Marketing Template Doc documentation? 11 | description: This isn't a general support repo. For app support issues, please open an issue at [Postman App Support issues](https://github.com/postmanlabs/postman-app-support/issues). 12 | options: 13 | - label: This is an issue with Marketing Template Doc documentation. 14 | required: true 15 | - type: textarea 16 | attributes: 17 | label: Describe the issue 18 | description: | 19 | A clear and concise description of what the bug is. 20 | validations: 21 | required: true 22 | - type: textarea 23 | attributes: 24 | label: Pages affected 25 | description: | 26 | If possible, list URLs of pages where the error occurs. 27 | - type: textarea 28 | attributes: 29 | label: Screenshots 30 | description: | 31 | If applicable, add screenshots to help explain the issue. 32 | - type: textarea 33 | attributes: 34 | label: Additional context 35 | description: | 36 | Add any other context about the problem here. 37 | -------------------------------------------------------------------------------- /src/pages/reference/variable-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Variable list" 3 | order: 1 4 | page_id: "variable-list" 5 | warning: false 6 | updated: 2023-01-17 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | A variable list is an array of [variables](/reference/variable). 19 | 20 | #### Schema 21 | 22 | ```json 23 | { 24 | "$schema": "http://json-schema.org/draft-07/schema#", 25 | "$id": "#/definitions/variable-list", 26 | "title": "Variable List", 27 | "description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*", 28 | "type": "array", 29 | "items": { 30 | "$ref": "#/definitions/variable" 31 | } 32 | } 33 | ``` 34 | 35 |
36 | 37 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 38 | -------------------------------------------------------------------------------- /vale-styles/Postman/BrandedTerm.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "%s is a Postman branded term. Don't use '%s'." 3 | level: error 4 | ignorecase: false 5 | action: 6 | name: replace 7 | # swap maps tokens in form of bad: good 8 | swap: 9 | '(?:autoflex|auto-flex)': Auto-Flex 10 | # Postman - too many false positives 11 | Postman agent: Postman Agent 12 | cloud agent: Postman Cloud Agent 13 | desktop agent: Postman Desktop Agent 14 | API builder: API Builder 15 | bootcamp: Postman Bootcamp 16 | newman: Newman 17 | #'(?:collection runner|Collection runner)': Collection Runner - generates too many false positives 18 | # x: Postman Echo - not used 19 | # x: Postman Team plan - not used 20 | # x: Postman Business plan - not used 21 | # x: Postman Enterprise plan - not used 22 | Postman interceptor: Postman Interceptor 23 | '(?:Postman bridge|interceptor bridge)': Interceptor Bridge 24 | Postman console: Postman Console 25 | '(?:learning center|Learning center)': Postman Learning Center 26 | Postman dashboard: Postman Dashboard 27 | '(?:Postman visualizer|visualizer)': Postman Visualizer 28 | Postman API network: Postman API Network 29 | # x: Postman Templates - not used anymore 30 | Postman collection: Postman Collection 31 | launchpad: Launchpad 32 | '(?:trust center|Trust center)': Trust Center 33 | Workbench: workbench 34 | Postman enterprise: Postman Enterprise -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |  2 | 3 | # Postman Collection Format 4 | 5 | The collection format is the specification behind [Postman Collections](https://www.postman.com/collection/), it lets you model API workflows and organize requests. The documentation helps you understand the format, how it relates to collections in Postman and the different toolings that have been built around the format both by Postman and it's developer community. 6 | 7 | ## Contribution guidelines 8 | 9 | We would love for you to contribute to the Collection Format Docs! To contribute to this project, please read: 10 | 11 | - The [Code of Conduct](https://www.postman.com/code-of-conduct) 12 | - The [Contribution Guidelines](https://github.com/postmanlabs/collection-format-docs/blob/develop/CONTRIBUTING.md) 13 | - The [Documentation Style Guide](https://github.com/postmanlabs/collection-format-docs/blob/develop/DOCS_STYLE_GUIDE.md) 14 | 15 | ## Tech stack 16 | 17 | The Docs are built using ReactJS, GatsbyJS Framework, and styled components for styling. 18 | 19 | ## How to get started 20 | 21 | ``` 22 | $ git clone https://github.com/postmanlabs/collection-format-docs 23 | $ collection-format-docs 24 | $ npm run nvmrc 25 | $ nvm use 26 | $ npm install 27 | $ npm install -g gatsby-cli 28 | $ npm run dev 29 | ``` 30 | 31 | ## License 32 | 33 | [Apache License 2.0](https://github.com/postmanlabs/collection-format-docs/blob/develop/LICENSE) 34 | -------------------------------------------------------------------------------- /src/images/logo-flip-home.svg: -------------------------------------------------------------------------------- 1 | 5 | -------------------------------------------------------------------------------- /src/utils/removePrefixFromCurrentPath.js: -------------------------------------------------------------------------------- 1 | import { useStaticQuery, graphql } from "gatsby"; 2 | 3 | const removePrefixFromCurrentPath = () => { 4 | const queryData = useStaticQuery(graphql` 5 | query { 6 | site { 7 | siteMetadata { 8 | pathPrefix 9 | } 10 | } 11 | } 12 | `) 13 | 14 | const { pathPrefix } = queryData.site.siteMetadata; 15 | if (typeof document === 'object') { 16 | let location = document.location.pathname; 17 | // The logic below is to make leftNavItems and breadcrumbs work 18 | // Because the pathPrefix ( ex "/template/") gets prefixed AT BUILD TIME, in the LeftNavItems array. 19 | // So the array of objects in leftNavItems, DO NOT HAVE THE PATH PREFIX. 20 | // Since they do not, when the app is in production, the breadcrumbs / lav nav break (ex. /template/route/ is not equal to /route/) 21 | // In other words, our codebase below isn't aware of pathPrefix (ex "/template/") being in the location bar of the browser 22 | // The prefixPath at build breaks the comparisons further down in this componentDidMount block., 23 | // so we .replace it from the strings we are comparing against LeftNavItems. 24 | 25 | location = location.replace(`${pathPrefix}/`, "/"); 26 | // Notice we are not setting location to any href value, we are only using it for the sake of comparing 27 | return location; 28 | } 29 | } 30 | 31 | export default removePrefixFromCurrentPath; 32 | 33 | -------------------------------------------------------------------------------- /__mocks__/gatsby.js: -------------------------------------------------------------------------------- 1 | const React = require('react'); 2 | 3 | const gatsby = jest.requireActual('gatsby'); 4 | 5 | module.exports = { 6 | ...gatsby, 7 | graphql: jest.fn(), 8 | Link: jest.fn().mockImplementation( 9 | // these props are invalid for an `a` tag 10 | ({ 11 | activeClassName, 12 | activeStyle, 13 | getProps, 14 | innerRef, 15 | partiallyActive, 16 | ref, 17 | replace, 18 | to, 19 | ...rest 20 | }) => React.createElement('a', { 21 | ...rest, 22 | href: to, 23 | }), 24 | ), 25 | StaticQuery: jest.fn(), 26 | useStaticQuery: jest.fn().mockImplementation(() => ({ 27 | allMarkdownRemark: { 28 | nodes: [{ 29 | fields: { 30 | slug: '/docs/foo/slug/', 31 | }, 32 | frontmatter: { 33 | title: 'slug', 34 | }, 35 | id: 'jfkdlsajfkldsa', 36 | }, 37 | { 38 | fields: { 39 | slug: '/docs/foo/nested/nestedslug/', 40 | }, 41 | frontmatter: { 42 | title: 'nested slug', 43 | }, 44 | id: 'jfkdlsajfkldsfa', 45 | }, 46 | { 47 | fields: { 48 | slug: '/docs/bar/otherslug/', 49 | }, 50 | frontmatter: { 51 | title: 'otherslug', 52 | }, 53 | id: 'jfkdlsajfkldsfa', 54 | }, 55 | ], 56 | }, 57 | leftNavLinks: { 58 | value: '{"docs":{"foo":{"slug":{"url":"/docs/foo/slug/"},"nested":{"nestedslug":{"url":"/docs/foo/nested/nestedslug/"}}},"bar":{"otherslug":{"url":"/docs/bar/otherslug/"}}}}', 59 | }, 60 | })), 61 | }; 62 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # dotenv environment variables file 55 | .env 56 | 57 | # gatsby files 58 | .cache/ 59 | public 60 | 61 | # Mac files 62 | .DS_Store 63 | 64 | # Yarn 65 | yarn-error.log 66 | .pnp/ 67 | .pnp.js 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # Environments 72 | .env.development 73 | .env.production 74 | 75 | # Jekyll 76 | .jekyll-metadata 77 | _site/ 78 | 79 | 80 | auth.json 81 | 82 | # Ignore temporary bff data used for build 83 | bff-data/ 84 | 85 | # Generated 86 | .nvmrc 87 | bff.json 88 | 89 | # Vale styles 90 | vale-styles/Microsoft 91 | vale-styles/write-good 92 | 93 | .vscode/* 94 | !.vscode/launch.json -------------------------------------------------------------------------------- /src/pages/advanced-concepts/extending-collections.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Extending collections" 3 | order: 1 4 | page_id: "extending-collections" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | Collections consist of multiple sub-structural parts called units. Each unit defines a certain part of your API. 19 | 20 | Extensions allow you to extend these units and provide meta information, along with any other desired fields or data. Extensions are user-defined and you can place them anywhere in a collection. They include a preceding underscore (_) and can contain any data type such as strings, objects, integers, and others. 21 | 22 | The following example shows a cookie being added to a request object using an extension: 23 | 24 | ```json 25 | { 26 | "request": { 27 | "url": "https://postman-echo.com/get", 28 | "method": "GET", 29 | "headers": [], 30 | "_cookies": "sails.sid=s%3AniBCE5lER3oAaOHz8cALlkPTkFx4RT9p.XfGCKnUJ87PJjtupGSxfLwddXaFoAN2ADKk%2BM5c1RPU; Path=/; HttpOnly" 31 | } 32 | } 33 | ``` 34 | 35 | Because extensions can be used anywhere in a collection, there is no limit to how they can be used to store or retrieve data. 36 | 37 | > Extensions can be given any name, but extensions starting with `_postman` are reserved. 38 | -------------------------------------------------------------------------------- /static/mock/show-mock.drawio: -------------------------------------------------------------------------------- 1 |
35 | 36 | #### Reference diagram 37 | 38 |  39 | 40 |
41 | 42 | #### Schema 43 | 44 | ```json 45 | { 46 | "type": "object", 47 | "title": "Auth", 48 | "$id": "#/definitions/auth-attribute", 49 | "description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.", 50 | "properties": { 51 | "key": { 52 | "type": "string" 53 | }, 54 | "value": {}, 55 | "type": { 56 | "type": "string" 57 | } 58 | }, 59 | "required": [ 60 | "key" 61 | ] 62 | } 63 | ``` 64 | 65 |
66 | 67 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 68 | -------------------------------------------------------------------------------- /src/components/modules/Modal.js: -------------------------------------------------------------------------------- 1 | /* Used on doc.jsx */ 2 | export function useModal(parsedHtml, e) { 3 | let images = parsedHtml.querySelectorAll('img'); 4 | for (let i = 0; i < images.length; i++) { 5 | /* Assign a unique ID for each modal */ 6 | const create_id = `docs-${Math.random().toString(36).slice(8)}` 7 | /* Check if image has a parent element with href */ 8 | const imgHasDefinedHref = images[i].src === images[i].parentNode.href 9 | /* Check if image does not have parent element with href */ 10 | const imgHasUndefinedHref = images[i].parentNode.href === undefined; 11 | if (imgHasDefinedHref || imgHasUndefinedHref) { 12 | images[i].parentNode.href = images[i].parentNode.href; 13 | images[i].outerHTML = Modal(create_id, images, i); 14 | const parser = new DOMParser(); 15 | parser.parseFromString(images[i].outerHTML, 'text/html'); 16 | } 17 | } 18 | } 19 | function Modal (create_id, images, i) { 20 | return ( 21 | ` 22 | ${images[i].width === 0 ? ( 23 | `
28 |
56 |
29 |
55 |
30 |
52 | ![${images[i].alt || ''}](${images[i].src)
53 |
54 | 27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [key](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/header.json#L7) | `string` | `true` | The LHS of the HTTP header. For example, `Content-Type` or `X-Custom-Header`. 33 | [value](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/header.json#L11) | `string` | `true` | The value or RHS of the header. 34 | [disabled](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/header.json#L7) | `boolean` | `false` | If set to `true`, the current header won't be sent with requests. 35 | [description](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/header.json#LL20C6-L20C17) | [#description](/reference/description/) | `false` | The description of this header. 36 | 37 |
38 | 39 | #### Reference diagram 40 | 41 |  42 | 43 |
44 | 45 | #### Schema 46 | 47 | ```json 48 | { 49 | "type": "object", 50 | "title": "Header", 51 | "$id": "#/definitions/header", 52 | "description": "Represents a single HTTP Header", 53 | "properties": { 54 | "key": { 55 | "description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``", 56 | "type": "string" 57 | }, 58 | "value": { 59 | "type": "string", 60 | "description": "The value (or the RHS) of the Header is stored in this field." 61 | }, 62 | "disabled": { 63 | "type": "boolean", 64 | "default": false, 65 | "description": "If set to true, the current header will not be sent with requests." 66 | }, 67 | "description": { 68 | "$ref": "#/definitions/description" 69 | } 70 | }, 71 | "required": [ 72 | "key", 73 | "value" 74 | ] 75 | } 76 | ``` 77 | 78 |
79 | 80 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 81 | -------------------------------------------------------------------------------- /src/pages/reference/event.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Event" 3 | order: 1 4 | page_id: "event" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | Events let you define a script that runs when certain events are fired. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/event.json#L8) | `string` | `false` | A unique identifier for the enclosing event. 33 | [listen](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/event.json#L12) | `string` | `true` | Set to `test` for test scripts or `prerequest` for pre-request scripts. 34 | [script](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/event.json#L16) | [#script](/reference/script/) | `false` | Contains the test or pre-request script to be executed. 35 | [disabled](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/event.json#L19) | `boolean` | `false` | Indicates whether the event is active. If absent, the event is enabled. 36 | 37 |
38 | 39 | #### Reference diagram 40 | 41 |  42 | 43 |
44 | 45 | #### Schema 46 | 47 | ```json 48 | { 49 | "$schema": "http://json-schema.org/draft-07/schema#", 50 | "$id": "#/definitions/event", 51 | "title": "Event", 52 | "description": "Defines a script associated with an associated event name", 53 | "type": "object", 54 | "properties": { 55 | "id": { 56 | "type": "string", 57 | "description": "A unique identifier for the enclosing event." 58 | }, 59 | "listen": { 60 | "type": "string", 61 | "description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively." 62 | }, 63 | "script": { 64 | "$ref": "#/definitions/script" 65 | }, 66 | "disabled": { 67 | "type": "boolean", 68 | "default": false, 69 | "description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled." 70 | } 71 | }, 72 | "required": [ 73 | "listen" 74 | ] 75 | } 76 | ``` 77 | 78 |
79 | 80 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 81 | -------------------------------------------------------------------------------- /src/pages/reference/description.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Description" 3 | order: 1 4 | page_id: "description" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | Descriptions can be raw text or an object that holds the description content along with its format. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | -- 32 | [content](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/description.json#L10) | `string` | `false` | The content of the description as a raw string. 33 | [type](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/description.json#L14) | `string` | `false` | The MIME type of the raw description content. For example, `text/markdown` or `text/html`. The type is used to correctly render the description when generating documentation in the Postman app. 34 | [version](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/description.json#LL18C10-L18C17) | `string` | `false` | Versions associated with this description. 35 | 36 |
37 | 38 | #### Reference diagram 39 | 40 |  41 | 42 |
43 | 44 | #### Schema 45 | 46 | ```json 47 | { 48 | "$schema": "http://json-schema.org/draft-07/schema#", 49 | "$id": "#/definitions/description", 50 | "description": "A Description can be a raw text, or be an object, which holds the description along with its format.", 51 | "oneOf": [ 52 | { 53 | "type": "object", 54 | "title": "Description", 55 | "properties": { 56 | "content": { 57 | "type": "string", 58 | "description": "The content of the description goes here, as a raw string." 59 | }, 60 | "type": { 61 | "type": "string", 62 | "description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app." 63 | }, 64 | "version": { 65 | "description": "Description can have versions associated with it, which should be put in this property." 66 | } 67 | } 68 | }, 69 | { 70 | "type": "string" 71 | }, 72 | { 73 | "type": "null" 74 | } 75 | ] 76 | } 77 | ``` 78 | 79 |
80 | 81 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 82 | -------------------------------------------------------------------------------- /src/components/layout.jsx: -------------------------------------------------------------------------------- 1 | /** 2 | * Layout component that queries for data 3 | * with Gatsby's useStaticQuery component 4 | * 5 | * See: https://www.gatsbyjs.org/docs/use-static-query/ 6 | */ 7 | 8 | import React from 'react'; 9 | import Header from './Header/Header'; 10 | import Footer from './Footer/Footer'; 11 | import marketo from '../../build/marketo.munchkin'; 12 | import '../../styles/config/normalize.css'; 13 | import GlobalStyle from '../../styles/globalStyle'; 14 | import Theme from '../../styles/theme.jsx'; 15 | 16 | const getCookie = (name) => { 17 | const value = `; ${document.cookie}`; 18 | const parts = value.split(`; ${name}=`); 19 | if (parts.length === 2) { 20 | return parts 21 | .pop() 22 | .split(';') 23 | .shift(); 24 | } 25 | return undefined; 26 | }; 27 | 28 | const parseQuery = (query) => { 29 | const pairs = query.slice(1).split('&'); 30 | const result = {}; 31 | pairs.forEach((pair) => { 32 | const items = pair.split('='); 33 | result[items[0]] = decodeURIComponent(items[1] || ''); 34 | }); 35 | return result; 36 | }; 37 | 38 | const setGclidCookie = () => { 39 | const { search } = window.location; 40 | const queries = parseQuery(search); 41 | if (queries.gclid) { 42 | const now = new Date(); 43 | const timeStamp = now.setDate(now.getDate() + 30); 44 | const expiration = new Date(timeStamp).toUTCString(); 45 | document.cookie = 'gclid=; expires=Thu, 01 Jan 1970 00:00:00 UTC;path=/;secure'; 46 | document.cookie = `gclid=${queries.gclid};expires=${expiration};path=/;secure;`; 47 | } 48 | }; 49 | 50 | const setReferrerCookie = () => { 51 | const referrerUrl = document.referrer !== '' ? document.referrer : 'null'; 52 | const now = new Date(); 53 | const timeStamp = now.setDate(now.getDate() + 30); 54 | const expiration = new Date(timeStamp).toUTCString(); 55 | const currentCookie = getCookie('referrer_url'); 56 | if (!referrerUrl.split('?')[0].includes('postman.com')) { 57 | if ( 58 | referrerUrl !== '' 59 | || currentCookie === 'null' 60 | || currentCookie === undefined 61 | ) { 62 | document.cookie = 'referrer_url=; expires=Thu, 01 Jan 1970 00:00:00 UTC;path=/;secure'; 63 | document.cookie = `referrer_url=${referrerUrl};expires=${expiration};path=/;secure;`; 64 | } 65 | } 66 | }; 67 | 68 | class Layout extends React.Component { 69 | constructor(props) { 70 | super(props); 71 | this.state = { ...props }; 72 | } 73 | 74 | componentDidMount() { 75 | if (typeof window !== 'undefined') { 76 | if (!window.location.hash) { 77 | window.scrollTo(0, 0); 78 | } else { 79 | window.location = window.location.hash; 80 | } 81 | } 82 | setReferrerCookie(); 83 | setGclidCookie(); 84 | } 85 | 86 | render() { 87 | const { children } = this.state; 88 | return ( 89 | <> 90 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [match](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/proxy-config.json#L8) | `string` | `false` | The URL match the proxy config is defined for. 33 | [host](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/proxy-config.json#L13) | `string` | `false` | The proxy server host. 34 | [port](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/proxy-config.json#L17) | `integer` | `false` | The proxy server port. 35 | [tunnel](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/proxy-config.json#L23) | `boolean` | `false` | The tunneling details for the proxy config. 36 | [disabled](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/proxy-config.json#L28) | `boolean` | `false` | When set to `true`, ignores this proxy configuration element. 37 | 38 |
39 | 40 | #### Reference diagram 41 | 42 |  43 | 44 |
45 | 46 | #### Schema 47 | 48 | ```json 49 | { 50 | "$schema": "http://json-schema.org/draft-07/schema#", 51 | "$id": "#/definitions/proxy-config", 52 | "title": "Proxy Config", 53 | "description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match", 54 | "type": "object", 55 | "properties": { 56 | "match": { 57 | "default": "http+https://*/*", 58 | "description": "The Url match for which the proxy config is defined", 59 | "type": "string" 60 | }, 61 | "host": { 62 | "type": "string", 63 | "description": "The proxy server host" 64 | }, 65 | "port": { 66 | "type": "integer", 67 | "minimum": 0, 68 | "default": 8080, 69 | "description": "The proxy server port" 70 | }, 71 | "tunnel": { 72 | "description": "The tunneling details for the proxy config", 73 | "default": false, 74 | "type": "boolean" 75 | }, 76 | "disabled": { 77 | "type": "boolean", 78 | "default": false, 79 | "description": "When set to true, ignores this proxy configuration entity" 80 | } 81 | } 82 | } 83 | ``` 84 | 85 |
86 | 87 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 88 | -------------------------------------------------------------------------------- /src/pages/getting-started/defining-a-simple-api.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Defining a simple API" 3 | order: 1 4 | page_id: "defining-a-simple-api" 5 | warning: false 6 | updated: 2022-12-07 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | ## Contents 19 | 20 | - [Basic API structure](#basic-api-structure) 21 | - [APIs with multiple requests](#defining-an-api-with-multiple-requests) 22 | - [Nesting folders](#nesting-folders) 23 | 24 | ## Basic API structure 25 | 26 | A collection has two mandatory units that must be provided when defining an API: `info` and `item`. 27 | 28 | The following is an API definition in its most basic form: 29 | 30 | ```json 31 | { 32 | "info": { 33 | "name": "My first collection", 34 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/" 35 | }, 36 | "item": { 37 | "name": "This is a request", 38 | "request": "http://myapi.com/api" 39 | } 40 | } 41 | ``` 42 | 43 | The request above is a URL and defaults to a `GET` request. For a more complete guide on working with the request object in collections, see [Request definition](/advanced-concepts/request-definition/). 44 | 45 | ## Defining an API with multiple requests 46 | 47 | You can define multiple requests in an API by using an item group, which can be represented as an array of items. 48 | 49 | The following example shows an API definition that includes multiple requests: 50 | 51 | ```json 52 | { 53 | "info": { 54 | "name": "My collection with multiple requests", 55 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/" 56 | }, 57 | "item": [ 58 | { 59 | "name": "This is request one", 60 | "request": "http://myapi.com/api/1" 61 | }, 62 | { 63 | "name": "This is request two", 64 | "request": "http://myapi.com/api/2" 65 | } 66 | ] 67 | } 68 | ``` 69 | 70 |
71 | 72 | ## Nesting folders 73 | 74 | Item groups, or folders, can be nested inside other folders. This way, you can further group related API requests together. Depending on your use case and how your API is structured, you can also create sub-groups for each of those API groups. 75 | 76 | The following example shows an API definition with nested requests: 77 | 78 | ```json 79 | { 80 | "info": { 81 | "name": "My collection with multiple requests", 82 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/" 83 | }, 84 | "item": [ 85 | { 86 | "item": [ 87 | { 88 | "name": "Request 1a", 89 | "request": "https://postman-echo.com/get", 90 | "description": "This request is in a Folder nested inside another folder" 91 | }, 92 | { 93 | "name": "Request 1b", 94 | "request": "https://postman-echo.com/get", 95 | "description": "This request is in a Folder nested inside another folder" 96 | } 97 | ] 98 | }, 99 | { 100 | "name": "Request 2", 101 | "request": "https://postman-echo.com/get", 102 | "description": "This request is in a single folder" 103 | } 104 | ] 105 | } 106 | ``` 107 | -------------------------------------------------------------------------------- /styles/theme.jsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import PropTypes from 'prop-types'; 3 | import { ThemeProvider } from 'styled-components'; 4 | 5 | export const theme = { 6 | colors: { 7 | // ************************************ STOP USING THESE 8 | // Main Colors 9 | 10 | // Oranges 11 | light_orange: '#F4815B', 12 | orange_40_50: 'rgba(249, 157, 120, 0.5)', 13 | orange_40_25: 'rgba(249, 157, 120, 0.25)', 14 | // Blues 15 | night_sky: '#2B3B41', 16 | blue_steel: '#6D7F91', 17 | light_blue: '#DBE9F2', 18 | lighter_blue: '#F5F8FB', 19 | // Purples 20 | dark_purple: '#493E5E', 21 | light_purple: '#665C80', 22 | bright_purple: '#7D728E', 23 | // Grays 24 | grey_5: '#979797', 25 | grey_4: '#E1E1E1', 26 | white: '#FFFFFF', 27 | black: '000000', 28 | // ************************************ END: STOP USING THESE 29 | 30 | // ************************************ USE THESE INSTEAD 31 | // ORANGE 32 | orange_90: '#553326', 33 | orange_80: '#A12700', 34 | orange_70: '#D23F0E', 35 | orange_60: '#E05320', 36 | orange_50: '#FF6C37', 37 | orange_40: '#FF8E64', 38 | orange_30: '#FFB091', 39 | orange_20: '#FFD1BE', 40 | orange_10: '#FFF1EB', 41 | // GREY 42 | grey_90: '#212121', 43 | grey_85: '#262626', 44 | grey_80: '#2B2B2B', 45 | grey_70: '#303030', 46 | grey_60: '#3B3B3B', 47 | grey_50: '#707070', 48 | grey_40: '#A6A6A6', 49 | grey_30: '#E6E6E6', 50 | grey_20: '#EDEDED', 51 | grey_10: '#F2F2F2', 52 | grey_05: '#F9F9F9', 53 | grey_00: '#FFFFFF', 54 | // BLUE 55 | blue_90: '#002D70', 56 | blue_80: '#00439D', 57 | blue_70: '#0053B8', 58 | blue_60: '#0265D2', 59 | blue_50: '#097BED', 60 | blue_40: '#3E92F2', 61 | blue_30: '#74AEF6', 62 | blue_20: '#ADCDFB', 63 | blue_10: '#E7F0FF', 64 | // YELLOW 65 | yellow_80: '#523A03', 66 | yellow_90: '#886000', 67 | yellow_70: '#AD7A03', 68 | yellow_60: '#DE9C00', 69 | yellow_50: '#FFB400', 70 | yellow_40: '#FFCF3F', 71 | yellow_30: '#FFE47E', 72 | yellow_20: '#FFF4BE', 73 | yellow_10: '#FFF9E0', 74 | // RED 75 | red_error: '#b70700', 76 | 77 | // BACKGROUNDS 78 | blue_95: '#01213C', 79 | yellow_05: '#FFFEF9', 80 | 81 | // Alias Colors 82 | content_color_primary: `${(props) => props.theme.colors.grey_90};`, 83 | content_color_secondary: `${(props) => props.theme.colors.grey_70}`, 84 | content_color_tertiary: `${(props) => props.theme.colors.grey_50}` 85 | }, 86 | 87 | forms: { 88 | border: '#969696', 89 | text: '#6B6B6B' 90 | }, 91 | 92 | shadows: { 93 | // mostly used on Cards 94 | card_shadow: '0 8px 16px -4px rgba(0, 0, 0, 0.08)', 95 | card_shadow_2: '0 8px 16px -4px rgba(0, 0, 0, 0.08)', 96 | form_shadow: '0px 5px 8px rgba(28, 39, 43, 0.05)', 97 | form_field_focus: '0 0 0 0.2rem rgba(0, 123, 255, .25)', 98 | screenshot_shadow: '0px 0px 8px 5px rgba(0,0,0,0.05)' 99 | }, 100 | transitions: { 101 | all: 'all 0.2s ease-in-out' 102 | }, 103 | borderRadius: { 104 | small: '5px', 105 | medium: '10px', 106 | large: '20px' 107 | } 108 | }; 109 | 110 | function Theme({ children }) { 111 | return
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/script.json#L8) | `string` | `false` | A unique, user-defined identifier that you can use to refer to this script from requests. 33 | [type](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/script.json#L12) | `string` | `false` | Type of the script. For example, `text/javascript`. 34 | [exec](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/script.json#L12) | `string` \| `array` | `false` | An array of strings where each line represents a single line of code. Separate lines make it possible to track changes made to scripts. 35 | [src](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/script.json#L30) | [#url](/reference/url/) | `false` | An array of strings where each line represents a single line of code. Separate lines make it possible to track changes made to scripts. 36 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/script.json#L33) | `string` | `false` | The name of the script. 37 | 38 |
39 | 40 | #### Reference diagram 41 | 42 |  43 | 44 |
45 | 46 | #### Schema 47 | 48 | ```json 49 | { 50 | "$schema": "http://json-schema.org/draft-07/schema#", 51 | "$id": "#/definitions/script", 52 | "title": "Script", 53 | "type": "object", 54 | "description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.", 55 | "properties": { 56 | "id": { 57 | "description": "A unique, user defined identifier that can be used to refer to this script from requests.", 58 | "type": "string" 59 | }, 60 | "type": { 61 | "description": "Type of the script. E.g: 'text/javascript'", 62 | "type": "string" 63 | }, 64 | "exec": { 65 | "oneOf": [ 66 | { 67 | "type": "array", 68 | "description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.", 69 | "items": { 70 | "type": "string" 71 | } 72 | }, 73 | { 74 | "type": "string" 75 | } 76 | ] 77 | }, 78 | "src": { 79 | "$ref": "#/definitions/url" 80 | }, 81 | "name": { 82 | "type": "string", 83 | "description": "Script name" 84 | } 85 | } 86 | } 87 | ``` 88 | 89 |
90 | 91 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 92 | -------------------------------------------------------------------------------- /src/pages/getting-started/overview.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Overview" 3 | order: 1 4 | page_id: "overview" 5 | warning: false 6 | updated: 2023-01-17 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | - type: subtitle 17 | --- 18 | 19 | A Collection is an API specification that provides a format for representing, modeling, and organizing different parts of an API request or workflow. Its format is both human-readable and machine-readable, and it lets you create executable workflows for your APIs. 20 | 21 | Collections let you: 22 | 23 | * Share and execute API requests seamlessly. 24 | * Define different aspects of your API. 25 | * Create and model workflows for your APIs. 26 | * Work across the lifecycle of your API. 27 | * Document and test your API. 28 | 29 | The Collection Format is [open source](https://github.com/postmanlabs/schemas/tree/develop/schemas/draft-07) and is the basis of [Collections in Postman](https://www.postman.com/collection/). The format's portability makes it possible to share in a distributed team and run in different environments without any information loss. A single collection file can contain API requests and their parameters, multiple responses to each request, documentation, tests, execution flows, and metadata. This helps developer teams collaborate, increase productivity, and work faster with APIs in any environment. 30 | 31 | > This documentation focuses on [version 2.1.0](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json) of the collection format. 32 | 33 | ## Advantages of the Collection format 34 | 35 | Collections have the following advantages: 36 | 37 | ### Collections are human-readable and machine-readable 38 | 39 | Collections are written in JSON. Each property has an intuitive and understandable name with a relatable structure, making it readable to humans without having to consult a lot of external documentation. Collections are structurally sub-divided into tiny parts called units, and being coupled with JSON structure makes them readable by computers. 40 | 41 | ### Collections are interoperable 42 | 43 | With the help of tooling, collections are interoperable. You can convert a collection to an API definition in a different format and vice versa. In Postman’s API Builder, you can import your API definitions in a variety of formats, such as OpenAPI and GraphQL, and use them to generate collections for different purposes, including mocking, documentation, and testing. 44 | 45 | ### Collections are highly portable 46 | 47 | Collections are portable, which makes it possible to share and use them across multiple environments. 48 | 49 | ### Everything you need in a single place 50 | 51 | Collections include everything you need to work with your API, including documentation, testing, API requests and workflows, and scripting. 52 | 53 | ### Code and documentation generation 54 | 55 | Because collections are machine-readable, they can be used to generate both client and server-side codes for your APIs in any programming language. This means developers can generate SDKs for their APIs, saving time that would have been used to write one from scratch. For example, [Postman code generators](https://github.com/postmanlabs/postman-code-generators) let you generate code from your collections in over 10 programming languages. 56 | 57 | Aside from code, documentation is another important aspect of building APIs. Collections support documentation by default, and this documentation can be converted into a more presentable form for better consumption. 58 | -------------------------------------------------------------------------------- /src/pages/reference/certificate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Certificate" 3 | order: 1 4 | page_id: "certificate" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | The certificate object lets you represent an SSL certificate in a collection. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/certificate.json#L7) | `string` | `false` | A name for the certificate for user reference. 33 | [matches](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/certificate.json#L11) | `array` | `false` | A list of URL match pattern strings to identify URLs this certificate can be used for. 34 | [key](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/certificate.json#L19) | `object` | `false` | An object containing the path to the file that has private key. 35 | [cert](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/certificate.json#LL28C6-L28C10) | `object` | `false` | An object containing the path to the certificate file. 36 | [passphrase](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/certificate.json#LL37C6-L37C16) | `string` | `false` | The passphrase for the certificate. 37 | 38 |
39 | 40 | #### Reference diagram 41 | 42 |  43 | 44 |
45 | 46 | #### Schema 47 | 48 | ```json 49 | { 50 | "$id": "#/definitions/certificate", 51 | "title": "Certificate", 52 | "description": "A representation of an ssl certificate", 53 | "type": "object", 54 | "properties": { 55 | "name": { 56 | "description": "A name for the certificate for user reference", 57 | "type": "string" 58 | }, 59 | "matches": { 60 | "description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.", 61 | "type": "array", 62 | "items": { 63 | "type": "string", 64 | "description": "An Url match pattern string" 65 | } 66 | }, 67 | "key": { 68 | "description": "An object containing path to file containing private key, on the file system", 69 | "type": "object", 70 | "properties": { 71 | "src": { 72 | "description": "The path to file containing key for certificate, on the file system" 73 | } 74 | } 75 | }, 76 | "cert": { 77 | "description": "An object containing path to file certificate, on the file system", 78 | "type": "object", 79 | "properties": { 80 | "src": { 81 | "description": "The path to file containing key for certificate, on the file system" 82 | } 83 | } 84 | }, 85 | "passphrase": { 86 | "description": "The passphrase for the certificate", 87 | "type": "string" 88 | } 89 | } 90 | } 91 | ``` 92 | 93 |
94 | 95 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 96 | -------------------------------------------------------------------------------- /styles/config/print.css: -------------------------------------------------------------------------------- 1 | /** 2 | * Print Stylesheet 3 | */ 4 | 5 | @media print { 6 | 7 | /* Setting content width, unsetting floats and margins */ 8 | /* Attention: the classes and IDs vary from theme to theme. Thus, set own classes here */ 9 | main { 10 | width: 100%; 11 | margin: 0; 12 | float: none; 13 | } 14 | 15 | /** Setting margins */ 16 | @page { margin: 2cm } 17 | 18 | /* Set background to white and font to black.*/ 19 | /* This saves ink */ 20 | body { 21 | line-height: 1.3; 22 | background: #ffffff !important; 23 | color: #000000; 24 | } 25 | 26 | h1 { 27 | font-size: 24pt; 28 | } 29 | 30 | h2, h3, h4 { 31 | font-size: 14pt; 32 | margin-top: 25px; 33 | } 34 | 35 | /* Defining all page breaks */ 36 | a, blockquote, table, pre { 37 | page-break-inside: avoid; 38 | } 39 | h1, h2, h3, h4, h5, h6 { 40 | page-break-after: avoid; 41 | page-break-inside: avoid 42 | } 43 | img { 44 | page-break-inside: avoid; 45 | page-break-after: avoid; 46 | } 47 | ul, ol, dl { 48 | page-break-before: avoid 49 | } 50 | 51 | /* Displaying link color and link behaviour */ 52 | a:link, a:visited, a { 53 | background: transparent; 54 | color: #520; 55 | font-weight: bold; 56 | text-decoration: underline; 57 | text-align: left; 58 | } 59 | 60 | a { 61 | page-break-inside:avoid 62 | } 63 | 64 | a[href^=http]:after { 65 | content:" <" attr(href) "> "; 66 | } 67 | 68 | a:after > img { 69 | content: ""; 70 | } 71 | 72 | article a[href^="#"]:after { 73 | content: ""; 74 | } 75 | 76 | a:not(:local-link):after { 77 | content:" <" attr(href) "> "; 78 | } 79 | 80 | /** 81 | * Making intergated videos disappear, and removing the iframes' whitespace to zero. 82 | */ 83 | .entry iframe, ins { 84 | display: none; 85 | width: 0 !important; 86 | height: 0 !important; 87 | overflow: hidden !important; 88 | line-height: 0pt !important; 89 | white-space: nowrap; 90 | } 91 | .embed-youtube, .embed-responsive { 92 | position: absolute; 93 | height: 0; 94 | overflow: hidden; 95 | } 96 | 97 | /* Hiding unnecessary elements for the print */ 98 | #header-widgets, nav, aside.mashsb-container, 99 | .sidebar, .mashshare-top, .mashshare-bottom, 100 | .content-ads, .make-comment, .author-bio, 101 | .heading, .related-posts, #decomments-form-add-comment, 102 | #breadcrumbs, footer, .post-byline, .meta-single, 103 | .site-title img, .post-tags, .readability, 104 | #onetrust-consent-sdk, .right-column 105 | { 106 | display: none; 107 | } 108 | /* Make images half-width to save space */ 109 | img { 110 | width: 50%; 111 | height: auto; 112 | display: block; 113 | } 114 | img[src$='#icon'] { 115 | margin-bottom: 0; 116 | display: inline; 117 | width: 18pt; 118 | height: auto; 119 | } 120 | 121 | /* Adding custom messages before and after the content */ 122 | .entry:after { 123 | content: "\ All Rights Reserved. © 2022 Postman, Inc."; 124 | color: #999 !important; 125 | font-size: 1em; 126 | padding-top: 30px; 127 | } 128 | 129 | /* Wichtige Elemente definieren */ 130 | p, address, li, dt, dd, blockquote { 131 | font-size: 100% 132 | } 133 | 134 | ul, ol { 135 | list-style: square; margin-left: 18pt; 136 | margin-bottom: 20pt; 137 | } 138 | 139 | li { 140 | line-height: 1.6em; 141 | } 142 | } -------------------------------------------------------------------------------- /src/components/modules/BreadCrumbsLinks.jsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { Link, graphql, useStaticQuery } from 'gatsby'; 3 | import { leftNavItems } from '../LeftNav/LeftNavItems'; 4 | import styled from 'styled-components'; 5 | import {theme} from '../../../styles/theme'; 6 | import removePrefixFromCurrentPath from '../../utils/removePrefixFromCurrentPath'; // uncomment to use with new repo 7 | 8 | // Example: Home / Getting Started / 9 | // a list of links separated by / to aid in navigation 10 | const BreadCrumbStyles = styled.nav` 11 | & a:link, 12 | a:visited, 13 | span { 14 | color: ${theme.colors.grey_50}!important; 15 | transition: all 0.2s ease-in-out; 16 | border-bottom: 1px transparent; 17 | } 18 | & a:hover, 19 | a:active { 20 | transition: all 0.2s ease-in-out; 21 | text-decoration: none; 22 | color: ${theme.colors.blue_60}; 23 | border-bottom: 1px solid; 24 | } 25 | 26 | ol.lc-breadcrumbs { 27 | margin: 0; 28 | li { 29 | list-style-type: none; 30 | display: inline; 31 | padding-left: 0; 32 | } 33 | } 34 | ` 35 | class BreadCrumbsLinksComponent extends React.Component { 36 | constructor(props) { 37 | super(props); 38 | this.state = { 39 | parentLink: { 40 | url: '/' 41 | }, 42 | subParentLink: {}, 43 | location: props.location 44 | } 45 | } 46 | componentDidMount() { 47 | const { location } = this.state; 48 | /* Loop over LeftNavItems.jsx */ 49 | for (let index = 0; index < leftNavItems.length; index++) { 50 | /* First Menu: If matching URL, use the parent data for breadcrumb */ 51 | leftNavItems[index].subMenuItems1.map((subMenuItem1, index2) => { 52 | if (subMenuItem1.url === location) { 53 | this.setState({ 54 | parentLink: leftNavItems[index], 55 | }) 56 | } 57 | /* Second Menu: If matching URL, use the parent AND subparent data for breadcrumb */ 58 | subMenuItem1.subMenuItems2 && subMenuItem1.subMenuItems2.map(subMenuItem2 => { 59 | if (subMenuItem2.url === location) { 60 | this.setState({ 61 | parentLink: leftNavItems[index], 62 | subParentLink: leftNavItems[index].subMenuItems1[index2], 63 | }) 64 | } 65 | }) 66 | }) 67 | } 68 | } 69 | render() { 70 | const { parentLink, subParentLink } = this.state; 71 | return ( 72 |
-
74 |
- 75 | Home 76 | 77 | 78 | {JSON.stringify(subParentLink) !== '{}' ? ( 79 | <> 80 |
- 81 | {parentLink.name} 82 | 83 | 84 |
- 85 | {subParentLink.name} 86 | 87 | 88 | ) : ( 89 | <> 90 |
- 91 | {parentLink.name} 92 | 93 | 94 | )} 95 |
27 | 28 | ### Reference table 29 | 30 | | Field Name | Type | Required | Description | 31 | | --- | --- | --- | --- | 32 | | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/info.json#L9) | `string` | `true` | A collection's human-friendly name is defined by this field. Set this field to a value that lets you to identify this collection, such as highlighting its usage or content. | 33 | | [_postman_id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/info.json#L14) | `string` | `false` | The Postman unique identifier for this collection. | 34 | | [description](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/info.json#LL18C6-L18C17) | [#description](/reference/description/) | `false` | The description of this collection. | 35 | | [version](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/info.json#LL21C6-L21C13) | [#description](/reference/version/) | `false` | The version info of this collection. | 36 | | [schema](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/info.json#L24) | `string` | `true` | Holds a link to the Postman schema that's used to validate this collection. For example, ```https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json```. | 37 | 38 |
39 | 40 | #### Reference diagram 41 | 42 |  43 | 44 | #### Schema 45 | 46 | ```json 47 | { 48 | "$schema": "http://json-schema.org/draft-07/schema#", 49 | "$id": "#/definitions/info", 50 | "title": "Information", 51 | "description": "Detailed description of the info block", 52 | // TODO: Add detailed description 53 | "type": "object", 54 | "properties": { 55 | "name": { 56 | "type": "string", 57 | "title": "Name of the collection", 58 | "description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content." 59 | }, 60 | "_postman_id": { 61 | "type": "string", 62 | "description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.*" 63 | }, 64 | "description": { 65 | "$ref": "#/definitions/description" 66 | }, 67 | "version": { 68 | "$ref": "#/definitions/version" 69 | }, 70 | "schema": { 71 | "description": "This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1", 72 | "type": "string" 73 | } 74 | }, 75 | "required": [ 76 | "name", 77 | "schema" 78 | ] 79 | } 80 | ``` 81 | 82 |
83 | 84 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 85 | -------------------------------------------------------------------------------- /src/pages/reference/version.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Version" 3 | order: 1 4 | page_id: "version" 5 | warning: false 6 | updated: 2023-01-17 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | You can version your collections as they grow, and this field holds the version number. While optional, it's recommended that you use this field to its fullest extent. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [major](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/version.json#L10) | `integer` | `true` | Increment this number if you make changes to the collection that change its behavior. For examples, removing or adding new test scripts. 33 | [minor](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/version.json#L15) | `integer` | `true` | Increment this number if you make changes that don't break anything that uses the collection. For example, removing a folder. 34 | [patch](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/version.json#L20) | `integer` | `true` | Increment this number if you make minor changes to a collection. 35 | [identifier](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/version.json#L25) | `string` | `false` | A human-friendly identifier to make sense of the version numbers. For example, `beta-3`. 36 | [meta](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/version.json#L30) | `object` | `false` | Any additional info relating to this version. 37 | 38 |
39 | 40 | #### Reference diagram 41 | 42 |  43 | 44 |
45 | 46 | #### Schema 47 | 48 | ```json 49 | { 50 | "$schema": "http://json-schema.org/draft-07/schema#", 51 | "$id": "#/definitions/version", 52 | "title": "Collection Version", 53 | "description": "Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!", 54 | "oneOf": [ 55 | { 56 | "type": "object", 57 | "properties": { 58 | "major": { 59 | "description": "Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).", 60 | "minimum": 0, 61 | "type": "integer" 62 | }, 63 | "minor": { 64 | "description": "You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.", 65 | "minimum": 0, 66 | "type": "integer" 67 | }, 68 | "patch": { 69 | "description": "Ideally, minor changes to a collection should result in the increment of this number.", 70 | "minimum": 0, 71 | "type": "integer" 72 | }, 73 | "identifier": { 74 | "description": "A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'", 75 | "type": "string", 76 | "maxLength": 10 77 | }, 78 | "meta": {} 79 | }, 80 | "required": [ 81 | "major", 82 | "minor", 83 | "patch" 84 | ] 85 | }, 86 | { 87 | "type": "string" 88 | } 89 | ] 90 | } 91 | ``` 92 | 93 |
94 | 95 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 96 | -------------------------------------------------------------------------------- /src/pages/advanced-concepts/events.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Events" 3 | order: 1 4 | page_id: "events" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | Events let you declare scripts that you can execute at certain stages in the lifecycle of your requests or collections. The scripts are written in JavaScript and can be executed using the [Postman Sandbox](https://github.com/postmanlabs/postman-sandbox). 19 | 20 |
21 | 22 | ## Contents 23 | 24 | - [Event object](#event-object) 25 | - [Scripts](#scripts) 26 | - [Pre-request scripts](#pre-request-scripts) 27 | - [Test scripts](#test-scripts) 28 | 29 | ## Event object 30 | 31 | An event object is defined using an event-list, which is an array of event objects. 32 | 33 | An event object looks like the following: 34 | 35 | ```json 36 | { 37 | "id": "abffrda7-b967-45f5-95dd-8fa73720d34", 38 | "listen": "test", // `test` or `prerequest` 39 | "script": { 40 | "id": "bdff8da7-b967-45f5-95dd-8fa73720fc27", 41 | "type": "text/javascript", 42 | "exec": [ 43 | "const text = 'I am a text';", 44 | "console.log('Text is: ', text)", 45 | ], 46 | }, 47 | "disabled": false 48 | } 49 | ``` 50 | 51 |
52 | 53 | ### Scripts 54 | 55 | When a script is listening to an event and the event fires, the script object defines what code can run. 56 | 57 | A script object can have the following fields: 58 | 59 | Field | Type | Description 60 | --- | --- | --- 61 | [id](https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection/script.json#L8) | `string` | A unique, user-defined identifier that you can use to refer to this script from requests. 62 | [type](https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection/script.json#L12) | `string` | The type of the script. For example, `text/javascript`. 63 | [exec](https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection/script.json#L16) | `string`, `[ string ]` | A string or an array of strings, where each line represents a single line of code. Separate lines make it possible to track changes made to scripts. 64 | [src](https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection/script.json#L16) | [reference-object](/reference/url/) | Provides a reference for external scripts. 65 | [name](https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection/script.json#L33) | `string` | The name of the script. 66 | 67 | Scripting allows you to model workflows for your requests. You can model workflows so that the input of one request is dependent on the output of another and make them run in a sequence. For more information, see [Intro to Scripts](https://learning.postman.com/docs/writing-scripts/intro-to-scripts/) in the Postman Learning Center. 68 | 69 | > You can use `exec` or `src` to reference the code in the script. If both are used together, `exec` takes precedence over `src`. 70 | 71 | #### Pre-request scripts 72 | 73 | Scripts that listen to the `prerequest` event are executed right before the request is made. You can write code to change variables and parameters dynamically based on required logic or use case. This helps with data pre-processing and logging. For more information, see [Writing pre-request scripts](https://learning.postman.com/docs/writing-scripts/pre-request-scripts/). 74 | 75 | #### Test scripts 76 | 77 | Scripts that listen to the `test` event are executed right after a response to the request is received. You can write code that performs certain actions on the response. For example, you can write tests to confirm that your request returns the expected response data. 78 | 79 | You can also write assertions to run against the response from each API request so that you know when something isn't working as expected. This can help you automate your debugging. For more information, see [Writing Tests](https://learning.postman.com/docs/writing-scripts/test-scripts/). 80 | -------------------------------------------------------------------------------- /src/pages/reference/item.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Item" 3 | order: 1 4 | page_id: "item" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | An item is the basic building block of a collection. Items let you specify a request and its corresponding responses. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L7) | `string` | `false` | A unique ID that is used to identify collections internally. 33 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L11) | `string` | `false` | A human-readable identifier for the current item. 34 | [description](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L15) | [#description](/reference/description/) | `false` | The description of this item. 35 | [variable](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L18) | [#variable](/reference/variable/) | `false` | The variables that are scoped to this item. 36 | [event](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L21) | [#event](/reference/event/) | `false` | Events that this item listens to. 37 | [request](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L24) | [#request](/reference/request/) | `true` | The request carries all the necessary information about this HTTP call. 38 | [response](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#L27) | [#response](/reference/response/) | `false` | Represents any type of response received from your HTTP request. 39 | [protocolProfileBehavior](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item.json#LL34C6-L34C29) | [#protocolProfileBehavior](/reference/protocol-profile-behavior) | `false` | Set of configurations used to change the usual behavior of sending the request. 40 | 41 |
42 | 43 | #### Reference diagram 44 | 45 |  46 | 47 |
48 | 49 | #### Schema 50 | 51 | ```json 52 | { 53 | "type": "object", 54 | "title": "Item", 55 | "$id": "#/definitions/item", 56 | "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.", 57 | "properties": { 58 | "id": { 59 | "type": "string", 60 | "description": "A unique ID that is used to identify collections internally" 61 | }, 62 | "name": { 63 | "type": "string", 64 | "description": "A human readable identifier for the current item." 65 | }, 66 | "description": { 67 | "$ref": "#/definitions/description" 68 | }, 69 | "variable": { 70 | "$ref": "#/definitions/variable-list" 71 | }, 72 | "event": { 73 | "$ref": "#/definitions/event-list" 74 | }, 75 | "request": { 76 | "$ref": "#/definitions/request" 77 | }, 78 | "response": { 79 | "type": "array", 80 | "title": "Responses", 81 | "items": { 82 | "$ref": "#/definitions/response" 83 | } 84 | }, 85 | "protocolProfileBehavior": { 86 | "$ref": "#/definitions/protocol-profile-behavior" 87 | } 88 | }, 89 | "required": [ 90 | "request" 91 | ] 92 | } 93 | ``` 94 | 95 |
96 | 97 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 98 | -------------------------------------------------------------------------------- /src/components/Shared/EditDoc.jsx: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import { useStaticQuery, graphql } from 'gatsby' 3 | import { BaseButton } from 'aether-marketing'; 4 | import styled from 'styled-components'; 5 | 6 | const SvgWrapper = styled.i` 7 | // ICONS 8 | // class starting with "pm-icon-" get styled by _pm-icons.scss file. 9 | // class .glyphicon gets styled by bootstrap.css file. 10 | 11 | 12 | // gets rid of weird background bug with our icons. We need to redo these. 13 | background: 0 0; 14 | 15 | svg.button-icon--left { 16 | margin-right: 7px; 17 | overflow: hidden; 18 | vertical-align: middle; 19 | } 20 | ` 21 | 22 | 23 | const EditbuttonStyle = styled.span` 24 | font-family: inter; 25 | font-size: 14px; 26 | ` 27 | class EditDocComponent extends Component { 28 | constructor(props) { 29 | super(props); 30 | 31 | this.state = { 32 | pathRoute: '', 33 | pathPrefix: props.pathPrefix 34 | }; 35 | } 36 | 37 | componentDidMount() { 38 | const { pathRoute, pathPrefix } = this.state; 39 | // Gatsby path prefixing includes /labs/ at build. 40 | // This is a case where we do not want the pathRoute prefixed, as it is used inside a github URL 41 | // So we remove it 42 | if (pathRoute.includes(`${pathPrefix}/`)) { 43 | pathRoute = pathRoute.replace(`${pathPrefix}/`, "/"); 44 | } 45 | this.setState({ 46 | pathRoute: window.location.pathname.slice(0, -1), 47 | }); 48 | } 49 | 50 | 51 | render() { 52 | const { pathRoute } = this.state; 53 | 54 | return ( 55 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [info](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L6) | [#info](/reference/info) | `true` | Lets you specify relevant metadata for your collection. 33 | [item](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L9) | [#item](/reference/item) | `true` | The basic unit of a collection. You can think of them as corresponding to a single API endpoint. Each item has one request and might have multiple API responses associated with it. 34 | [event](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L24) | [#event](/reference/event) | `false` | Lets you declare scripts that are executed when certain events occur. 35 | [variable](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L27) | [#variable](/reference/variable) | `false` | Lets you store and retrieve data across different units in your collection. 36 | [auth](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L30) | [#auth](/reference/auth) | `false` | Represents the different authentication helpers that can be used by a collection. 37 | [protocolProfileBehavior](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection.json#L40) | [#protocolProfileBehavior](/reference/protocolProfileBehavior) | `false` | Can change the usual behavior of sending the request. 38 | 39 |
40 | 41 | #### Reference diagram 42 | 43 |  44 | 45 |
46 | 47 | #### Schema 48 | 49 | ```json 50 | { 51 | "$schema": "http://json-schema.org/draft-07/schema#", 52 | "$id": "https://schema.getpostman.com/json/draft-07/collection/v2.1.0/", 53 | "type": "object", 54 | "properties": { 55 | "info": { 56 | "$ref": "#/definitions/info" 57 | }, 58 | "item": { 59 | "type": "array", 60 | "description": "Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.", 61 | "items": { 62 | "title": "Items", 63 | "oneOf": [ 64 | { 65 | "$ref": "#/definitions/item" 66 | }, 67 | { 68 | "$ref": "#/definitions/item-group" 69 | } 70 | ] 71 | } 72 | }, 73 | "event": { 74 | "$ref": "#/definitions/event-list" 75 | }, 76 | "variable": { 77 | "$ref": "#/definitions/variable-list" 78 | }, 79 | "auth": { 80 | "oneOf": [ 81 | { 82 | "type": "null" 83 | }, 84 | { 85 | "$ref": "#/definitions/auth" 86 | } 87 | ] 88 | }, 89 | "protocolProfileBehavior": { 90 | "$ref": "#/definitions/protocol-profile-behavior" 91 | } 92 | }, 93 | "required": [ 94 | "info", 95 | "item" 96 | ] 97 | } 98 | ``` 99 | 100 |
101 | 102 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 103 | -------------------------------------------------------------------------------- /gatsby-config.js: -------------------------------------------------------------------------------- 1 | // require('dotenv').config({ 2 | // path: `.env.${process.env.GATSBY_ACTIVE_ENV}`, 3 | // }); 4 | 5 | require('dotenv').config({ 6 | path: `.env.${process.env.NODE_ENV}`, 7 | }); 8 | 9 | const SITE_URL = process.env.SITE_URL ? process.env.SITE_URL : 'https://learning.postman.com/collection-format'; 10 | const DOMAIN_NAME = process.env.DOMAIN_NAME ? process.env.DOMAIN_NAME : 'learning.postman.com'; 11 | const PATH_PREFIX = '/collection-format'; 12 | 13 | module.exports = { 14 | siteMetadata: { 15 | title: 'Postman Collection Format', 16 | description: 'Documentation for Postman collections, a portable format for organizing API request and workflows.', 17 | author: 'Postman', 18 | siteUrl: SITE_URL, 19 | domainName: DOMAIN_NAME, 20 | pathPrefix: PATH_PREFIX 21 | }, 22 | pathPrefix: PATH_PREFIX, 23 | trailingSlash: 'always', 24 | plugins: [ 25 | 'gatsby-plugin-react-helmet', 26 | 'gatsby-plugin-styled-components', 27 | { 28 | resolve: 'gatsby-source-filesystem', 29 | options: { 30 | name: 'images', 31 | path: `${__dirname}/src/images`, 32 | }, 33 | }, 34 | { 35 | resolve: 'gatsby-source-filesystem', 36 | options: { 37 | name: 'src', 38 | path: `${__dirname}/src/`, 39 | }, 40 | }, 41 | { 42 | resolve: 'gatsby-plugin-typography', 43 | options: { 44 | pathToConfigModule: 'src/utils/typography', 45 | }, 46 | }, 47 | { 48 | resolve: 'gatsby-transformer-remark', 49 | options: { 50 | plugins: [ 51 | 'gatsby-remark-autolink-headers', 52 | 'gatsby-remark-check-links', 53 | 'gatsby-remark-responsive-iframe', 54 | { 55 | resolve: 'gatsby-remark-prismjs', 56 | options: { 57 | classPrefix: 'language-', 58 | inlineCodeMarker: null, 59 | aliases: {}, 60 | showLineNumbers: false, 61 | noInlineHighlight: false, 62 | }, 63 | }, 64 | ], 65 | }, 66 | }, 67 | 'gatsby-transformer-sharp', 68 | { 69 | resolve: 'gatsby-plugin-manifest', 70 | options: { 71 | name: 'Postman Collection Format Doc', 72 | short_name: 'Postman Collection Format Doc', 73 | start_url: '/', 74 | background_color: '#FF6C37', 75 | theme_color: '#FF6C37', 76 | display: 'minimal-ui', 77 | icon: 'src/images/favicon.png', 78 | }, 79 | }, 80 | 'gatsby-plugin-meta-redirect', 81 | 'gatsby-plugin-sass', 82 | 'gatsby-plugin-sharp', 83 | { 84 | resolve: 'gatsby-plugin-sitemap', 85 | options: { 86 | excludes: ['/search/'] 87 | } 88 | }, 89 | { 90 | resolve: 'gatsby-plugin-robots-txt', 91 | options: { 92 | host: SITE_URL, 93 | sitemap:`${SITE_URL}/sitemap/sitemap-index.xml`, 94 | resolveEnv: () => process.env.GATSBY_ACTIVE_ENV, 95 | env: { 96 | development: { 97 | policy: [{ userAgent: '*', disallow: ['/'] }], 98 | }, 99 | production: { 100 | policy: [{ userAgent: '*', allow: '/' }], 101 | }, 102 | }, 103 | }, 104 | }, 105 | { 106 | resolve: 'gatsby-plugin-sri', 107 | options: { 108 | hash: 'sha512', // 'sha256', 'sha384' or 'sha512' ('sha512' = default) 109 | crossorigin: false, // Optional 110 | }, 111 | }, 112 | { 113 | resolve: 'gatsby-plugin-env-variables', 114 | options: { 115 | allowList: ['MUNCHKIN_ID'], 116 | }, 117 | }, 118 | { 119 | resolve: 'gatsby-plugin-gdpr-cookies', 120 | options: { 121 | googleAnalytics: { 122 | trackingId: 'G-CX7P9K6W67', 123 | anonymize: true, 124 | }, 125 | environments: ['production', 'development'], 126 | }, 127 | }, 128 | { 129 | resolve: 'gatsby-plugin-newrelic', 130 | options: { 131 | config: { 132 | instrumentationType: 'pro', 133 | accountId: process.env.RELIC_ACCOUNT_ID, 134 | trustKey: process.env.RELIC_TRUST_KEY, 135 | agentID: process.env.RELIC_PRODUCTION_AGENT_ID, 136 | licenseKey: process.env.RELIC_LICENSE_KEY, 137 | applicationID: process.env.RELIC_PRODUCTION_APPLICATION_ID, 138 | beacon: 'bam.nr-data.net', 139 | errorBeacon: 'bam.nr-data.net' 140 | } 141 | } 142 | }, 143 | ], 144 | }; 145 | -------------------------------------------------------------------------------- /src/components/modules/PreviousAndNextLinks.jsx: -------------------------------------------------------------------------------- 1 | import React, { useState, useEffect } from 'react'; 2 | import { Link } from 'gatsby' 3 | import { leftNavItems } from '../LeftNav/LeftNavItems'; 4 | import { handleKeyboard } from './handlePagination' 5 | import removePrefixFromCurrentPath from '../../utils/removePrefixFromCurrentPath'; 6 | 7 | function PreviousAndNextLinks() { 8 | const [prevLink, setPrevious] = useState() 9 | const [nextLink, setNext] = useState() 10 | 11 | const location = removePrefixFromCurrentPath(); 12 | 13 | // 1. Filter data / data reference: LeftNavItems.jsx 14 | const parentLinks = []; 15 | leftNavItems.forEach((leftNavItem) => { 16 | leftNavItem.subMenuItems1.map((subMenuItem1, index) => { 17 | // parent - if url matches window.location, push item to array 18 | leftNavItem.subMenuItems1[index].url === location && parentLinks.push(leftNavItem.subMenuItems1) 19 | // subparent - same logic as above but a level deeper 20 | subMenuItem1.subMenuItems2 && subMenuItem1.subMenuItems2.filter(subMenuItem2 => 21 | // push three arrays to parentLinks[last item in previous section, current items, first item in next section] 22 | subMenuItem2.url === location && parentLinks.push( 23 | [leftNavItem.subMenuItems1[index - 1]], 24 | subMenuItem1.subMenuItems2, 25 | [leftNavItem.subMenuItems1[index + 1]] 26 | ) 27 | ) 28 | } 29 | ) 30 | return parentLinks; 31 | }) 32 | // 2. Invoke function based on array length and which page the user is on 33 | let previous; 34 | let next; 35 | let subParentLinks; 36 | if (parentLinks.length > 1) { 37 | // merge three arrays to one [last item in previous section, current items, first item in next section] 38 | subParentLinks = parentLinks[0].concat(parentLinks[1], parentLinks[2]); 39 | // remove first and last element if undefined 40 | subParentLinks[0] === undefined ? subParentLinks.shift() : subParentLinks; 41 | subParentLinks[subParentLinks.length + -1] === undefined ? subParentLinks.pop() : subParentLinks; 42 | handleSubMenu(subParentLinks); 43 | } else { 44 | handleParentMenu(parentLinks); 45 | } 46 | 47 | function handleSubMenu(links) { 48 | for (let i = 0; i < links.length; i++) { 49 | if (links[i].url === location) { 50 | let prevIndex = links[i + -1]; 51 | let nextIndex = links[i + 1]; 52 | previous = prevIndex && prevIndex.subMenuItems2 ? prevIndex.subMenuItems2[prevIndex.subMenuItems2.length + -1] : prevIndex; 53 | next = nextIndex ? nextIndex : nextIndex; 54 | } 55 | } 56 | } 57 | function handleParentMenu(links) { 58 | links.map(link => { 59 | for (let i = 0; i < link.length; i++) { 60 | if (link[i].url === location) { 61 | let prevIndex = link[i + -1]; 62 | let nextIndex = link[i + 1]; 63 | // if previous section is submenu, use last item of previous section 64 | // Ex: /docs/designing-and-developing-your-api/view-and-analyze-api-reports/ 65 | previous = prevIndex && prevIndex.subMenuItems2 ? prevIndex.subMenuItems2[prevIndex.subMenuItems2.length + -1] : prevIndex; 66 | next = nextIndex ? nextIndex : nextIndex; 67 | } 68 | } 69 | }) 70 | } 71 | 72 | useEffect(() => { 73 | setPrevious(previous); 74 | setNext(next); 75 | handleKeyboard(); 76 | }, []); 77 | 78 | 79 | return ( 80 | <> 81 |
82 | 110 | 111 | ) 112 | } 113 | 114 | export default PreviousAndNextLinks; 115 | -------------------------------------------------------------------------------- /src/components/ContextualLinks/ContextualLinks.jsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import DynamicLink from '../Shared/DynamicLink'; 3 | import recentBlogPosts from '../../../bff-data/blog.json'; 4 | import styled from "styled-components"; 5 | 6 | const ContextualStyles = styled.div` 7 | 8 | .contextual-links__section { 9 | margin-top: 24px; 10 | margin-bottom: 8px; 11 | font-size: 16px; 12 | font-weight: 600; 13 | color: ${(props) => props.theme.colors.grey_80}; 14 | } 15 | .contextual-links__link { 16 | margin-bottom: 0; 17 | padding: 4px 0; 18 | display: block; 19 | 20 | a { 21 | color: ${(props) => props.theme.colors.grey_50}; 22 | font-size: 14px; 23 | text-decoration: none; 24 | border-bottom: 1px solid ${(props) => props.theme.colors.grey_00}; 25 | transition: ${(props) => props.theme.transitions.all}; 26 | } 27 | 28 | &:hover { 29 | a { 30 | color: ${(props) => props.theme.colors.blue_60}; 31 | border-bottom: 1px solid ${(props) => props.theme.colors.blue_60}; 32 | transition: ${(props) => props.theme.transitions.all}; 33 | } 34 | } 35 | } 36 | 37 | .contextual-links__subtitle { 38 | color: ${(props) => props.theme.colors.grey_60}; 39 | font-size: 15px; 40 | font-weight: 600; 41 | margin-top: 1rem; 42 | margin-bottom: .7rem; 43 | } 44 | 45 | .contextual-links__alert { 46 | border: 4px dashed ${(props) => props.theme.colors.grey_10}; 47 | border-radius: ${(props) => props.theme.borderRadius.small}; 48 | padding: .75rem 1.25rem; 49 | color: #0C5460; 50 | } 51 | 52 | // tablet view 53 | @media (min-width: 767px) and (max-width: 990px) { 54 | padding-bottom: 80px; 55 | } 56 | 57 | 58 | // mobile view 59 | @media (max-width: 767px) { 60 | padding-bottom: 80px; 61 | } 62 | 63 | 64 | ` 65 | const ContextualLinks = ({ links }) => ( 66 |
72 |
74 | );
75 | }
76 | if (item.type === 'subtitle') {
77 | return (
78 |
79 | {item.name}
80 |
81 | );
82 | }
83 | if (item.type === 'dynamic_blog' && item.blog_tag) {
84 | if (Object.keys(recentBlogPosts).length === 0) {
85 | // If recentBlogPosts.length === 0, then either there is no .env.development,
86 | // it has a bad blog url, or the endpoint returned something bad
87 | return (
88 |
89 |
96 | );
97 | }
98 | if (recentBlogPosts.index && recentBlogPosts.index[item.blog_tag]) {
99 | const dynamicLinks = recentBlogPosts.index[item.blog_tag].slice(0, 3).map((post) => (
100 | 90 | You are currently in develop mode. 91 | Dynamic blog posts will not be displayed locally. 92 | See Contributing doc for details 93 | . 94 |
95 |
101 |
103 | ));
104 | return (
105 |
106 |
111 | );
112 | }
113 |
114 | // If there are no related blog posts within blogs.json
115 | // (written in /bff-data/ at build time), we simply return nothing.
116 |
117 | // This will likely be the case when you are developing locally,
118 | // and do not have a .env.development file with the BFF endpoints.
119 | return null;
120 | }
121 |
122 | return (
123 |
107 | {item.name}
108 |
109 | {dynamicLinks}
110 | {item.name}
124 | );
125 | })
126 | }
127 | 27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L8) | `string` | `false` | A folder-friendly name. Set this field to a value that allows you to identify this folder. 33 | [description](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L12) | [#description](/reference/description/) | `false` | The description of this item group or folder. 34 | [variable](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L15) | [#variable](/reference/variable/) | `false` | A list of variables scoped to this item group. 35 | [item](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L18) | [#item](/reference/item/) | `true` | Contains an HTTP request and sample responses. Folders can contain many items. 36 | [event](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L33) | [#event](/reference/event/) | `false` | A list of events and scripts that can be executed on this item group. 37 | [auth](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L36) | `null` \| [#auth](/reference/auth/) | `false` | A list of events and scripts that can be executed on this item group. 38 | [protocolProfileBehavior](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/item-group.json#L46) | [#protocolProfileBehavior](/reference/protocol-profile-behavior/) | `false` | A set of configurations used to change the usual behavior of sending the request. 39 | 40 |
41 | 42 | #### Reference diagram 43 | 44 |  45 | 46 |
47 | 48 | #### Schema 49 | 50 | ```json 51 | { 52 | "$schema": "http://json-schema.org/draft-07/schema#", 53 | "title": "Folder", 54 | "$id": "#/definitions/item-group", 55 | "description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.", 56 | "type": "object", 57 | "properties": { 58 | "name": { 59 | "type": "string", 60 | "description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder." 61 | }, 62 | "description": { 63 | "$ref": "#/definitions/description" 64 | }, 65 | "variable": { 66 | "$ref": "#/definitions/variable-list" 67 | }, 68 | "item": { 69 | "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.", 70 | "type": "array", 71 | "items": { 72 | "title": "Items", 73 | "anyOf": [ 74 | { 75 | "$ref": "#/definitions/item" 76 | }, 77 | { 78 | "$ref": "#/definitions/item-group" 79 | } 80 | ] 81 | } 82 | }, 83 | "event": { 84 | "$ref": "#/definitions/event-list" 85 | }, 86 | "auth": { 87 | "oneOf": [ 88 | { 89 | "type": "null" 90 | }, 91 | { 92 | "$ref": "#/definitions/auth" 93 | } 94 | ] 95 | }, 96 | "protocolProfileBehavior": { 97 | "$ref": "#/definitions/protocol-profile-behavior" 98 | } 99 | }, 100 | "required": [ 101 | "item" 102 | ] 103 | } 104 | ``` 105 | 106 |
107 | 108 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 109 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "postman-collection-format", 3 | "private": true, 4 | "description": "Postman Marketing Template documentation project", 5 | "version": "0.1.0", 6 | "dependencies": { 7 | "@babel/preset-react": "7.16.0", 8 | "@github-docs/frontmatter": "1.3.1", 9 | "aether-marketing": "1.24.2", 10 | "babel-plugin-styled-components": "2.0.7", 11 | "base-64": "1.0.0", 12 | "bootstrap": "4.5.0", 13 | "dotenv": "8.6.0", 14 | "eslint-plugin-jest": "22.21.0", 15 | "gatsby": "4.13.0", 16 | "gatsby-cli": "4.13.0", 17 | "gatsby-plugin-algolia": "0.26.0", 18 | "gatsby-plugin-env-variables": "2.2.0", 19 | "gatsby-plugin-gdpr-cookies": "2.0.9", 20 | "gatsby-plugin-google-analytics": "4.13.0", 21 | "gatsby-plugin-manifest": "4.13.0", 22 | "gatsby-plugin-meta-redirect": "1.1.1", 23 | "gatsby-plugin-newrelic": "2.2.2", 24 | "gatsby-plugin-purgecss": "6.1.2", 25 | "gatsby-plugin-react-helmet": "5.20.0", 26 | "gatsby-plugin-robots-txt": "1.7.1", 27 | "gatsby-plugin-sass": "5.20.0", 28 | "gatsby-plugin-sharp": "4.13.0", 29 | "gatsby-plugin-sitemap": "5.20.0", 30 | "gatsby-plugin-sri": "1.1.0", 31 | "gatsby-plugin-styled-components": "5.18.0", 32 | "gatsby-plugin-typography": "4.17.0", 33 | "gatsby-remark-autolink-headers": "5.17.0", 34 | "gatsby-remark-check-links": "2.1.0", 35 | "gatsby-remark-prismjs": "6.20.0", 36 | "gatsby-remark-responsive-iframe": "5.20.0", 37 | "gatsby-source-filesystem": "4.13.0", 38 | "gatsby-transformer-remark": "5.20.0", 39 | "gatsby-transformer-sharp": "4.13.0", 40 | "glob": "7.1.7", 41 | "googleapis": "55.0.0", 42 | "jquery": "3.5.1", 43 | "jquery.scrollto": "2.1.3", 44 | "markdownlint-cli": "0.19.0", 45 | "node-fetch": "2.6.7", 46 | "popper.js": "1.16.1", 47 | "prettier": "2.5.0", 48 | "prismjs": "1.28.0", 49 | "prop-types": "15.7.2", 50 | "qs": "6.11.0", 51 | "react": "17.0.2", 52 | "react-dom": "17.0.2", 53 | "react-helmet": "6.1.0", 54 | "react-instantsearch-dom": "6.33.0", 55 | "react-instantsearch-hooks-web": "6.30.3", 56 | "react-typography": "0.16.20", 57 | "sass": "1.32.0", 58 | "shelljs": "0.8.5", 59 | "styled-components": "5.3.5", 60 | "terser": "5.15.1", 61 | "typescript": "2.9.2", 62 | "typography": "0.16.21", 63 | "unlink": "0.0.2", 64 | "url": "0.11.0", 65 | "uuid": "3.3.3", 66 | "webpack": "5.64.4" 67 | }, 68 | "devDependencies": { 69 | "@babel/eslint-parser": "7.16.3", 70 | "@types/jest": "28.1.3", 71 | "@types/react-test-renderer": "18.0.0", 72 | "babel-jest": "28.1.1", 73 | "babel-preset-gatsby": "2.18.0-next.1", 74 | "eslint": "8.4.1", 75 | "identity-obj-proxy": "3.0.0", 76 | "jest": "28.1.1", 77 | "react-test-renderer": "17.0.2" 78 | }, 79 | "keywords": [ 80 | "gatsby" 81 | ], 82 | "license": "MIT", 83 | "scripts": { 84 | "am": "npm link 'aether-marketing; npm run dev", 85 | "bff": "NODE_ENV=development node bff.js", 86 | "build": "npm run bff && GATSBY_ACTIVE_ENV=production gatsby build --prefix-paths", 87 | "build:dev": "npm run build", 88 | "npm": "npm install --legacy-peer-deps --loglevel=error", 89 | "nvmrc": "echo $(node -p -e 'require(\"./package\").engines.node.split(\">=\").join(\"\")') > .nvmrc", 90 | "build:prod": "NODE_ENV=production node bff.js && GATSBY_ACTIVE_ENV=production gatsby build --prefix-paths", 91 | "clean": "gatsby clean", 92 | "dev": "npm run bff && gatsby develop", 93 | "format": "prettier --write \"**/*.{js,jsx,json,md}\"", 94 | "reset": "rm -rf package-lock.json; rm -rf node_modules; npm run npm; ./node_modules/.bin/gatsby clean;", 95 | "sanitize-branch": "node sanitize-branch.js", 96 | "start": "npm run develop", 97 | "serve": "gatsby serve", 98 | "test": "npm run bff && GATSBY_ACTIVE_ENV=development && jest", 99 | "test:update": "npm run bff && GATSBY_ACTIVE_ENV=development && jest -u", 100 | "test:lint": "node_modules/eslint/bin/eslint.js -c .eslintrc.js --ext .jsx --ext .js src/", 101 | "test:lint-fix": "node_modules/eslint/bin/eslint.js -c .eslintrc.js --ext .jsx --ext .js src/ --fix", 102 | "test:url": "if grep -lri 's3.amazonaws.com/postman-static-getpostman-com' ./v6 ; then echo invalid s3 references found. Please use format; exit 1; else echo no s3 references found; fi", 103 | "test:mdlint": "markdownlint ./ --ignore node_modules" 104 | }, 105 | "repository": { 106 | "type": "git", 107 | "url": "git+https://github.com/postmanlabs/postman-docs.git" 108 | }, 109 | "bugs": { 110 | "url": "https://github.com/postmanlabs/postman-docs/issues" 111 | }, 112 | "engines": { 113 | "node": "18.20.5" 114 | }, 115 | "allow": { 116 | "pmTech": [ 117 | "*" 118 | ] 119 | }, 120 | "homepage": "https://github.com/postmanlabs/postman-docs#readme", 121 | "main": ".eslintrc.js", 122 | "author": "" 123 | } 124 | -------------------------------------------------------------------------------- /src/components/seo.jsx: -------------------------------------------------------------------------------- 1 | /** 2 | * SEO component that queries for data with 3 | * Gatsby's useStaticQuery React hook 4 | * 5 | * See: https://www.gatsbyjs.org/docs/use-static-query/ 6 | */ 7 | 8 | import React from 'react'; 9 | import PropTypes from 'prop-types'; 10 | import Helmet from 'react-helmet'; 11 | import { useStaticQuery, graphql } from 'gatsby'; 12 | 13 | function SEO({ 14 | lang, meta, title, slug, lastModifiedTime, pathPrefix 15 | }) { 16 | const { site } = useStaticQuery( 17 | graphql` 18 | query { 19 | site { 20 | siteMetadata { 21 | title 22 | description 23 | author 24 | pathPrefix 25 | } 26 | } 27 | } 28 | `, 29 | ); 30 | 31 | return ( 32 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L8) | `string` | `true` | A unique user-defined value that identifies the variable within a collection. 33 | [key](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L12) | `string` | `true` | A human-friendly value that identifies the variable within a collection. 34 | [value](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L16) | `string` | `false` | The value that a variable holds in this collection. The variables are replaced by this value when you run a set of requests from a collection. 35 | [type](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L19) | `any` | `false` | A variable may have multiple types. This field specifies the type of the variable. 36 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L29) | `string` | `false` | The name of the variable. 37 | [description](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L33) | [#description](/reference/description/) | `false` | The description of the variable. 38 | [system](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L36) | `boolean` | `false` | When set to `true`, indicates that this variable has been set by Postman. 39 | [disabled](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/variable.json#L41) | `boolean` | `false` | When set to `true`, the variable is ignored at runtime. 40 | 41 |
42 | 43 | #### Reference diagram 44 | 45 |  46 | 47 |
48 | 49 | #### Schema 50 | 51 | ```json 52 | { 53 | "$schema": "http://json-schema.org/draft-07/schema#", 54 | "$id": "#/definitions/variable", 55 | "title": "Variable", 56 | "description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.", 57 | "type": "object", 58 | "properties": { 59 | "id": { 60 | "description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.", 61 | "type": "string" 62 | }, 63 | "key": { 64 | "description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.", 65 | "type": "string" 66 | }, 67 | "value": { 68 | "description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection" 69 | }, 70 | "type": { 71 | "description": "A variable may have multiple types. This field specifies the type of the variable.", 72 | "type": "string", 73 | "enum": [ 74 | "string", 75 | "boolean", 76 | "any", 77 | "number" 78 | ] 79 | }, 80 | "name": { 81 | "type": "string", 82 | "description": "Variable name" 83 | }, 84 | "description": { 85 | "$ref": "#/definitions/description" 86 | }, 87 | "system": { 88 | "type": "boolean", 89 | "default": false, 90 | "description": "When set to true, indicates that this variable has been set by Postman" 91 | }, 92 | "disabled": { 93 | "type": "boolean", 94 | "default": false 95 | } 96 | }, 97 | "anyOf": [ 98 | { 99 | "required": [ 100 | "id" 101 | ] 102 | }, 103 | { 104 | "required": [ 105 | "key" 106 | ] 107 | }, 108 | { 109 | "required": [ 110 | "id", 111 | "key" 112 | ] 113 | } 114 | ] 115 | } 116 | ``` 117 | 118 |
119 | 120 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 121 | -------------------------------------------------------------------------------- /src/pages/getting-started/structure-of-a-collection.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Structure of a collection" 3 | order: 1 4 | page_id: "structure-of-a-collection" 5 | warning: false 6 | updated: 2022-11-15 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | ## Contents 19 | 20 | - [Structure of a collection](#structure) 21 | - [Info](#info) 22 | - [Item](#item) 23 | - [ItemGroup](#item-groups) 24 | - [Request](#request) 25 | - [Events](#events) 26 | 27 | Collections consist of a set of reusable parts called units. These units can be nested within each other and used in different parts of a collection. 28 | 29 | ## Structure 30 | 31 | At a very high level, collections are organized as shown in the following image. 32 | 33 |  34 | 35 | A collection has a single information block and can contain a number of items and item groups. 36 | 37 | In its most basic form, a collection looks like the following: 38 | 39 | ```json 40 | { 41 | "info": { 42 | "name": "My Collection", 43 | "version": "v2.1.0", 44 | "description": "This is a demo collection.", 45 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/" 46 | }, 47 | "item": [] 48 | } 49 | ``` 50 | 51 | | Property | Description | 52 | | --- | --- | 53 | | `info` | Contains general metadata about the collection. | 54 | | `item` | An object or array that contains an API request, response, and metadata. | 55 | 56 | ### Info 57 | 58 | At minimum, the `info` property contains the collection name and schema. You can also [define a version](/reference/version) or provide a [description](/reference/description) of your collection in the `info` property. 59 | 60 | ### Item 61 | 62 | An item is the basic building block for a collection. It represents an HTTP request, along with the associated metadata. 63 | 64 | ```json 65 | { 66 | "id": "my-first-item", 67 | "name": "My First Item", 68 | "description": "This is an Item that contains a single HTTP GET request. It doesn't really do much yet!", 69 | "request": "http://postman-echo.com/get", 70 | "response": [] 71 | } 72 | ``` 73 | 74 | An item can have multiple saved responses, which are stored in the response array. 75 | 76 | ### Item groups 77 | 78 | An item group is a container for items. You can think of it as a folder for items. The folder has its own `name`, `id`, and `description`. A collection is an item group with a special `info` block. 79 | 80 | ```json 81 | { 82 | "id": "my-first-itemgroup", 83 | "name": "First Folder", 84 | "description": "This ItemGroup contains two Items.", 85 | "item": [ 86 | { 87 | "id": "1", 88 | "name": "Item A", 89 | "request": "http://postman-echo.com/get" 90 | }, 91 | { 92 | "id": "2", 93 | "name": "Item B", 94 | "request": "http://postman-echo.com/headers" 95 | } 96 | ] 97 | } 98 | ``` 99 | 100 | The item array above contains the items in this item group. 101 | 102 | ### Request 103 | 104 | A request represents an HTTP request. A request can be found within an item. Requests can be specified as a string, as shown in the earlier example, or as a JSON object. If specified as a string, it's assumed to be a `GET` request. 105 | 106 | ```json 107 | { 108 | "description": "This is a sample POST request", 109 | "url": "https://echo.getpostman.com/post", 110 | "method": "POST", 111 | "header": [ 112 | { 113 | "key": "Content-Type", 114 | "value": "application/json" 115 | }, 116 | { 117 | "key": "Host", 118 | "value": "echo.getpostman.com" 119 | } 120 | ], 121 | "body": { 122 | "mode": "urlencoded", 123 | "urlencoded": [ 124 | { 125 | "key": "my-body-variable", 126 | "value": "Something Awesome!" 127 | } 128 | ] 129 | } 130 | } 131 | ``` 132 | 133 |
134 | 135 | ### Events 136 | 137 | Events let you declare scripts that can run at certain stages in the lifecycle of your request or collection. The scripts are written in JavaScript and can be run using the [Postman Sandbox](https://github.com/postmanlabs/postman-sandbox). 138 | 139 | There are two main event types: 140 | 141 | 1) **Test script**: You can associate a test script with an item. The test script is executed after the actual HTTP request is sent and the response is received. 142 | 143 | 2) **Pre-request script**: Pre-request scripts are executed before the HTTP request is sent. 144 | 145 | ```json 146 | { 147 | "id": "evented-item", 148 | "name": "Item with Events", 149 | "description": "This is an Item that contains `test and `prerequest` events.", 150 | "request": "http://echo.getpostman.com/get", 151 | "event": [ 152 | { 153 | "listen": "prerequest", 154 | "script": { 155 | "type": "text/javascript", 156 | "exec": "console.log('We are in the pre-request script, the request has not run yet!')" 157 | } 158 | }, 159 | { 160 | "listen": "test", 161 | "script": { 162 | "type": "text/javascript", 163 | "exec": "console.log('We are using the test script now, and the request was already sent!')" 164 | } 165 | } 166 | ] 167 | } 168 | ``` 169 | -------------------------------------------------------------------------------- /src/pages/reference/cookie.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Cookie" 3 | order: 1 4 | page_id: "cookie" 5 | warning: false 6 | updated: 2023-01-16 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | The cookie object in collections follows the [Google Chrome Cookie format](https://developer.chrome.com/extensions/cookies). 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | -- 32 | [domain](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L7) | `string` | `true` | The domain for which this cookie is valid. 33 | [expires](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L11) | `string \| null` | `false` | When the cookie expires. 34 | [maxAge](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#LL18C9-L18C9) | `string` | `false` | The time it'll take for the cookie to expire relative to the current time. 35 | [hostOnly](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#LL21C6-L21C14) | `boolean` | `false` | True if the cookie is a host-only cookie. For example, a request's URL domain must exactly match the domain of the cookie. 36 | [httpOnly](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L25) | `boolean` | `false` | Indicates if this cookie is HTTP-only. If `true`, the cookie is inaccessible to client-side scripts. 37 | [name](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L29) | `string` | `false` | The name of the cookie. 38 | [path](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L33) | `string` | `true` | The path associated with the cookie. 39 | [secure](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L37) | `boolean` | `false` | Indicates if the `secure` flag is set on the cookie, meaning that it's transmitted over secure connections only, such as HTTPS. 40 | [session](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L41) | `boolean` | `false` | True if the cookie is a session cookie. 41 | [value](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#L45) | `string` | `false` | The value of the cookie. 42 | [extensions](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/cookie.json#LL49C6-L49C16) | `array` | `false` | Custom attributes for a cookie, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693). 43 | 44 | #### Reference diagram 45 | 46 |  47 | 48 |
49 | 50 | #### Schema 51 | 52 | ```json 53 | { 54 | "type": "object", 55 | "title": "Cookie", 56 | "$id": "#/definitions/cookie", 57 | "description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)", 58 | "properties": { 59 | "domain": { 60 | "type": "string", 61 | "description": "The domain for which this cookie is valid." 62 | }, 63 | "expires": { 64 | "type": [ 65 | "string", 66 | "null" 67 | ], 68 | "description": "When the cookie expires." 69 | }, 70 | "maxAge": { 71 | "type": "string" 72 | }, 73 | "hostOnly": { 74 | "type": "boolean", 75 | "description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)." 76 | }, 77 | "httpOnly": { 78 | "type": "boolean", 79 | "description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)" 80 | }, 81 | "name": { 82 | "type": "string", 83 | "description": "This is the name of the Cookie." 84 | }, 85 | "path": { 86 | "type": "string", 87 | "description": "The path associated with the Cookie." 88 | }, 89 | "secure": { 90 | "type": "boolean", 91 | "description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)" 92 | }, 93 | "session": { 94 | "type": "boolean", 95 | "description": "True if the cookie is a session cookie." 96 | }, 97 | "value": { 98 | "type": "string", 99 | "description": "The value of the Cookie." 100 | }, 101 | "extensions": { 102 | "type": "array", 103 | "description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)" 104 | } 105 | }, 106 | "required": [ 107 | "domain", 108 | "path" 109 | ] 110 | } 111 | ``` 112 | 113 |
114 | 115 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 116 | -------------------------------------------------------------------------------- /src/pages/reference/response.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Response" 3 | order: 1 4 | page_id: "response" 5 | warning: false 6 | updated: 2022-11-15 7 | contextual_links: 8 | - type: subtitle 9 | name: "Blog Posts" 10 | - type: link 11 | name: "Postman Essentials: Exploring the Collection Format" 12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/" 13 | - type: link 14 | name: "Travelogue of Postman Collection Format v2" 15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/" 16 | --- 17 | 18 | The response object allows you to define an HTTP response for its corresponding request. 19 | 20 | ## Contents 21 | 22 | - [Reference table](#reference-table) 23 | - [Reference diagram](#reference-diagram) 24 | - [Schema](#schema) 25 | 26 |
27 | 28 | ### Reference table 29 | 30 | Field Name | Type | Required | Description 31 | --- | --- | --- | --- 32 | [id](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#LL8C22-L8C114) | `string` | `false` | A unique, user-defined identifier that you can use to refer to this response from requests. 33 | [originalRequest](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L11) | [#originalRequest](/reference/request/) | `false` | The request object that initiated this response. 34 | [responseTime](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L14) | `string` \| `number` | `false` | The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`. 35 | [timings](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L23) | `object` | `false` | Set of timing information related to the request and response in milliseconds. 36 | [header](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L31) | [#header](/reference/header) | `false` | An array containing all the headers. 37 | [cookie](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L31) | [#cookie](/reference/cookie) | `false` | An array containing all the cookies included in this response. 38 | [body](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L64) | `body` | `false` | The raw text of the response. 39 | [status](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L71) | `string` | `false` | The response status. For example, `200 OK`. 40 | [code](https://github.com/postmanlabs/schemas/blob/da7578c2d71c46de2d39d04fbeebc26570591a44/schemas/draft-07/v2.1.0/collection/response.json#L75) | `integer` | `false` | The numerical response code. For example, `200`, `201`, or `404`. 41 | 42 |
43 | 44 | #### Reference diagram 45 | 46 |  47 | 48 |
49 | 50 | #### Schema 51 | 52 | ```json 53 | { 54 | "$schema": "http://json-schema.org/draft-07/schema#", 55 | "$id": "#/definitions/response", 56 | "title": "Response", 57 | "description": "A response represents an HTTP response.", 58 | "properties": { 59 | "id": { 60 | "description": "A unique, user defined identifier that can be used to refer to this response from requests.", 61 | "type": "string" 62 | }, 63 | "originalRequest": { 64 | "$ref": "#/definitions/request" 65 | }, 66 | "responseTime": { 67 | "title": "ResponseTime", 68 | "type": [ 69 | "null", 70 | "string", 71 | "number" 72 | ], 73 | "description": "The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`." 74 | }, 75 | "timings": { 76 | "title": "Response Timings", 77 | "description": "Set of timing information related to request and response in milliseconds", 78 | "type": [ 79 | "object", 80 | "null" 81 | ] 82 | }, 83 | "header": { 84 | "title": "Headers", 85 | "oneOf": [ 86 | { 87 | "type": "array", 88 | "title": "Header", 89 | "description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.", 90 | "items": { 91 | "oneOf": [ 92 | { 93 | "$ref": "#/definitions/header" 94 | }, 95 | { 96 | "title": "Header", 97 | "type": "string" 98 | } 99 | ] 100 | } 101 | }, 102 | { 103 | "type": [ 104 | "string", 105 | "null" 106 | ] 107 | } 108 | ] 109 | }, 110 | "cookie": { 111 | "type": "array", 112 | "items": { 113 | "$ref": "#/definitions/cookie" 114 | } 115 | }, 116 | "body": { 117 | "type": [ 118 | "null", 119 | "string" 120 | ], 121 | "description": "The raw text of the response." 122 | }, 123 | "status": { 124 | "type": "string", 125 | "description": "The response status, e.g: '200 OK'" 126 | }, 127 | "code": { 128 | "type": "integer", 129 | "description": "The numerical response code, example: 200, 201, 404, etc." 130 | } 131 | } 132 | } 133 | ``` 134 | 135 |
136 | 137 | > For more information, see the [complete schema](https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json). 138 | -------------------------------------------------------------------------------- /src/components/MarketingPages/Cards.jsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { OutboundLink } from 'gatsby-plugin-google-analytics'; 3 | import styled from 'styled-components'; 4 | import { BaseLink } from 'aether-marketing' 5 | 6 | const CardWrapper = styled.div` 7 | margin-bottom: 32px; 8 | text-align: left !important; 9 | .landing-card__top { 10 | background: transparent; 11 | margin: 0; 12 | } 13 | .landing-card__image { 14 | margin-bottom: 16px; 15 | width: 50px; 16 | & img { 17 | max-width: 100%; 18 | } 19 | } 20 | .landing-card__content { 21 | &-description { 22 | margin-bottom: 25px; 23 | font-size: 16px; 24 | } 25 | a { 26 | margin-bottom: 48px; 27 | } 28 | } 29 | ` 30 | 31 | export const LandingCard = ({ 32 | title, description, link, icon, cta, 33 | }) => ( 34 |
36 |
40 |
37 |
38 |
39 |
41 |
48 | {cta}
49 |
50 |
51 | {title}
42 |{description}
43 |
60 |
64 |
61 | 
62 |
63 |
65 | {cta}
68 |
69 | {title}
66 |{description}
67 |
76 |
84 | );
85 |
86 | export const IconCard = ({
87 | items,
88 | title,
89 | description,
90 | icon,
91 | heading1,
92 | heading2,
93 | heading3,
94 | href1,
95 | href2,
96 | href3,
97 | link1,
98 | link2,
99 | link3,
100 | }) => (
101 |
77 | {title}
78 |
79 |
80 | {text}
81 | {link}
82 |
83 |
102 |
103 |
146 | );
147 |
148 | export const LabeledCard = ({
149 | link, label, title, description,
150 | }) => (
151 |
152 |
104 | {/* left image column */}
105 |
120 |
121 |
145 |
106 |
118 |
119 |
107 |
111 | {/* left text column */}
112 |
108 |
109 |
110 |
113 |
114 |
115 |
116 |
117 | {items}
{title}
{description}
153 |
159 |
160 | );
161 |
162 | export const SecondaryCard = ({
163 | title,
164 | description,
165 | ctaLink,
166 | cta,
167 | }) => (
168 |
173 | );
174 |
175 | export const TransparentCard = ({ icon, title, text }) => (
176 |
154 |
155 |
158 | {title}
156 |{description}
157 |
177 |
178 |
181 | );
182 |
183 | // this card has been removed from page, keeping code for future reference
184 | export const QaCard = ({ title, content, cta }) => (
185 | {title}
179 |{text}
180 |
186 |
187 |
191 | );
192 |
--------------------------------------------------------------------------------
/src/pages/advanced-concepts/documentation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Documentation"
3 | order: 1
4 | page_id: "documentation"
5 | warning: false
6 | updated: 2023-01-16
7 | contextual_links:
8 | - type: subtitle
9 | name: "Blog Posts"
10 | - type: link
11 | name: "Postman Essentials: Exploring the Collection format"
12 | url: "https://blog.postman.com/postman-essentials-exploring-the-collection-format/"
13 | - type: link
14 | name: "Travelogue of Postman Collection format v2"
15 | url: "https://blog.postman.com/travelogue-of-postman-collection-format-v2/"
16 | ---
17 |
18 |
19 | Modeling workflows and representing your APIs in a human-readable and machine-readable format is one part of building and working with your APIs. Another key aspect is ensuring that anyone who is going to consume or work with this API in the future has all the information and context they need to get started. Documentation is a key part of developing APIs because it helps you start working with your API and understanding what each request in your API does.
20 |
21 | {title}
188 |{content}
189 | 190 |22 | 23 | ## Contents 24 | 25 | - [Documenting collections](#documenting-collections) 26 | - [Description object](#description-object) 27 | 28 | ## Documenting collections 29 | 30 | Collections have different units or parts that each describe a specific aspect of a group of API requests. These different parts often need more details or information that give more context to anyone who interacts with the collection. These extra details are provided using the [description](/reference/description/) object. When the description object added to different parts of a collection, it becomes documentation for that collection. 31 | 32 | ## Description object 33 | 34 | The description object is a powerful tool for describing different parts of a collection. Almost every collection unit has a description property, and each of these descriptions provide usage context for the collection. 35 | 36 | Descriptions can be either strings or objects and can contain plain text, Markdown, HTML, or other MIME types. 37 | 38 | A description object looks like the following: 39 | 40 | ```json 41 | { 42 | "description": { 43 | "content": "
The description you want to provide.
", 44 | "type": "text/html", 45 | "version": "A description can have versions associated with it. Use this field to specify a version for your description." 46 | } 47 | } 48 | ``` 49 | 50 |51 | 52 | An example of a collection with documentation using the description object is shown below. This example makes use of modified excerpts from the [Postman API](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a). 53 | 54 | ```json 55 | { 56 | "info": { 57 | "name": "Collection showing documentation example", 58 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" 59 | }, 60 | "item": { 61 | "name": "Create a collection", 62 | "description": { 63 | "type": "text/markdown", 64 | "content": "## Postman API\n The Postman API lets you to programmatically access data stored in your Postman account with ease.\n\n ## Overview\n 1. You must use a valid API Key to send requests to the API endpoints. You can get your API key from Postman's integrations dashboard.\n 2. The API has access rate limits.\n 3. The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.\n\n ## ID and UID\n All items in Postman, such as collections, mocks, workspaces, and APIs, have ID and UIDs:\n\n - An ID is the unique ID assigned to a Postman item. For example, ec29121c-5203-409f-9e84-e83ffc10f226.\n - The UID is the full ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the 12345678-ec29121c-5203-409f-9e84-e83ffc10f226 UID:\n - 12345678 is the user's ID.\n - ec29121c-5203-409f-9e84-e83ffc10f226 is the item's ID." 65 | }, 66 | "request": { 67 | "description": { 68 | "type": "text/markdown", 69 | "content": "### Create a collection\n \n Creates a collection using the [Postman Collection v2 schema format](https://schema.postman.com/json/collection/v2.1.0/docs/index.html). Include a collection object in the request body that contains the following required properties:\n - `info` -- An *object* that contains the following properties:\n - `name` -- A *string* value that contains the collection's name.\n - `schema` -- A string that contains a URL to the collection's schema. For example, the `https://schema.getpostman.com/collection/v1` URL.\n - `item` -- An *object* that contains the HTTP request and response information.\n - `request` -- An *object* that contains the collection's request information. For a complete list of values, refer to the `definitions.request` entry in the [collection.json schema file](https://schema.postman.com/json/collection/v2.1.0/collection.json). If you pass an empty object for this value, the system defaults to an untitled GET request." 70 | }, 71 | "url": "https://api.getpostman.com/collections", 72 | "method": "POST", 73 | "header": [ 74 | { 75 | "key": "Content-Type", 76 | "value": "Application/JSON" 77 | } 78 | ], 79 | "body": { 80 | "mode": "raw", 81 | "raw": "{\n \"collection\": {\n \"info\": {\n \"name\": \"Sample Collection\",\n \"schema\": \"https://schema.postman.com/json/collection/v2.1.0/collection.json\"\n },\n \"item\": [\n {\n \"request\": \"https://postman-echo.com/get\"\n }\n ]\n }\n}", 82 | "options": { 83 | "raw": { 84 | "language": "json" 85 | } 86 | } 87 | } 88 | } 89 | } 90 | } 91 | ``` 92 | 93 |
94 | 95 | The documentation for the [Postman API](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a) is a good example of how documentation can be presented using collections. 96 | --------------------------------------------------------------------------------