build: Added dev/preview mode for the spec

remove unused markdown files
This commit is contained in:
JasonLandbridge
2024-08-30 12:55:30 +02:00
parent e464dadfb5
commit 46d814c775
3 changed files with 11 additions and 7 deletions

BIN
bun.lockb

Binary file not shown.

View File

@@ -1,20 +1,24 @@
{ {
"name": "plex-api-spec-tests", "name": "plex-api-spec",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "An open source Plex Media Server API Specification",
"main": "index.js", "main": "src/pms-spec.yaml",
"scripts": { "scripts": {
"dev": "redocly preview --product=redoc -d=./src",
"stats": "redocly stats ./src/pms-spec.yaml",
"build": "swagger-cli bundle --dereference ./src/pms-spec.yaml -t yaml -o ./output/plex-media-server-spec-dereferenced.yaml", "build": "swagger-cli bundle --dereference ./src/pms-spec.yaml -t yaml -o ./output/plex-media-server-spec-dereferenced.yaml",
"build-redocly": "redocly bundle ./src/pms-spec.yaml --ext yaml -o ./output/plex-media-server-spec-dereferenced.yaml",
"test": "bun run build && vitest --run", "test": "bun run build && vitest --run",
"setup-speakeasy-cli": "curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh", "setup-speakeasy-cli": "curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh",
"lint": "speakeasy lint openapi -s ./src/pms-spec.yaml", "lint": "speakeasy lint openapi -s ./src/pms-spec.yaml",
"lint-bundled": "bun run build && speakeasy lint openapi -s ./output/plex-media-server-spec-dereferenced.yaml" "lint-bundled": "bun run build && speakeasy lint openapi -s ./output/plex-media-server-spec-dereferenced.yaml"
}, },
"keywords": [], "keywords": ["plex", "api", "specification", "openapi", "swagger"],
"author": "", "author": "LukeHagar",
"license": "ISC", "license": "ISC",
"devDependencies": { "devDependencies": {
"@modyfi/vite-plugin-yaml": "^1.1.0", "@modyfi/vite-plugin-yaml": "^1.1.0",
"@redocly/cli": "^1.22.0",
"@types/node": "^22.5.0", "@types/node": "^22.5.0",
"swagger-cli": "^4.0.4", "swagger-cli": "^4.0.4",
"typescript": "^5.5.4", "typescript": "^5.5.4",

View File

@@ -2,7 +2,7 @@ openapi: 3.1.0
info: info:
version: 0.0.3 version: 0.0.3
title: Plex-API title: Plex-API
description: An Open API Spec for interacting with Plex.tv description: An Open API Spec for interacting with Plex.tv and Plex Media Server
contact: contact:
name: Luke Hagar name: Luke Hagar
url: 'https://www.LukeHagar.com' url: 'https://www.LukeHagar.com'
@@ -27,7 +27,7 @@ servers:
x-speakeasy-globals: x-speakeasy-globals:
parameters: parameters:
- $ref: "./parameters/ClientIdentifier.yaml" - $ref: '#/components/parameters/ClientIdentifier'
security: security:
- accessToken: [] - accessToken: []