@readme/oas-examples
Version:
A collection of example OpenAPI 3.x and Swagger 2.0 documents.
1,758 lines • 497 kB
JSON
{
"openapi": "3.0.1",
"info": {
"title": "STAPI",
"version": "1.0.0"
},
"servers": [
{
"url": "http://stapi.co/api/v1/rest"
}
],
"paths": {
"/animal": {
"get": {
"tags": ["Animal"],
"description": "Retrival of a single animal",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Animal unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnimalFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/animal/search": {
"get": {
"tags": ["Animal"],
"description": "Pagination over animals",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnimalBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["Animal"],
"description": "Searching animals",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"description": "Animal name"
},
"earthAnimal": {
"type": "boolean",
"description": "Whether it should be an earth animal"
},
"earthInsect": {
"type": "boolean",
"description": "Whether it should be an earth insect"
},
"avian": {
"type": "boolean",
"description": "Whether it should be an avian"
},
"canine": {
"type": "boolean",
"description": "Whether it should be a canine"
},
"feline": {
"type": "boolean",
"description": "Whether it should be a feline"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnimalBaseResponse"
}
}
}
}
}
}
},
"/astronomicalObject": {
"get": {
"tags": ["AstronomicalObject"],
"description": "Retrival of a single astronomical object",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Astronomical object's unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AstronomicalObjectFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/astronomicalObject/search": {
"get": {
"tags": ["AstronomicalObject"],
"description": "Pagination over astronomical objects",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AstronomicalObjectBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["AstronomicalObject"],
"description": "Searching astronomical objects",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"description": "Astronomical object name"
},
"astronomicalObjectType": {
"type": "string",
"description": "Type of astronomical object"
},
"locationUid": {
"type": "string",
"description": "Unique ID of astronomical object containing objects being searched"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AstronomicalObjectBaseResponse"
}
}
}
}
}
}
},
"/book": {
"get": {
"tags": ["Book"],
"description": "Retrival of a single book",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Book unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/book/search": {
"get": {
"tags": ["Book"],
"description": "Pagination over books",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["Book"],
"description": "Searching books",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"description": "Book title"
},
"publishedYearFrom": {
"type": "integer",
"description": "Starting year the book was published",
"format": "int32"
},
"publishedYearTo": {
"type": "integer",
"description": "Ending year the book was published",
"format": "int32"
},
"numberOfPagesFrom": {
"type": "integer",
"description": "Minimal number of pages",
"format": "int32"
},
"numberOfPagesTo": {
"type": "integer",
"description": "Maximal number of pages",
"format": "int32"
},
"stardateFrom": {
"type": "number",
"description": "Starting stardate of book story",
"format": "float"
},
"stardateTo": {
"type": "number",
"description": "Ending stardate of book story",
"format": "float"
},
"yearFrom": {
"type": "integer",
"description": "Starting year of book story",
"format": "int32"
},
"yearTo": {
"type": "integer",
"description": "Ending year of book story",
"format": "int32"
},
"novel": {
"type": "boolean",
"description": "Whether it should be a novel"
},
"referenceBook": {
"type": "boolean",
"description": "Whether it should be a reference book"
},
"biographyBook": {
"type": "boolean",
"description": "Whether it should be a biography book"
},
"rolePlayingBook": {
"type": "boolean",
"description": "Whether it should be a role playing book"
},
"eBook": {
"type": "boolean",
"description": "Whether it should be an e-book"
},
"anthology": {
"type": "boolean",
"description": "Whether it should be an anthology"
},
"novelization": {
"type": "boolean",
"description": "Whether it should be novelization"
},
"audiobook": {
"type": "boolean",
"description": "Whether it should be an audiobook"
},
"audiobookAbridged": {
"type": "boolean",
"description": "Whether it should be an audiobook, abridged"
},
"audiobookPublishedYearFrom": {
"type": "integer",
"description": "Starting year the audiobook was published",
"format": "int32"
},
"audiobookPublishedYearTo": {
"type": "integer",
"description": "Ending year the audiobook was published",
"format": "int32"
},
"audiobookRunTimeFrom": {
"type": "integer",
"description": "Minimal audiobook run time, in minutes",
"format": "int32"
},
"audiobookRunTimeTo": {
"type": "integer",
"description": "Maximal audiobook run time, in minutes",
"format": "int32"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookBaseResponse"
}
}
}
}
}
}
},
"/bookCollection": {
"get": {
"tags": ["BookCollection"],
"description": "Retrival of a single book collection",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Book collection unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookCollectionFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/bookCollection/search": {
"get": {
"tags": ["BookCollection"],
"description": "Pagination over book collections",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookCollectionBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["BookCollection"],
"description": "Searching book collections",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"description": "Book collection title"
},
"publishedYearFrom": {
"type": "integer",
"description": "Starting year the book collection was published",
"format": "int32"
},
"publishedYearTo": {
"type": "integer",
"description": "Ending year the book collection was published",
"format": "int32"
},
"numberOfPagesFrom": {
"type": "integer",
"description": "Minimal number of pages",
"format": "int32"
},
"numberOfPagesTo": {
"type": "integer",
"description": "Maximal number of pages",
"format": "int32"
},
"stardateFrom": {
"type": "number",
"description": "Starting stardate of book collection stories",
"format": "float"
},
"stardateTo": {
"type": "number",
"description": "Ending stardate of book collections stories",
"format": "float"
},
"yearFrom": {
"type": "integer",
"description": "Starting year of book collection stories",
"format": "int32"
},
"yearTo": {
"type": "integer",
"description": "Ending year of book collections stories",
"format": "int32"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookCollectionBaseResponse"
}
}
}
}
}
}
},
"/bookSeries": {
"get": {
"tags": ["BookSeries"],
"description": "Retrival of a single book series",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Book series unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookSeriesFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/bookSeries/search": {
"get": {
"tags": ["BookSeries"],
"description": "Pagination over book series",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookSeriesBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["BookSeries"],
"description": "Searching book series",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"description": "Book series title"
},
"publishedYearFrom": {
"type": "integer",
"description": "Starting year the book series was published",
"format": "int32"
},
"publishedYearTo": {
"type": "integer",
"description": "Ending year the book series was published",
"format": "int32"
},
"numberOfBooksFrom": {
"type": "integer",
"description": "Minimal number of books",
"format": "int32"
},
"numberOfBooksTo": {
"type": "integer",
"description": "Maximal number of books",
"format": "int32"
},
"yearFrom": {
"type": "integer",
"description": "Starting year of book series stories",
"format": "int32"
},
"yearTo": {
"type": "integer",
"description": "Ending year of book series stories",
"format": "int32"
},
"miniseries": {
"type": "boolean",
"description": "Whether it should be a miniseries"
},
"eBookSeries": {
"type": "boolean",
"description": "Whether it should be an e-book series"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookSeriesBaseResponse"
}
}
}
}
}
}
},
"/character": {
"get": {
"tags": ["Character"],
"description": "Retrival of a single character",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Character unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CharacterFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/character/search": {
"get": {
"tags": ["Character"],
"description": "Pagination over characters",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CharacterBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["Character"],
"description": "Searching characters",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"description": "Character name"
},
"gender": {
"type": "string",
"description": "Character gender"
},
"deceased": {
"type": "boolean",
"description": "Whether it should be a deceased character"
},
"hologram": {
"type": "boolean",
"description": "Whether it should be a hologram"
},
"fictionalCharacter": {
"type": "boolean",
"description": "Whether it should be a fictional character (from universe point of view)"
},
"mirror": {
"type": "boolean",
"description": "Whether it should be a mirror universe character"
},
"alternateReality": {
"type": "boolean",
"description": "Whether it should be a alternate reality character"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CharacterBaseResponse"
}
}
}
}
}
}
},
"/comics": {
"get": {
"tags": ["Comics"],
"description": "Retrival of a single comics",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Comics unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicsFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/comics/search": {
"get": {
"tags": ["Comics"],
"description": "Pagination over comics",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicsBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["Comics"],
"description": "Searching comics",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"description": "Comics title"
},
"publishedYearFrom": {
"type": "integer",
"description": "Starting year the comics was published",
"format": "int32"
},
"publishedYearTo": {
"type": "integer",
"description": "Ending year the comics was published",
"format": "int32"
},
"numberOfPagesFrom": {
"type": "integer",
"description": "Minimal number of pages",
"format": "int32"
},
"numberOfPagesTo": {
"type": "integer",
"description": "Maximal number of pages",
"format": "int32"
},
"stardateFrom": {
"type": "number",
"description": "Starting stardate of comics story",
"format": "float"
},
"stardateTo": {
"type": "number",
"description": "Ending stardate of comics story",
"format": "float"
},
"yearFrom": {
"type": "integer",
"description": "Starting year of comics story",
"format": "int32"
},
"yearTo": {
"type": "integer",
"description": "Ending year of comics story",
"format": "int32"
},
"photonovel": {
"type": "boolean",
"description": "Whether it should be a photonovel"
},
"adaptation": {
"type": "boolean",
"description": "Whether it should be an adaptation of an episode or a movie"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicsBaseResponse"
}
}
}
}
}
}
},
"/comicCollection": {
"get": {
"tags": ["ComicCollection"],
"description": "Retrival of a single comic collection",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Comic collection unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicCollectionFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/comicCollection/search": {
"get": {
"tags": ["ComicCollection"],
"description": "Pagination over comic collections",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicCollectionBaseResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": ["ComicCollection"],
"description": "Searching comic collections",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting, serialized like this: fieldName,ASC;anotherFieldName,DESC",
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"description": "Comic collection title"
},
"publishedYearFrom": {
"type": "integer",
"description": "Starting year the comic collection was published",
"format": "int32"
},
"publishedYearTo": {
"type": "integer",
"description": "Ending year the comic collection was published",
"format": "int32"
},
"numberOfPagesFrom": {
"type": "integer",
"description": "Minimal number of pages",
"format": "int32"
},
"numberOfPagesTo": {
"type": "integer",
"description": "Maximal number of pages",
"format": "int32"
},
"stardateFrom": {
"type": "number",
"description": "Starting stardate of comic collection stories",
"format": "float"
},
"stardateTo": {
"type": "number",
"description": "Ending stardate of comic collections stories",
"format": "float"
},
"yearFrom": {
"type": "integer",
"description": "Starting year of comic collection stories",
"format": "int32"
},
"yearTo": {
"type": "integer",
"description": "Ending year of comic collections stories",
"format": "int32"
},
"photonovel": {
"type": "boolean",
"description": "Whether it should be an photonovel collection"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicCollectionBaseResponse"
}
}
}
}
}
}
},
"/comicSeries": {
"get": {
"tags": ["ComicSeries"],
"description": "Retrival of a single comic series",
"parameters": [
{
"name": "uid",
"in": "query",
"description": "Comic series unique ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComicSeriesFullResponse"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/comicSeries/search": {
"get": {
"tags": ["ComicSeries"],
"description": "Pagination over comic series",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "apiKey",
"in": "query",
"description": "API key",
"schema": {
"t