Initial: new root spec for all endpoints

advplyr · nichwall · Sep 8, 2024 · Sep 11, 2024 · Sep 12, 2024 · Sep 13, 2024
commit 9cc3caaaeda6de193eeca00039d5c81f9d048105
diff --git a/docs/openapi.json b/docs/openapi.json
 {
  "openapi": "3.0.0",
  "info": {
    "title": "Audiobookshelf API",
    "version": "0.1.0",
    "description": "Audiobookshelf API with autogenerated OpenAPI doc"
  },
  "servers": [
    {
      "url": "http://localhost:3000",
      "description": "Development server"
    }
  ],
        "tags": [
          "Email"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/email200"
          }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/email200"
          }
        "tags": [
          "Email"
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          }
        "tags": [
          "Libraries"
        ],
        "responses": {
          "200": {
            "description": "getLibraries OK",
            "content": {
diff --git a/docs/root.yaml b/docs/root.yaml
 openapi: 3.0.0
 info:
  title: Audiobookshelf API
  version: 0.1.0
  description: Audiobookshelf API with autogenerated OpenAPI doc
 servers:
  - url: http://localhost:3000
    description: Development server
 components:
  securitySchemes:
diff --git a/docs/controllers/EmailController.yaml b/docs/controllers/EmailController.yaml
      operationId: getEmailSettings
      tags:
        - Email
      responses:
        200:
          $ref: '#/components/responses/email200'
    patch:
          application/json:
            schema:
              $ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EmailSettings'
      responses:
        200:
          $ref: '#/components/responses/email200'
  /api/emails/test:
      operationId: sendTestEmail
      tags:
        - Email
      responses:
        200:
          description: Successful response
  /api/emails/ereader-devices:
diff --git a/docs/controllers/LibraryController.yaml b/docs/controllers/LibraryController.yaml
      description: Get all libraries on server.
      tags:
        - Libraries
      responses:
        '200':
          description: getLibraries OK
          content:
	{
	"openapi": "3.0.0",
	"info": {
Check warning on line 3 in docs/openapi.json GitHub Actions / build info-license Info object should contain `license` field.
	"title": "Audiobookshelf API",
	"version": "0.1.0",
	"description": "Audiobookshelf API with autogenerated OpenAPI doc"
	},
	"servers": [
	{
	"url": "http://localhost:3000",
Check warning on line 10 in docs/openapi.json GitHub Actions / build no-server-example.com Server `url` should not point to example.com or localhost.
	"description": "Development server"
	}
	],
	"tags": [
	"Email"
	],
	"responses": {
Check warning on line 435 in docs/openapi.json GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	"200": {
	"$ref": "#/components/responses/email200"
	}
	}
	}
	},
	"responses": {
Check warning on line 457 in docs/openapi.json GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	"200": {
	"$ref": "#/components/responses/email200"
	}
	"tags": [
	"Email"
	],
	"responses": {
Check warning on line 471 in docs/openapi.json GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	"200": {
	"description": "Successful response"
	}
	"tags": [
	"Libraries"
	],
	"responses": {
Check warning on line 562 in docs/openapi.json GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	"200": {
	"description": "getLibraries OK",
	"content": {
	openapi: 3.0.0
	info:
Check warning on line 2 in docs/root.yaml GitHub Actions / build info-license Info object should contain `license` field.
	title: Audiobookshelf API
	version: 0.1.0
	description: Audiobookshelf API with autogenerated OpenAPI doc
	servers:
	- url: http://localhost:3000
Check warning on line 7 in docs/root.yaml GitHub Actions / build no-server-example.com Server `url` should not point to example.com or localhost.
	description: Development server
	components:
	securitySchemes:
	operationId: getEmailSettings
	tags:
	- Email
	responses:
Check warning on line 33 in docs/controllers/EmailController.yaml GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	200:
	$ref: '#/components/responses/email200'
	patch:
	application/json:
	schema:
	$ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EmailSettings'
	responses:
Check warning on line 47 in docs/controllers/EmailController.yaml GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	200:
	$ref: '#/components/responses/email200'
	/api/emails/test:
	operationId: sendTestEmail
	tags:
	- Email
	responses:
Check warning on line 56 in docs/controllers/EmailController.yaml GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	200:
	description: Successful response
	/api/emails/ereader-devices:
	description: Get all libraries on server.
	tags:
	- Libraries
	responses:
Check warning on line 239 in docs/controllers/LibraryController.yaml GitHub Actions / build operation-4xx-response Operation must have at least one `4XX` response.
	'200':
	description: getLibraries OK
	content: