Initial OpenAPI spec setup

Author: sorndotdev

.github/workflows/openapi-validate.yaml

@@ -0,0 +1,32 @@
+name: Validate OpenAPI Specs
+
+on:
+  push:
+    paths:
+      - 'components/**.yaml'
+      - 'services/**.yaml'
+      - 'responses/**.yaml'
+  pull_request:
+    paths:
+      - 'components/**.yaml'
+      - 'services/**.yaml'
+      - 'responses/**.yaml'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install swagger-cli
+        run: npm install -g swagger-cli
+
+      - name: Validate OpenAPI spec
+        run: |
+          swagger-cli validate main.yaml --verbose

.github/workflows/update-website.yaml

@@ -0,0 +1,28 @@
+name: Update Website Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'openapi.json'
+      - 'openapi.yaml'
+      - 'docs/**'
+      - '*.md'
+
+jobs:
+  update-website:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout openapi repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Trigger website deployment
+        run: |
+          curl -X POST \
+            -H "Authorization: token ${{ secrets.WEBSITE_DEPLOY_TOKEN }}" \
+            -H "Accept: application/vnd.github.v3+json" \
+            https://api.github.com/repos/marketdataapi/website/dispatches \
+            -d '{"event_type": "openapi-updated", "client_payload": {"sha": "${{ github.sha }}", "ref": "${{ github.ref }}"}}'
+

.gitignore

@@ -0,0 +1,3 @@
+.idea
+dist/
+output.txt

README.md

@@ -0,0 +1,38 @@
+## MarketDataAPI.com — OpenAPI Specifications
+
+# Overview
+
+This repository hosts the official OpenAPI (Swagger) specification files for **MarketDataAPI.com**, enabling
+standardized integration with MarketDataAPI’s financial data services.
+
+* Specification standard: **OpenAPI 3.1.0**
+* API reference: [https://www.marketdataapi.com/docs](https://www.marketdataapi.com/docs)
+
+# Repository Contents
+
+API definitions are provided in multiple serialization formats for interoperability:
+
+```txt
+openapi/
+  components/
+    schemas.yaml           # Shared schemas across services
+    responses.yaml         # Shared response objects
+  services/
+    search/
+      v1.yaml
+```
+
+# Compatibility
+
+* Fully compliant with **OpenAPI Specification**.
+* Suitable for code generation, validation, documentation, and client/server scaffolding.
+
+# Support & Issue Tracking
+
+* Bugs, technical issues, and feature requests: **GitHub Issues**.
+* General inquiries and assistance: [https://www.marketdataapi.com/help](https://www.marketdataapi.com/help).
+
+# License
+
+* Open source under the **MIT License**.
+* See the `LICENSE` file for full terms.

SETUP.md

@@ -0,0 +1,30 @@
+# Setup 
+
+Install openapitools
+
+```
+npm i -g @openapitools/openapi-generator-cli
+```
+
+Build locally
+
+```
+openapi-generator-cli validate -i main.yaml
+openapi-generator-cli generate \
+  -i main.yaml \
+  -g openapi-yaml \
+  -o dist
+```
+
+Install redocly
+
+```
+npm i -g @redocly/cli
+```
+
+Serve locally
+
+```
+redocly preview -d dist
+```
+

components/responses.yaml

@@ -0,0 +1,55 @@
+openapi: 3.1.0
+info:
+  title: MarketDataAPI.com - Shared Responses
+  version: 'v1'
+
+components:
+  responses:
+    BadRequest:
+      description: Invalid request parameters
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    Unauthorized:
+      description: Authentication failed
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    TooManyRequests:
+      description: Rate limit exceeded
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    PaymentRequired:
+      description: Subscription required for this endpoint
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    Forbidden:
+      description: Authenticated but forbidden
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    NotFound:
+      description: Resource not found
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'
+
+    InternalServerError:
+      description: Unexpected server error
+      content:
+        application/problem+json:
+          schema:
+            $ref: './schemas.yaml#/components/schemas/ProblemDetail'