{"id":14156642,"url":"https://github.com/airtasker/spot","last_synced_at":"2026-02-06T01:25:23.087Z","repository":{"id":33424851,"uuid":"152569547","full_name":"airtasker/spot","owner":"airtasker","description":"Spot is a concise, developer-friendly way to describe your API contract.","archived":false,"fork":false,"pushed_at":"2026-02-04T01:33:01.000Z","size":8428,"stargazers_count":568,"open_issues_count":99,"forks_count":38,"subscribers_count":48,"default_branch":"master","last_synced_at":"2026-02-04T13:35:27.811Z","etag":null,"topics":["api-blueprint","dsl","json-schema","openapi","openapi3","swagger","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/airtasker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2018-10-11T09:55:46.000Z","updated_at":"2026-01-28T00:19:15.000Z","dependencies_parsed_at":"2024-01-07T23:20:46.667Z","dependency_job_id":"b405cc86-d00a-4c38-8704-54c1b6d68d9e","html_url":"https://github.com/airtasker/spot","commit_stats":{"total_commits":1458,"total_committers":29,"mean_commits":"50.275862068965516","dds":"0.46433470507544583","last_synced_commit":"b8684c0492b4c909ac643c11d891f87040a96c27"},"previous_names":["zenclabs/typed-api","zenclabs/spot"],"tags_count":61,"template":false,"template_full_name":null,"purl":"pkg:github/airtasker/spot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtasker%2Fspot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtasker%2Fspot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtasker%2Fspot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtasker%2Fspot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/airtasker","download_url":"https://codeload.github.com/airtasker/spot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtasker%2Fspot/sbom","scorecard":{"id":173718,"data":{"date":"2025-08-11","repo":{"name":"github.com/airtasker/spot","commit":"65f306d953a4c3aadaca9c21e50474a0bea02384"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Maintained","score":1,"reason":"2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build-and-test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/airtasker/spot/build-and-test.yml/master?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":8,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'master'","Info: 'force pushes' disabled on branch 'master'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'","Info: 'stale review dismissal' is required to merge on branch 'master'","Warn: required approving review count is 1 on branch 'master'","Info: codeowner review is required on branch 'master'","Info: 'last push approval' is required to merge on branch 'master'","Info: status check found to merge onto on branch 'master'","Info: PRs are required in order to make changes on branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"35 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-gx9m-whjm-85jf","Warn: Project is vulnerable to: GHSA-mmhx-hmjr-r674","Warn: Project is vulnerable to: GHSA-vhxf-7vqr-mrjg","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-9rhg-254w-fh9x","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-9j49-mfvp-vmhm","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-75v8-2h7p-7m2m","Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h","Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-pppg-cpfq-h7wr","Warn: Project is vulnerable to: GHSA-hw8r-x6gr-5gjp","Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx","Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T17:11:48.440Z","repository_id":33424851,"created_at":"2025-08-16T17:11:48.440Z","updated_at":"2025-08-16T17:11:48.440Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29143474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T01:13:33.096Z","status":"ssl_error","status_checked_at":"2026-02-06T01:11:47.313Z","response_time":65,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-blueprint","dsl","json-schema","openapi","openapi3","swagger","typescript"],"created_at":"2024-08-17T08:07:30.538Z","updated_at":"2026-02-06T01:25:23.078Z","avatar_url":"https://github.com/airtasker.png","language":"TypeScript","funding_links":[],"categories":["typescript","TypeScript"],"sub_categories":[],"readme":"# Spot\n\n**Spot** (_\"Single Point Of Truth\"_) is a concise, developer-friendly way to describe your API contract.\n\nLeveraging the TypeScript syntax, it lets you describe your API and generate other API contract formats you need (OpenAPI, Swagger, JSON Schema).\n\nYou don't need to use TypeScript in your codebase to benefit from using Spot.\n\nExample of an API definition file `api.ts` which defines a single `POST` endpoint to create a user:\n\n```typescript\nimport { api, endpoint, request, response, body } from \"@airtasker/spot\";\n\n@api({\n  name: \"My API\"\n})\nclass Api {}\n\n@endpoint({\n  method: \"POST\",\n  path: \"/users\"\n})\nclass CreateUser {\n  @request\n  request(@body body: CreateUserRequest) {}\n\n  @response({ status: 201 })\n  response(@body body: CreateUserResponse) {}\n}\n\ninterface CreateUserRequest {\n  firstName: string;\n  lastName: string;\n}\n\ninterface CreateUserResponse {\n  firstName: string;\n  lastName: string;\n  role: string;\n}\n```\n\n## Getting Started\n\nGet started with writing Spot contracts - [Spot Guide](https://github.com/airtasker/spot/wiki/Spot-Guide)\n\nFor all available syntax, see [Spot Syntax](https://github.com/airtasker/spot/wiki/Spot-Syntax)\n\n### Requirements\n\n- Node.js \u003e= 18.12.0\n- pnpm (recommended) or npm\n\n### Installation\n\nWith [pnpm](https://pnpm.io/) installed and initialized add `@airtasker/spot` to your project:\n\n```sh\npnpm add @airtasker/spot\n```\n\nYou can pass the definition above to a generator by simply running:\n\n```sh\nnpx @airtasker/spot generate --contract api.ts\n```\n\n# Why we built Spot\n\nAt first glance, you may wonder why we bothered building Spot. Why not use OpenAPI (formely known as Swagger) to describe your API?\n\nAt the core, we built Spot because we wanted a better developer experience.\n\n## Writing contracts\n\nOpenAPI documents are stored as YAML files, following a very specific schema. You won’t know that you used the wrong field name or forgot to wrap a type definition into a schema object unless you run a good OpenAPI linter. Most developers who aren’t intimately familiar with the OpenAPI specification end up using a visual editor such as Swagger Editor or Stoplight.\n\nSince Spot leverages the TypeScript syntax, all you need is to write valid TypeScript code. Your editor will immediately tell you when your code is invalid. It will tell you what’s missing, and you even get autocomplete for free. We could have picked any other typed language—TypeScript just happened to be one of the most concise and ubiquitous for us.\n\n## Reviewing contracts\n\nWe believe that API contracts should be checked into Git, or whichever code versioning system you use. In addition, API contracts should be systematically peer reviewed. It’s far too easy for a backend engineer to incorrectly assume what client engineers expect from an endpoint.\n\nBecause of their complex nested structure and the richness of the OpenAPI specification, OpenAPI documents can be difficult to review in a pull request. They’re great for machines, but not always for humans.\n\nSpot aims to be as human-readable as possible. We’ve seen developers become a lot more engaged in discussions on pull requests for Spot contracts, compared to our previous OpenAPI documents.\n\n## Interoperability with various formats\n\nDepending on what you're trying to achieve (testing, documentation, client code generation…), you'll find tools that only work with OpenAPI 2 (Swagger), and newer tools that only support OpenAPI 3. You may also find tools for a different API ecosystem such as JSON Schema or API Blueprint.\n\nWe built Spot with this in mind. Instead of having to juggle various API format converters, Spot can generate every major API document format. This is why we called it \"Single Point Of Truth\".\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/@airtasker/spot.svg)](https://npmjs.org/package/@airtasker/spot)\n[![CircleCI](https://circleci.com/gh/airtasker/spot/tree/master.svg?style=shield)](https://circleci.com/gh/airtasker/spot/tree/master)\n[![Downloads/week](https://img.shields.io/npm/dw/@airtasker/spot.svg)](https://npmjs.org/package/@airtasker/spot)\n[![License](https://img.shields.io/npm/l/@airtasker/spot.svg)](https://github.com/airtasker/spot/blob/master/package.json)\n\n\u003c!-- toc --\u003e\n\n- [Spot](#spot)\n- [Why we built Spot](#why-we-built-spot)\n- [Usage](#usage)\n- [Commands](#commands)\n- [Releases](#releases)\n\u003c!-- tocstop --\u003e\n\n# Usage\n\nTo get started and set up an API declaration in the current directory, run:\n\n```\nnpx @airtasker/spot init\n```\n\nYou can then run a generator with:\n\n```\nnpx @airtasker/spot generate --contract api.ts\n```\n\n## In Memory Usage\n\n```ts\nimport { Spot } from \"@airtasker/spot\";\n\nconst contract = Spot.parseContract(\"./api.ts\");\nconst openApi = Spot.OpenApi3.generateOpenAPI3(contract);\n\nconsole.log(openApi);\n\n/*\n{\n  openapi: '3.0.2',\n  info: { title: 'my-api', description: undefined, version: '0.0.0' },\n  paths: { '/users': { post: [Object] } },\n  components: {\n    schemas: { CreateUserRequest: [Object], CreateUserResponse: [Object] },\n    securitySchemes: undefined\n  },\n  security: undefined\n}\n*/\n```\n\n# Commands\n\n\u003c!-- commands --\u003e\n\n- [`spot checksum SPOT_CONTRACT`](#spot-checksum-spot_contract)\n- [`spot docs SPOT_CONTRACT`](#spot-docs-spot_contract)\n- [`spot generate`](#spot-generate)\n- [`spot help [COMMAND]`](#spot-help-command)\n- [`spot init`](#spot-init)\n- [`spot lint SPOT_CONTRACT`](#spot-lint-spot_contract)\n- [`spot mock SPOT_CONTRACT`](#spot-mock-spot_contract)\n- [`spot validate SPOT_CONTRACT`](#spot-validate-spot_contract)\n- [`spot validation-server SPOT_CONTRACT`](#spot-validation-server-spot_contract)\n\n## `spot checksum SPOT_CONTRACT`\n\nGenerate a checksum for a Spot contract\n\n```\nUSAGE\n  $ spot checksum SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help  show CLI help\n\nEXAMPLE\n  $ spot checksum api.ts\n```\n\n_See code: [build/cli/src/commands/checksum.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/checksum.js)_\n\n## `spot docs SPOT_CONTRACT`\n\nPreview Spot contract as OpenAPI3 documentation. The documentation server will start on http://localhost:8080.\n\n```\nUSAGE\n  $ spot docs SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help       show CLI help\n  -p, --port=port  [default: 8080] Documentation server port\n\nEXAMPLE\n  $ spot docs api.ts\n```\n\n_See code: [build/cli/src/commands/docs.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/docs.js)_\n\n## `spot generate`\n\nRuns a generator on an API. Used to produce client libraries, server boilerplates and well-known API contract formats such as OpenAPI.\n\n```\nUSAGE\n  $ spot generate\n\nOPTIONS\n  -c, --contract=contract    (required) Path to a TypeScript Contract definition\n  -g, --generator=generator  Generator to run\n  -h, --help                 show CLI help\n  -l, --language=language    Language to generate\n  -o, --out=out              Directory in which to output generated files\n\nEXAMPLE\n  $ spot generate --contract api.ts --language yaml --generator openapi3 --out output/\n```\n\n_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/generate.js)_\n\n## `spot help [COMMAND]`\n\ndisplay help for spot\n\n```\nUSAGE\n  $ spot help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_\n\n## `spot init`\n\nGenerates the boilerplate for an API.\n\n```\nUSAGE\n  $ spot init\n\nOPTIONS\n  -h, --help  show CLI help\n\nEXAMPLE\n  $ spot init\n  Generated the following files:\n  - api.ts\n  - tsconfig.json\n  - package.json\n```\n\n_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/init.js)_\n\n## `spot lint SPOT_CONTRACT`\n\nLint a Spot contract\n\n```\nUSAGE\n  $ spot lint SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help                                                     show CLI help\n  --has-discriminator=(error|warn|off)                           Setting for has-discriminator\n  --has-request-payload=(error|warn|off)                         Setting for has-request-payload\n  --has-response=(error|warn|off)                                Setting for has-response\n  --has-response-payload=(error|warn|off)                        Setting for has-response-payload\n  --no-inline-objects-within-unions=(error|warn|off)             Setting for no-inline-objects-within-unions\n  --no-nullable-arrays=(error|warn|off)                          Setting for no-nullable-arrays\n  --no-nullable-fields-within-request-bodies=(error|warn|off)    Setting for no-nullable-fields-within-request-bodies\n  --no-omittable-fields-within-response-bodies=(error|warn|off)  Setting for no-omittable-fields-within-response-bodies\n  --no-trailing-forward-slash=(error|warn|off)                   Setting for no-trailing-forward-slash\n\nEXAMPLES\n  $ spot lint api.ts\n  $ spot lint --has-descriminator=error\n  $ spot lint --no-nullable-arrays=off\n```\n\n_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/lint.js)_\n\n## `spot mock SPOT_CONTRACT`\n\nRun a mock server based on a Spot contract\n\n```\nUSAGE\n  $ spot mock SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help                                   show CLI help\n  -p, --port=port                              (required) [default: 3010] Port on which to run the mock server\n  --pathPrefix=pathPrefix                      Prefix to prepend to each endpoint path\n\n  --proxyBaseUrl=proxyBaseUrl                  If set, the server will act as a proxy and fetch data from the given\n                                               remote server instead of mocking it\n\n  --proxyFallbackBaseUrl=proxyFallbackBaseUrl  Like proxyBaseUrl, except used when the requested API does not match\n                                               defined SPOT contract. If unset, 404 will always be returned.\n\n  --proxyMockBaseUrl=proxyMockBaseUrl          Like proxyBaseUrl, except used to proxy draft endpoints instead of\n                                               returning mocked responses.\n\nEXAMPLE\n  $ spot mock api.ts\n```\n\n_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/mock.js)_\n\n## `spot validate SPOT_CONTRACT`\n\nValidate a Spot contract\n\n```\nUSAGE\n  $ spot validate SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help  show CLI help\n\nEXAMPLE\n  $ spot validate api.ts\n```\n\n_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/validate.js)_\n\n## `spot validation-server SPOT_CONTRACT`\n\nStart the spot contract validation server\n\n```\nUSAGE\n  $ spot validation-server SPOT_CONTRACT\n\nARGUMENTS\n  SPOT_CONTRACT  path to Spot contract\n\nOPTIONS\n  -h, --help       show CLI help\n  -p, --port=port  [default: 5907] The port where application will be available\n\nEXAMPLE\n  $ spot validation-server api.ts\n```\n\n_See code: [build/cli/src/commands/validation-server.js](https://github.com/airtasker/spot/blob/v2.0.1/build/cli/src/commands/validation-server.js)_\n\n\u003c!-- commandsstop --\u003e\n\n# Releases\n\nWhen we're ready for a new release, following steps in the [Wiki](https://github.com/airtasker/spot/wiki/Releasing-Spot)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairtasker%2Fspot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairtasker%2Fspot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairtasker%2Fspot/lists"}