'%20stroke='url(%23em)'/%3e%3cellipse%20cx='30'%20cy='34'%20rx='26'%20ry='20'%20fill='url(%23gm)'/%3e%3cpath%20d='M12.5%2013.00L52.5%2021.74L52.5%2024.33L12.5%2017.60Z'%20fill='url(%23lm)'/%3e%3crect%20x='14.20'%20y='19.29'%20width='6.60'%20height='28.93'%20rx='1.45'%20fill='url(%23cm0)'/%3e%3crect%20x='27.00'%20y='21.24'%20width='5.60'%20height='24.81'%20rx='1.23'%20fill='url(%23cm1)'/%3e%3crect%20x='37.60'%20y='22.85'%20width='4.70'%20height='21.42'%20rx='1.03'%20fill='url(%23cm2)'/%3e%3crect%20x='46.60'%20y='24.22'%20width='4.00'%20height='18.53'%20rx='0.88'%20fill='url(%23cm3)'/%3e%3cpath%20d='M12.5%2050.00L52.5%2042.57L52.5%2044.26L12.5%2053.00Z'%20fill='%237fa3ff'%20opacity='.75'/%3e%3c/svg%3e)
PorticolAPI design
Lint and compare OpenAPI documents
Open the APIs section and choose Open API document. Paste an OpenAPI 3.0 or 3.1 document, in JSON or YAML, or choose a file. The document has three tabs:
- Definition holds the document.
- Lint checks it against 13 rules and lists each finding with its severity, rule, location and message. Choose a finding to go to its line. A rule configuration turns rules off or changes their severity.
- Changes compares it with an earlier version and lists every difference as breaking, potentially breaking, additive or cosmetic, breaking first.
porticol-cli lint and porticol-cli diff do the same in CI, and exit with a code of
their own when a document has an error or breaks the earlier version; see the
command line reference.
Git sync
Link a collection to a folder in a Git repository, from the collection's Git tab, to keep it and the workspace's environments there as readable files. Secret values never go into the files; they stay on this computer.
From the same tab, commit, push, pull, make a branch and switch between branches. A pull merges item by item, and a change made both here and on the remote opens in the compare view, where you keep yours, the remote's or both. The remote's access token is kept in your keychain. Git sync is in the desktop app only.