From ab977d2986c70738525df871edf85723616e85ed Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 2 Oct 2025 19:04:00 +0200 Subject: [PATCH 1/3] Added the OpenAPI specification document into the library target. --- Sources/MarvelService/openapi.yaml | 5385 ++++++++++++++++++++++++++++ 1 file changed, 5385 insertions(+) create mode 100644 Sources/MarvelService/openapi.yaml diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml new file mode 100644 index 00000000..1377baa6 --- /dev/null +++ b/Sources/MarvelService/openapi.yaml @@ -0,0 +1,5385 @@ +# ===----------------------------------------------------------------------=== +# +# This source file is part of the MarvelService open source project +# +# Copyright (c) 2025 Röck+Cöde VoF. and the MarvelService project authors +# Licensed under the EUPL 1.2 or later. +# +# See LICENSE for license information +# See CONTRIBUTORS for the list of MarvelService project authors +# +# ===----------------------------------------------------------------------=== + +openapi: 3.1.0 +info: + title: gateway.marvel.com + description: The Marvel Comics RESTful API. + contact: + name: "Marvel Entertainment, LLC" + email: marvelsubs@midtowncomics.com + version: Cable +servers: +- url: https://gateway.marvel.com/ +tags: +- name: public +paths: + /v1/public/characters: + get: + tags: + - public + summary: Fetches lists of characters. + description: Fetches lists of comic characters with optional filters. See notes + on individual parameters below. + operationId: getCreatorCollection + parameters: + - name: name + in: query + description: Return only characters matching the specified full character + name (e.g. Spider-Man). + schema: + type: string + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only characters which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only characters which appear in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only characters which appear the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only characters which appear in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/characters/{characterId}: + get: + tags: + - public + summary: Fetches a single character by id. + description: This method fetches a single character resource. It is the canonical + URI for any character resource provided by the API. + operationId: getCharacterIndividual + parameters: + - name: characterId + in: path + description: A single character id. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/characters/{characterId}/comics: + get: + tags: + - public + summary: Fetches lists of comics filtered by a character id. + description: "Fetches lists of comics containing a specific character, with\ + \ optional filters. See notes on individual parameters below." + operationId: getComicsCharacterCollection + parameters: + - name: characterId + in: path + description: The character id. + required: true + schema: + type: integer + format: int32 + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: Exclude variant comics from the result set. + schema: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + schema: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + schema: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only comics which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only comics which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/characters/{characterId}/events: + get: + tags: + - public + summary: Fetches lists of events filtered by a character id. + description: "Fetches lists of events in which a specific character appears,\ + \ with optional filters. See notes on individual parameters below." + operationId: getCharacterEventsCollection + parameters: + - name: characterId + in: path + description: The character ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Filter the event list by name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only events which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only events which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: comics + in: query + description: Return only events which take place in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only events which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/characters/{characterId}/series: + get: + tags: + - public + summary: Fetches lists of series filtered by a character id. + description: "Fetches lists of comic series in which a specific character appears,\ + \ with optional filters. See notes on individual parameters below." + operationId: getCharacterSeriesCollection + parameters: + - name: characterId + in: path + description: The character ID + required: true + schema: + type: integer + format: int32 + - name: title + in: query + description: Filter by series title. + schema: + type: string + - name: titleStartsWith + in: query + description: Return series with titles that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only series which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only series which contain the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only series which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only series which have comics that take place during the + specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only series which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: seriesType + in: query + description: Filter the series by publication frequency type. + schema: + type: string + - name: contains + in: query + description: Return only series containing one or more comics with the specified + format. + style: form + explode: false + schema: + type: array + items: + type: string + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' + /v1/public/characters/{characterId}/stories: + get: + tags: + - public + summary: Fetches lists of stories filtered by a character id. + description: Fetches lists of comic stories featuring a specific character + with optional filters. See notes on individual parameters below. + operationId: getCharacterStoryCollection + parameters: + - name: characterId + in: path + description: The character ID. + required: true + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated + list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only stories contained the specified series (accepts a + comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only stories which take place during the specified events + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only stories which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/comics: + get: + tags: + - public + summary: Fetches lists of comics. + description: Fetches lists of comics with optional filters. See notes on individual + parameters below. + operationId: getComicsCollection + parameters: + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: "Exclude variants (alternate covers, secondary printings, director's\ + \ cuts, etc.) from the result set." + schema: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + schema: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + schema: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only comics which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only comics which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). Accepts a comma-separated + list of ids. + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). Accepts a + comma-separated list of ids. + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/comics/{comicId}: + get: + tags: + - public + summary: Fetches a single comic by id. + description: This method fetches a single comic resource. It is the canonical + URI for any comic resource provided by the API. + operationId: getComicIndividual + parameters: + - name: comicId + in: path + description: A single comic. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/comics/{comicId}/characters: + get: + tags: + - public + summary: Fetches lists of characters filtered by a comic id. + description: Fetches lists of characters which appear in a specific comic with + optional filters. See notes on individual parameters below. + operationId: getComicCharacterCollection + parameters: + - name: comicId + in: path + description: The comic id. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Return only characters matching the specified full character + name (e.g. Spider-Man). + schema: + type: string + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only characters which have been modified since the specified + date. + schema: + type: string + format: date + - name: series + in: query + description: Return only characters which appear the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only characters which appear comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/comics/{comicId}/creators: + get: + tags: + - public + summary: Fetches lists of creators filtered by a comic id. + description: "Fetches lists of comic creators whose work appears in a specific\ + \ comic, with optional filters. See notes on individual parameters below." + operationId: getCreatorRCollection + parameters: + - name: comicId + in: path + description: The comic id. + required: true + schema: + type: integer + format: int32 + - name: firstName + in: query + description: Filter by creator first name (e.g. brian). + schema: + type: string + - name: middleName + in: query + description: Filter by creator middle name (e.g. Michael). + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name (e.g. Bendis). + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera (e.g. B, St L)." + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera (e.g. B, St\ + \ L)." + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match critera (e.g. Mi). + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match critera (e.g. Ben). + schema: + type: string + - name: modifiedSince + in: query + description: Return only creators which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only creators who worked on in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only creators who worked on the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/comics/{comicId}/events: + get: + tags: + - public + summary: Fetches lists of events filtered by a comic id. + description: "Fetches lists of events in which a specific comic appears, with\ + \ optional filters. See notes on individual parameters below." + operationId: getIssueEventsCollection + parameters: + - name: comicId + in: path + description: The comic ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Filter the event list by name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only events which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only events which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only events which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only events which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/comics/{comicId}/stories: + get: + tags: + - public + summary: Fetches lists of stories filtered by a comic id. + description: "Fetches lists of comic stories in a specific comic issue, with\ + \ optional filters. See notes on individual parameters below." + operationId: getComicStoryCollection + parameters: + - name: comicId + in: path + description: The comic ID. + required: true + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: series + in: query + description: Return only stories contained the specified series (accepts a + comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only stories which take place during the specified events + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only stories which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/creators: + get: + tags: + - public + summary: Fetches lists of creators. + description: Fetches lists of comic creators with optional filters. See notes + on individual parameters below. + operationId: getCreatorXCollection + parameters: + - name: firstName + in: query + description: Filter by creator first name (e.g. Brian). + schema: + type: string + - name: middleName + in: query + description: Filter by creator middle name (e.g. Michael). + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name (e.g. Bendis). + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera (e.g. B, St L)." + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera (e.g. B, St\ + \ L)." + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match critera (e.g. Mi). + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match critera (e.g. Ben). + schema: + type: string + - name: modifiedSince + in: query + description: Return only creators which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only creators who worked on in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only creators who worked on the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only creators who worked on comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/creators/{creatorId}: + get: + tags: + - public + summary: Fetches a single creator by id. + description: This method fetches a single creator resource. It is the canonical + URI for any creator resource provided by the API. + operationId: getCreatorIndividual + parameters: + - name: creatorId + in: path + description: A single creator id. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/creators/{creatorId}/comics: + get: + tags: + - public + summary: Fetches lists of comics filtered by a creator id. + description: "Fetches lists of comics in which the work of a specific creator\ + \ appears, with optional filters. See notes on individual parameters below." + operationId: getComicsECollection + parameters: + - name: creatorId + in: path + description: The creator ID. + required: true + schema: + type: integer + format: int32 + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: Exclude variant comics from the result set. + schema: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + schema: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only comics which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/creators/{creatorId}/events: + get: + tags: + - public + summary: Fetches lists of events filtered by a creator id. + description: Fetches lists of events featuring the work of a specific creator + with optional filters. See notes on individual parameters below. + operationId: getCreatorEventsCollection + parameters: + - name: creatorId + in: path + description: The creator ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Filter the event list by name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: characters + in: query + description: Return only events which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only events which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: comics + in: query + description: Return only events which take place in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only events which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/creators/{creatorId}/series: + get: + tags: + - public + summary: Fetches lists of series filtered by a creator id. + description: "Fetches lists of comic series in which a specific creator's work\ + \ appears, with optional filters. See notes on individual parameters below." + operationId: getCreatorSeriesCollection + parameters: + - name: creatorId + in: path + description: The creator ID. + required: true + schema: + type: integer + format: int32 + - name: title + in: query + description: Filter by series title. + schema: + type: string + - name: titleStartsWith + in: query + description: Return series with titles that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only series which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only series which contain the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only series which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only series which have comics that take place during the + specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only series which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: seriesType + in: query + description: Filter the series by publication frequency type. + schema: + type: string + - name: contains + in: query + description: Return only series containing one or more comics with the specified + format. + style: form + explode: false + schema: + type: array + items: + type: string + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' + /v1/public/creators/{creatorId}/stories: + get: + tags: + - public + summary: Fetches lists of stories filtered by a creator id. + description: Fetches lists of comic stories by a specific creator with optional + filters. See notes on individual parameters below. + operationId: getCreatorStoryCollection + parameters: + - name: creatorId + in: path + description: The ID of the creator. + required: true + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only stories contained in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only stories contained the specified series (accepts a + comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only stories which take place during the specified events + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/events: + get: + tags: + - public + summary: Fetches lists of events. + description: Fetches lists of events with optional filters. See notes on individual + parameters below. + operationId: getEventsCollection + parameters: + - name: name + in: query + description: Return only events which match the specified name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only events which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only events which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only events which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: comics + in: query + description: Return only events which take place in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only events which take place in the specified stories + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/events/{eventId}: + get: + tags: + - public + summary: Fetches a single event by id. + description: This method fetches a single event resource. It is the canonical + URI for any event resource provided by the API. + operationId: getEventIndividual + parameters: + - name: eventId + in: path + description: A single event. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/events/{eventId}/characters: + get: + tags: + - public + summary: Fetches lists of characters filtered by an event id. + description: "Fetches lists of characters which appear in a specific event,\ + \ with optional filters. See notes on individual parameters below." + operationId: getEventCharacterCollection + parameters: + - name: eventId + in: path + description: The event ID + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Return only characters matching the specified full character + name (e.g. Spider-Man). + schema: + type: string + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only characters which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only characters which appear in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only characters which appear the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/events/{eventId}/comics: + get: + tags: + - public + summary: Fetches lists of comics filtered by an event id. + description: "Fetches lists of comics which take place during a specific event,\ + \ with optional filters. See notes on individual parameters below." + operationId: getComicsXCollection + parameters: + - name: eventId + in: path + description: The event id. + required: true + schema: + type: integer + format: int32 + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: Exclude variant comics from the result set. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + style: form + explode: false + schema: + type: array + items: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only comics which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only comics which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/events/{eventId}/creators: + get: + tags: + - public + summary: Fetches lists of creators filtered by an event id. + description: "Fetches lists of comic creators whose work appears in a specific\ + \ event, with optional filters. See notes on individual parameters below." + operationId: getCreatorZCollection + parameters: + - name: eventId + in: path + description: The event ID. + required: true + schema: + type: integer + format: int32 + - name: firstName + in: query + description: Filter by creator first name (e.g. brian). + schema: + type: string + - name: middleName + in: query + description: Filter by creator middle name (e.g. Michael). + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name (e.g. Bendis). + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera (e.g. B, St L)." + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera (e.g. B, St\ + \ L)." + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match critera (e.g. Mi). + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match critera (e.g. Ben). + schema: + type: string + - name: modifiedSince + in: query + description: Return only creators which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only creators who worked on in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only creators who worked on the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/events/{eventId}/series: + get: + tags: + - public + summary: Fetches lists of series filtered by an event id. + description: "Fetches lists of comic series in which a specific event takes\ + \ place, with optional filters. See notes on individual parameters below." + operationId: getEventSeriesCollection + parameters: + - name: eventId + in: path + description: The event ID. + required: true + schema: + type: integer + format: int32 + - name: title + in: query + description: Filter by series title. + schema: + type: string + - name: titleStartsWith + in: query + description: Return series with titles that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only series which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only series which contain the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only series which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only series which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only series which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: seriesType + in: query + description: Filter the series by publication frequency type. + schema: + type: string + - name: contains + in: query + description: Return only series containing one or more comics with the specified + format. + style: form + explode: false + schema: + type: array + items: + type: string + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' + /v1/public/events/{eventId}/stories: + get: + tags: + - public + summary: Fetches lists of stories filtered by an event id. + description: "Fetches lists of comic stories from a specific event, with optional\ + \ filters. See notes on individual parameters below." + operationId: getEventStoryCollection + parameters: + - name: eventId + in: path + description: The ID of the event. + required: true + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated + list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only stories contained the specified series (accepts a + comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only stories which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/series: + get: + tags: + - public + summary: Fetches lists of series. + description: Fetches lists of comic series with optional filters. See notes + on individual parameters below. + operationId: getSeriesCollection + parameters: + - name: title + in: query + description: Return only series matching the specified title. + schema: + type: string + - name: titleStartsWith + in: query + description: Return series with titles that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only series which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only series which contain the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only series which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only series which have comics that take place during the + specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only series which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only series which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: seriesType + in: query + description: Filter the series by publication frequency type. + schema: + type: string + - name: contains + in: query + description: Return only series containing one or more comics with the specified + format. + style: form + explode: false + schema: + type: array + items: + type: string + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' + /v1/public/series/{seriesId}: + get: + tags: + - public + summary: Fetches a single comic series by id. + description: This method fetches a single comic series resource. It is the + canonical URI for any comic series resource provided by the API. + operationId: getSeriesIndividual + parameters: + - name: seriesId + in: path + description: Filter by series title. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' + /v1/public/series/{seriesId}/characters: + get: + tags: + - public + summary: Fetches lists of characters filtered by a series id. + description: "Fetches lists of characters which appear in specific series, with\ + \ optional filters. See notes on individual parameters below." + operationId: getSeriesCharacterWrapper + parameters: + - name: seriesId + in: path + description: The series id. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Return only characters matching the specified full character + name (e.g. Spider-Man). + schema: + type: string + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only characters which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only characters which appear in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only characters which appear comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/series/{seriesId}/comics: + get: + tags: + - public + summary: Fetches lists of comics filtered by a series id. + description: "Fetches lists of comics which are published as part of a specific\ + \ series, with optional filters. See notes on individual parameters below." + operationId: getComicsZCollection + parameters: + - name: seriesId + in: path + description: The series ID. + required: true + schema: + type: integer + format: int32 + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: Exclude variant comics from the result set. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + style: form + explode: false + schema: + type: array + items: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only comics which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/series/{seriesId}/creators: + get: + tags: + - public + summary: Fetches lists of creators filtered by a series id. + description: "Fetches lists of comic creators whose work appears in a specific\ + \ series, with optional filters. See notes on individual parameters below." + operationId: getCreatorCCollection + parameters: + - name: seriesId + in: path + description: The series ID. + required: true + schema: + type: integer + format: int32 + - name: firstName + in: query + description: Filter by creator first name (e.g. brian). + schema: + type: string + - name: middleName + in: query + description: Filter by creator middle name (e.g. Michael). + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name (e.g. Bendis). + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera (e.g. B, St L)." + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera (e.g. B, St\ + \ L)." + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match critera (e.g. Mi). + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match critera (e.g. Ben). + schema: + type: string + - name: modifiedSince + in: query + description: Return only creators which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only creators who worked on in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only creators who worked on comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/series/{seriesId}/events: + get: + tags: + - public + summary: Fetches lists of events filtered by a series id. + description: "Fetches lists of events which occur in a specific series, with\ + \ optional filters. See notes on individual parameters below." + operationId: getEventsWCollection + parameters: + - name: seriesId + in: path + description: The series ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Filter the event list by name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only events which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only events which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: comics + in: query + description: Return only events which take place in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: stories + in: query + description: Return only events which contain the specified stories (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/series/{seriesId}/stories: + get: + tags: + - public + summary: Fetches lists of stories filtered by a series id. + description: Fetches lists of comic stories from a specific series with optional + filters. See notes on individual parameters below. + operationId: getSeriesStoryCollection + parameters: + - name: seriesId + in: path + description: The series ID. + required: true + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated + list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only stories which take place during the specified events + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only stories which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/stories: + get: + tags: + - public + summary: Fetches lists of stories. + description: Fetches lists of comic stories with optional filters. See notes + on individual parameters below. + operationId: getStoryCollection + parameters: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated + list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only stories contained the specified series (accepts a + comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only stories which take place during the specified events + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only stories which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/stories/{storyId}: + get: + tags: + - public + summary: Fetches a single comic story by id. + description: This method fetches a single comic story resource. It is the canonical + URI for any comic story resource provided by the API. + operationId: getStoryIndividual + parameters: + - name: storyId + in: path + description: Filter by story id. + required: true + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/StoryDataWrapper' + /v1/public/stories/{storyId}/characters: + get: + tags: + - public + summary: Fetches lists of characters filtered by a story id. + description: "Fetches lists of comic characters appearing in a single story,\ + \ with optional filters. See notes on individual parameters below." + operationId: getCreatorVCollection + parameters: + - name: storyId + in: path + description: The story ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Return only characters matching the specified full character + name (e.g. Spider-Man). + schema: + type: string + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only characters which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only characters which appear in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only characters which appear the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only characters which appear comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CharacterDataWrapper' + /v1/public/stories/{storyId}/comics: + get: + tags: + - public + summary: Fetches lists of comics filtered by a story id. + description: "Fetches lists of comics in which a specific story appears, with\ + \ optional filters. See notes on individual parameters below." + operationId: getComicsCCollection + parameters: + - name: storyId + in: path + description: The story ID. + required: true + schema: + type: integer + format: int32 + - name: format + in: query + description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + schema: + type: string + - name: formatType + in: query + description: Filter by the issue format type (comic or collection). + schema: + type: string + - name: noVariants + in: query + description: Exclude variant comics from the result set. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + style: form + explode: false + schema: + type: array + items: + type: string + - name: dateRange + in: query + description: "Return comics within a predefined date range. Dates must be\ + \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ + \ formatted as YYYY-MM-DD but may be sent as any common date format." + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Return only issues in series whose title matches the input. + schema: + type: string + - name: titleStartsWith + in: query + description: Return only issues in series whose title starts with the input. + schema: + type: string + - name: startYear + in: query + description: Return only issues in series whose start year matches the input. + schema: + type: integer + format: int32 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + schema: + type: integer + format: int32 + - name: diamondCode + in: query + description: Filter by diamond code. + schema: + type: string + - name: digitalId + in: query + description: Filter by digital comic id. + schema: + type: integer + format: int32 + - name: upc + in: query + description: Filter by UPC. + schema: + type: string + - name: isbn + in: query + description: Filter by ISBN. + schema: + type: string + - name: ean + in: query + description: Filter by EAN. + schema: + type: string + - name: issn + in: query + description: Filter by ISSN. + schema: + type: string + - name: hasDigitalIssue + in: query + description: Include only results which are available digitally. + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: modifiedSince + in: query + description: Return only comics which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only comics which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only comics which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only comics which take place in the specified events (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: sharedAppearances + in: query + description: Return only comics in which the specified characters appear together + (for example in which BOTH Spider-Man and Wolverine appear). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: collaborators + in: query + description: Return only comics in which the specified creators worked together + (for example in which BOTH Stan Lee and Jack Kirby did work). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/ComicDataWrapper' + /v1/public/stories/{storyId}/creators: + get: + tags: + - public + summary: Fetches lists of creators filtered by a story id. + description: "Fetches lists of comic creators whose work appears in a specific\ + \ story, with optional filters. See notes on individual parameters below." + operationId: getCreatorQCollection + parameters: + - name: storyId + in: path + description: The story ID. + required: true + schema: + type: integer + format: int32 + - name: firstName + in: query + description: Filter by creator first name (e.g. brian). + schema: + type: string + - name: middleName + in: query + description: Filter by creator middle name (e.g. Michael). + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name (e.g. Bendis). + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera (e.g. B, St L)." + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera (e.g. B, St\ + \ L)." + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match critera (e.g. Mi). + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match critera (e.g. Ben). + schema: + type: string + - name: modifiedSince + in: query + description: Return only creators which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only creators who worked on in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only creators who worked on the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: events + in: query + description: Return only creators who worked on comics that took place in + the specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/CreatorDataWrapper' + /v1/public/stories/{storyId}/events: + get: + tags: + - public + summary: Fetches lists of events filtered by a story id. + description: "Fetches lists of events in which a specific story appears, with\ + \ optional filters. See notes on individual parameters below." + operationId: getEventsZCollection + parameters: + - name: storyId + in: path + description: The story ID. + required: true + schema: + type: integer + format: int32 + - name: name + in: query + description: Filter the event list by name. + schema: + type: string + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: modifiedSince + in: query + description: Return only events which have been modified since the specified + date. + schema: + type: string + format: date + - name: creators + in: query + description: Return only events which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only events which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: series + in: query + description: Return only events which are part of the specified series (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: comics + in: query + description: Return only events which take place in the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/EventDataWrapper' + /v1/public/stories/{storyId}/series: + get: + tags: + - public + summary: Fetches lists of series filtered by a story id. + description: Fetches lists of comic series in which the specified story takes + place. See notes on individual parameters below. + operationId: getStorySeriesCollection + parameters: + - name: storyId + in: path + description: The story ID. + required: true + schema: + type: integer + format: int32 + - name: events + in: query + description: Return only series which have comics that take place during the + specified events (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: title + in: query + description: Filter by series title. + schema: + type: string + - name: titleStartsWith + in: query + description: Return series with titles that begin with the specified string + (e.g. Sp). + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + schema: + type: integer + format: int32 + - name: modifiedSince + in: query + description: Return only series which have been modified since the specified + date. + schema: + type: string + format: date + - name: comics + in: query + description: Return only series which contain the specified comics (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: creators + in: query + description: Return only series which feature work by the specified creators + (accepts a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: characters + in: query + description: Return only series which feature the specified characters (accepts + a comma-separated list of ids). + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + - name: seriesType + in: query + description: Filter the series by publication frequency type. + schema: + type: string + - name: contains + in: query + description: Return only series containing one or more comics with the specified + format. + style: form + explode: false + schema: + type: array + items: + type: string + - name: orderBy + in: query + description: Order the result set by a field or fields. Add a "-" to the value + sort in descending order. Multiple values are given priority in the order + in which they are passed. + style: form + explode: false + schema: + type: array + items: + type: string + - name: limit + in: query + description: Limit the result set to the specified number of resources. + schema: + type: integer + format: int32 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + schema: + type: integer + format: int32 + responses: + "200": + description: No response was specified + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesDataWrapper' +components: + schemas: + ComicList: + type: object + properties: + available: + type: integer + description: The number of total available issues in this list. Will always + be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of issues returned in this collection (up to 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of issues in this collection. + items: + type: array + description: The list of returned issues in this collection. + items: + $ref: '#/components/schemas/ComicSummary' + EventList: + type: object + properties: + available: + type: integer + description: The number of total available events in this list. Will always + be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of events returned in this collection (up to 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of events in this collection. + items: + type: array + description: The list of returned events in this collection. + items: + $ref: '#/components/schemas/EventSummary' + CreatorList: + type: object + properties: + available: + type: integer + description: The number of total available creators in this list. Will always + be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of creators returned in this collection (up to 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of creators in this collection. + items: + type: array + description: The list of returned creators in this collection. + items: + $ref: '#/components/schemas/CreatorSummary' + CharacterList: + type: object + properties: + available: + type: integer + description: The number of total available characters in this list. Will + always be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of characters returned in this collection (up to + 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of characters in this collection. + items: + type: array + description: The list of returned characters in this collection. + items: + $ref: '#/components/schemas/CharacterSummary' + SeriesList: + type: object + properties: + available: + type: integer + description: The number of total available series in this list. Will always + be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of series returned in this collection (up to 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of series in this collection. + items: + type: array + description: The list of returned series in this collection. + items: + $ref: '#/components/schemas/SeriesSummary' + StoryList: + type: object + properties: + available: + type: integer + description: The number of total available stories in this list. Will always + be greater than or equal to the "returned" value. + format: int32 + returned: + type: integer + description: The number of stories returned in this collection (up to 20). + format: int32 + collectionURI: + type: string + description: The path to the full list of stories in this collection. + items: + type: array + description: The list of returned stories in this collection. + items: + $ref: '#/components/schemas/StorySummary' + CharacterSummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual character resource. + name: + type: string + description: The full name of the character. + role: + type: string + description: The role of the creator in the parent entity. + EventSummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual event resource. + name: + type: string + description: The name of the event. + SeriesSummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual series resource. + name: + type: string + description: The canonical name of the series. + ComicSummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual comic resource. + name: + type: string + description: The canonical name of the comic. + Url: + type: object + properties: + type: + type: string + description: A text identifier for the URL. + url: + type: string + description: "A full URL (including scheme, domain, and path)." + CreatorSummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual creator resource. + name: + type: string + description: The full name of the creator. + role: + type: string + description: The role of the creator in the parent entity. + StorySummary: + type: object + properties: + resourceURI: + type: string + description: The path to the individual story resource. + name: + type: string + description: The canonical name of the story. + type: + type: string + description: The type of the story (interior or cover). + Image: + type: object + properties: + path: + type: string + description: The directory path of to the image. + extension: + type: string + description: The file extension for the image. + ComicDate: + type: object + properties: + type: + type: string + description: "A description of the date (e.g. onsale date, FOC date)." + date: + type: string + description: The date. + format: date + CharacterDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of characters returned by the call. + items: + $ref: '#/components/schemas/Character' + EventDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of events returned by the call + items: + $ref: '#/components/schemas/Event' + ComicPrice: + type: object + properties: + type: + type: string + description: "A description of the price (e.g. print price, digital price)." + price: + type: number + description: The price (all prices in USD). + format: float + EventDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/EventDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + Creator: + type: object + properties: + id: + type: integer + description: The unique ID of the creator resource. + format: int32 + firstName: + type: string + description: The first name of the creator. + middleName: + type: string + description: The middle name of the creator. + lastName: + type: string + description: The last name of the creator. + suffix: + type: string + description: The suffix or honorific for the creator. + fullName: + type: string + description: The full name of the creator (a space-separated concatenation + of the above four fields). + modified: + type: string + description: The date the resource was most recently modified. + format: date + resourceURI: + type: string + description: The canonical URL identifier for this resource. + urls: + type: array + description: A set of public web site URLs for the resource. + items: + $ref: '#/components/schemas/Url' + thumbnail: + $ref: '#/components/schemas/Image' + series: + $ref: '#/components/schemas/SeriesList' + stories: + $ref: '#/components/schemas/StoryList' + comics: + $ref: '#/components/schemas/ComicList' + events: + $ref: '#/components/schemas/EventList' + Event: + type: object + properties: + id: + type: integer + description: The unique ID of the event resource. + format: int32 + title: + type: string + description: The title of the event. + description: + type: string + description: A description of the event. + resourceURI: + type: string + description: The canonical URL identifier for this resource. + urls: + type: array + description: A set of public web site URLs for the event. + items: + $ref: '#/components/schemas/Url' + modified: + type: string + description: The date the resource was most recently modified. + format: date + start: + type: string + description: The date of publication of the first issue in this event. + format: date + end: + type: string + description: The date of publication of the last issue in this event. + format: date + thumbnail: + $ref: '#/components/schemas/Image' + comics: + $ref: '#/components/schemas/ComicList' + stories: + $ref: '#/components/schemas/StoryList' + series: + $ref: '#/components/schemas/SeriesList' + characters: + $ref: '#/components/schemas/CharacterList' + creators: + $ref: '#/components/schemas/CreatorList' + next: + $ref: '#/components/schemas/EventSummary' + previous: + $ref: '#/components/schemas/EventSummary' + ComicDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of comics returned by the call + items: + $ref: '#/components/schemas/Comic' + TextObject: + type: object + properties: + type: + type: string + description: "The canonical type of the text object (e.g. solicit text,\ + \ preview text, etc.)." + language: + type: string + description: The IETF language tag denoting the language the text object + is written in. + text: + type: string + description: The text. + CreatorDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/CreatorDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + StoryDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/StoryDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + Character: + type: object + properties: + id: + type: integer + description: The unique ID of the character resource. + format: int32 + name: + type: string + description: The name of the character. + description: + type: string + description: A short bio or description of the character. + modified: + type: string + description: The date the resource was most recently modified. + format: date + resourceURI: + type: string + description: The canonical URL identifier for this resource. + urls: + type: array + description: A set of public web site URLs for the resource. + items: + $ref: '#/components/schemas/Url' + thumbnail: + $ref: '#/components/schemas/Image' + comics: + $ref: '#/components/schemas/ComicList' + stories: + $ref: '#/components/schemas/StoryList' + events: + $ref: '#/components/schemas/EventList' + series: + $ref: '#/components/schemas/SeriesList' + CharacterDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/CharacterDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + ComicDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/ComicDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + Series: + type: object + properties: + id: + type: integer + description: The unique ID of the series resource. + format: int32 + title: + type: string + description: The canonical title of the series. + description: + type: string + description: A description of the series. + resourceURI: + type: string + description: The canonical URL identifier for this resource. + urls: + type: array + description: A set of public web site URLs for the resource. + items: + $ref: '#/components/schemas/Url' + startYear: + type: integer + description: The first year of publication for the series. + format: int32 + endYear: + type: integer + description: "The last year of publication for the series (conventionally,\ + \ 2099 for ongoing series) ." + format: int32 + rating: + type: string + description: The age-appropriateness rating for the series. + modified: + type: string + description: The date the resource was most recently modified. + format: date + thumbnail: + $ref: '#/components/schemas/Image' + comics: + $ref: '#/components/schemas/ComicList' + stories: + $ref: '#/components/schemas/StoryList' + events: + $ref: '#/components/schemas/EventList' + characters: + $ref: '#/components/schemas/CharacterList' + creators: + $ref: '#/components/schemas/CreatorList' + next: + $ref: '#/components/schemas/SeriesSummary' + previous: + $ref: '#/components/schemas/SeriesSummary' + SeriesDataWrapper: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + format: int32 + status: + type: string + description: A string description of the call status. + copyright: + type: string + description: The copyright notice for the returned result. + attributionText: + type: string + description: The attribution notice for this result. Please display either + this notice or the contents of the attributionHTML field on all screens + which contain data from the Marvel Comics API. + attributionHTML: + type: string + description: An HTML representation of the attribution notice for this result. Please + display either this notice or the contents of the attributionText field + on all screens which contain data from the Marvel Comics API. + data: + $ref: '#/components/schemas/SeriesDataContainer' + etag: + type: string + description: A digest value of the content returned by the call. + SeriesDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of series returned by the call + items: + $ref: '#/components/schemas/Series' + StoryDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of stories returned by the call + items: + $ref: '#/components/schemas/Story' + Comic: + type: object + properties: + id: + type: integer + description: The unique ID of the comic resource. + format: int32 + digitalId: + type: integer + description: The ID of the digital comic representation of this comic. Will + be 0 if the comic is not available digitally. + format: int32 + title: + type: string + description: The canonical title of the comic. + issueNumber: + type: number + description: The number of the issue in the series (will generally be 0 + for collection formats). + format: double + variantDescription: + type: string + description: "If the issue is a variant (e.g. an alternate cover, second\ + \ printing, or director’s cut), a text description of the variant." + description: + type: string + description: The preferred description of the comic. + modified: + type: string + description: The date the resource was most recently modified. + format: date + isbn: + type: string + description: The ISBN for the comic (generally only populated for collection + formats). + upc: + type: string + description: The UPC barcode number for the comic (generally only populated + for periodical formats). + diamondCode: + type: string + description: The Diamond code for the comic. + ean: + type: string + description: The EAN barcode for the comic. + issn: + type: string + description: The ISSN barcode for the comic. + format: + type: string + description: "The publication format of the comic e.g. comic, hardcover,\ + \ trade paperback." + pageCount: + type: integer + description: The number of story pages in the comic. + format: int32 + textObjects: + type: array + description: A set of descriptive text blurbs for the comic. + items: + $ref: '#/components/schemas/TextObject' + resourceURI: + type: string + description: The canonical URL identifier for this resource. + urls: + type: array + description: A set of public web site URLs for the resource. + items: + $ref: '#/components/schemas/Url' + series: + $ref: '#/components/schemas/SeriesSummary' + variants: + type: array + description: A list of variant issues for this comic (includes the "original" + issue if the current issue is a variant). + items: + $ref: '#/components/schemas/ComicSummary' + collections: + type: array + description: A list of collections which include this comic (will generally + be empty if the comic's format is a collection). + items: + $ref: '#/components/schemas/ComicSummary' + collectedIssues: + type: array + description: A list of issues collected in this comic (will generally be + empty for periodical formats such as "comic" or "magazine"). + items: + $ref: '#/components/schemas/ComicSummary' + dates: + type: array + description: A list of key dates for this comic. + items: + $ref: '#/components/schemas/ComicDate' + prices: + type: array + description: A list of prices for this comic. + items: + $ref: '#/components/schemas/ComicPrice' + thumbnail: + $ref: '#/components/schemas/Image' + images: + type: array + description: A list of promotional images associated with this comic. + items: + $ref: '#/components/schemas/Image' + creators: + $ref: '#/components/schemas/CreatorList' + characters: + $ref: '#/components/schemas/CharacterList' + stories: + $ref: '#/components/schemas/StoryList' + events: + $ref: '#/components/schemas/EventList' + CreatorDataContainer: + type: object + properties: + offset: + type: integer + description: The requested offset (number of skipped results) of the call. + format: int32 + limit: + type: integer + description: The requested result limit. + format: int32 + total: + type: integer + description: The total number of resources available given the current filter + set. + format: int32 + count: + type: integer + description: The total number of results returned by this call. + format: int32 + results: + type: array + description: The list of creators returned by the call. + items: + $ref: '#/components/schemas/Creator' + Story: + type: object + properties: + id: + type: integer + description: The unique ID of the story resource. + format: int32 + title: + type: string + description: The story title. + description: + type: string + description: A short description of the story. + resourceURI: + type: string + description: 'The canonical URL identifier for this resource. ' + type: + type: string + description: "The story type e.g. interior story, cover, text story." + modified: + type: string + description: The date the resource was most recently modified. + format: date + thumbnail: + $ref: '#/components/schemas/Image' + comics: + $ref: '#/components/schemas/ComicList' + series: + $ref: '#/components/schemas/SeriesList' + events: + $ref: '#/components/schemas/EventList' + characters: + $ref: '#/components/schemas/CharacterList' + creators: + $ref: '#/components/schemas/CreatorList' + originalissue: + $ref: '#/components/schemas/ComicSummary' +x-original-swagger-version: "2.0" -- 2.52.0 From 24fecd5d56206e4248c4063725cbc8387ac1b40c Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 2 Oct 2025 19:04:34 +0200 Subject: [PATCH 2/3] Added the open-api-generator-config.yaml file into the library target. --- .../MarvelService/openapi-generator-config.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Sources/MarvelService/openapi-generator-config.yaml diff --git a/Sources/MarvelService/openapi-generator-config.yaml b/Sources/MarvelService/openapi-generator-config.yaml new file mode 100644 index 00000000..74fe6e1a --- /dev/null +++ b/Sources/MarvelService/openapi-generator-config.yaml @@ -0,0 +1,17 @@ +# ===----------------------------------------------------------------------=== +# +# This source file is part of the MarvelService open source project +# +# Copyright (c) 2025 Röck+Cöde VoF. and the MarvelService project authors +# Licensed under the EUPL 1.2 or later. +# +# See LICENSE for license information +# See CONTRIBUTORS for the list of MarvelService project authors +# +# ===----------------------------------------------------------------------=== + +generate: + - types + - client +namingStrategy: defensive +accessModifier: public -- 2.52.0 From 51b11cf5d2d3610b7c2c58ed3ff1d3b6cf65f09a Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Fri, 3 Oct 2025 02:05:46 +0200 Subject: [PATCH 3/3] Improved upon the OpenAPI specification document. --- Sources/MarvelService/openapi.yaml | 1776 +++++++++++++++++----------- 1 file changed, 1083 insertions(+), 693 deletions(-) diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml index 1377baa6..b01b4231 100644 --- a/Sources/MarvelService/openapi.yaml +++ b/Sources/MarvelService/openapi.yaml @@ -15,46 +15,58 @@ info: title: gateway.marvel.com description: The Marvel Comics RESTful API. contact: - name: "Marvel Entertainment, LLC" - email: marvelsubs@midtowncomics.com + name: Marvel Entertainment, LLC + url: https://help.marvel.com/hc/en-us/requests/new?ticket_form_id=32531283865236 + termsOfService: https://developer.marvel.com/terms version: Cable servers: - url: https://gateway.marvel.com/ + description: Live service tags: -- name: public +- name: characters + description: Group of endpoints that returns characters. +- name: comics + description: Group of endpoints that returns comics. +- name: creators + description: Group of endpoints that returns creators. +- name: events + description: Group of endpoints that returns events. +- name: series + description: Group of endpoints that returns series. +- name: stories + description: Group of endpoints that returns stories. paths: /v1/public/characters: get: tags: - - public + - characters summary: Fetches lists of characters. - description: Fetches lists of comic characters with optional filters. See notes - on individual parameters below. - operationId: getCreatorCollection + description: Fetches lists of comic characters with optional filters. + operationId: getCharacters parameters: - name: name in: query - description: Return only characters matching the specified full character - name (e.g. Spider-Man). + description: Return only characters matching the specified full character name (e.g. Spider-Man). + required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string - (e.g. Sp). + description: Return characters with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only characters which have been modified since the specified - date. + description: Return only characters which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only characters which appear in the specified comics (accepts - a comma-separated list of ids). + description: Return only characters which appear in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -64,8 +76,8 @@ paths: format: int32 - name: series in: query - description: Return only characters which appear the specified series (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -75,8 +87,8 @@ paths: format: int32 - name: events in: query - description: Return only characters which appear in the specified events (accepts - a comma-separated list of ids). + description: Return only characters which appear in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -86,8 +98,8 @@ paths: format: int32 - name: stories in: query - description: Return only characters which appear the specified stories (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -97,9 +109,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -109,30 +120,37 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/characters/{characterId}: get: tags: - - public + - characters summary: Fetches a single character by id. - description: This method fetches a single character resource. It is the canonical - URI for any character resource provided by the API. - operationId: getCharacterIndividual + description: This method fetches a single character resource. It is the canonical URI for any character resource provided by the API. + operationId: getCharacterById parameters: - name: characterId in: path @@ -143,19 +161,24 @@ paths: format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/characters/{characterId}/comics: get: tags: - - public + - comics summary: Fetches lists of comics filtered by a character id. - description: "Fetches lists of comics containing a specific character, with\ - \ optional filters. See notes on individual parameters below." - operationId: getComicsCharacterCollection + description: "Fetches lists of comics containing a specific character, with optional filters." + operationId: getComicsByCharacterId parameters: - name: characterId in: path @@ -167,28 +190,31 @@ paths: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query description: Exclude variant comics from the result set. + required: false schema: type: boolean - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false schema: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -199,72 +225,83 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false schema: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only comics which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only comics which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -274,8 +311,8 @@ paths: format: int32 - name: series in: query - description: Return only comics which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -285,8 +322,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -296,8 +333,8 @@ paths: format: int32 - name: stories in: query - description: Return only comics which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -307,8 +344,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). + required: false style: form explode: false schema: @@ -318,8 +355,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). + required: false style: form explode: false schema: @@ -329,9 +366,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -341,30 +377,38 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/characters/{characterId}/events: get: tags: - - public + - events summary: Fetches lists of events filtered by a character id. description: "Fetches lists of events in which a specific character appears,\ - \ with optional filters. See notes on individual parameters below." - operationId: getCharacterEventsCollection + \ with optional filters." + operationId: getEventsByCharacterId parameters: - name: characterId in: path @@ -376,25 +420,26 @@ paths: - name: name in: query description: Filter the event list by name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only events which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only events which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -404,8 +449,8 @@ paths: format: int32 - name: series in: query - description: Return only events which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only events which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -415,8 +460,8 @@ paths: format: int32 - name: comics in: query - description: Return only events which take place in the specified comics (accepts - a comma-separated list of ids). + description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -426,8 +471,8 @@ paths: format: int32 - name: stories in: query - description: Return only events which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -437,9 +482,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -449,12 +493,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -465,14 +511,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/characters/{characterId}/series: get: tags: - - public + - series summary: Fetches lists of series filtered by a character id. - description: "Fetches lists of comic series in which a specific character appears,\ - \ with optional filters. See notes on individual parameters below." - operationId: getCharacterSeriesCollection + description: "Fetches lists of comic series in which a specific character appears, with optional filters. See notes on individual parameters below." + operationId: getSeriesByCharacterId parameters: - name: characterId in: path @@ -484,31 +535,33 @@ paths: - name: title in: query description: Filter by series title. + required: false schema: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string - (e.g. Sp). + description: Return series with titles that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: startYear in: query description: Return only series matching the specified start year. + required: false schema: type: integer format: int32 - name: modifiedSince in: query - description: Return only series which have been modified since the specified - date. + description: Return only series which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only series which contain the specified comics (accepts - a comma-separated list of ids). + description: Return only series which contain the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -518,8 +571,8 @@ paths: format: int32 - name: stories in: query - description: Return only series which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -529,8 +582,8 @@ paths: format: int32 - name: events in: query - description: Return only series which have comics that take place during the - specified events (accepts a comma-separated list of ids). + description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -540,8 +593,8 @@ paths: format: int32 - name: creators in: query - description: Return only series which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -552,12 +605,13 @@ paths: - name: seriesType in: query description: Filter the series by publication frequency type. + required: false schema: type: string - name: contains in: query - description: Return only series containing one or more comics with the specified - format. + description: Return only series containing one or more comics with the specified format. + required: false style: form explode: false schema: @@ -566,9 +620,8 @@ paths: type: string - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -578,12 +631,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -594,14 +649,19 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/characters/{characterId}/stories: get: tags: - - public + - stories summary: Fetches lists of stories filtered by a character id. - description: Fetches lists of comic stories featuring a specific character - with optional filters. See notes on individual parameters below. - operationId: getCharacterStoryCollection + description: Fetches lists of comic stories featuring a specific character with optional filters. + operationId: getStoriesByCharacterId parameters: - name: characterId in: path @@ -612,15 +672,15 @@ paths: format: int32 - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only stories contained in the specified (accepts a comma-separated - list of ids). + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -630,8 +690,8 @@ paths: format: int32 - name: series in: query - description: Return only stories contained the specified series (accepts a - comma-separated list of ids). + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -641,8 +701,8 @@ paths: format: int32 - name: events in: query - description: Return only stories which take place during the specified events - (accepts a comma-separated list of ids). + description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -652,8 +712,8 @@ paths: format: int32 - name: creators in: query - description: Return only stories which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -663,9 +723,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -675,12 +734,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -691,41 +752,48 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics: get: tags: - - public + - comics summary: Fetches lists of comics. - description: Fetches lists of comics with optional filters. See notes on individual - parameters below. - operationId: getComicsCollection + description: Fetches lists of comics with optional filters. + operationId: getComics parameters: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query - description: "Exclude variants (alternate covers, secondary printings, director's\ - \ cuts, etc.) from the result set." + description: "Exclude variants (alternate covers, secondary printings, director's cuts, etc.) from the result set." + required: false schema: type: boolean - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false schema: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -736,72 +804,83 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false schema: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only comics which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only comics which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -811,8 +890,8 @@ paths: format: int32 - name: characters in: query - description: Return only comics which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -822,8 +901,8 @@ paths: format: int32 - name: series in: query - description: Return only comics which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -833,8 +912,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -844,8 +923,8 @@ paths: format: int32 - name: stories in: query - description: Return only comics which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -855,9 +934,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). Accepts a comma-separated - list of ids. + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). Accepts a comma-separated list of ids. + required: false style: form explode: false schema: @@ -867,9 +945,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). Accepts a - comma-separated list of ids. + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). Accepts a comma-separated list of ids. + required: false style: form explode: false schema: @@ -879,9 +956,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -891,12 +967,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -907,14 +985,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics/{comicId}: get: tags: - - public + - comics summary: Fetches a single comic by id. - description: This method fetches a single comic resource. It is the canonical - URI for any comic resource provided by the API. - operationId: getComicIndividual + description: This method fetches a single comic resource. It is the canonical URI for any comic resource provided by the API. + operationId: getComicById parameters: - name: comicId in: path @@ -930,14 +1013,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics/{comicId}/characters: get: tags: - - public + - characters summary: Fetches lists of characters filtered by a comic id. - description: Fetches lists of characters which appear in a specific comic with - optional filters. See notes on individual parameters below. - operationId: getComicCharacterCollection + description: Fetches lists of characters which appear in a specific comic with optional filters. + operationId: getCharactersByComicId parameters: - name: comicId in: path @@ -948,27 +1036,27 @@ paths: format: int32 - name: name in: query - description: Return only characters matching the specified full character - name (e.g. Spider-Man). + description: Return only characters matching the specified full character name (e.g. Spider-Man). + required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string - (e.g. Sp). + description: Return characters with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only characters which have been modified since the specified - date. + description: Return only characters which have been modified since the specified date. + required: false schema: type: string format: date - name: series in: query - description: Return only characters which appear the specified series (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -978,8 +1066,8 @@ paths: format: int32 - name: events in: query - description: Return only characters which appear comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -989,8 +1077,8 @@ paths: format: int32 - name: stories in: query - description: Return only characters which appear the specified stories (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1000,9 +1088,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1012,12 +1099,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1028,14 +1117,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics/{comicId}/creators: get: tags: - - public + - creators summary: Fetches lists of creators filtered by a comic id. - description: "Fetches lists of comic creators whose work appears in a specific\ - \ comic, with optional filters. See notes on individual parameters below." - operationId: getCreatorRCollection + description: "Fetches lists of comic creators whose work appears in a specific comic, with optional filters." + operationId: getCreatorsByComicId parameters: - name: comicId in: path @@ -1047,55 +1141,62 @@ paths: - name: firstName in: query description: Filter by creator first name (e.g. brian). + required: false schema: type: string - name: middleName in: query description: Filter by creator middle name (e.g. Michael). + required: false schema: type: string - name: lastName in: query description: Filter by creator last name (e.g. Bendis). + required: false schema: type: string - name: suffix in: query description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + required: false schema: type: string - name: nameStartsWith in: query description: "Filter by creator names that match critera (e.g. B, St L)." + required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St\ - \ L)." + description: "Filter by creator first names that match critera (e.g. B, St L)." + required: false schema: type: string - name: middleNameStartsWith in: query description: Filter by creator middle names that match critera (e.g. Mi). + required: false schema: type: string - name: lastNameStartsWith in: query description: Filter by creator last names that match critera (e.g. Ben). + required: false schema: type: string - name: modifiedSince in: query - description: Return only creators which have been modified since the specified - date. + description: Return only creators which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only creators who worked on in the specified comics (accepts - a comma-separated list of ids). + description: Return only creators who worked on in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1105,8 +1206,8 @@ paths: format: int32 - name: series in: query - description: Return only creators who worked on the specified series (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1116,8 +1217,8 @@ paths: format: int32 - name: stories in: query - description: Return only creators who worked on the specified stories (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1127,9 +1228,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1139,12 +1239,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1155,14 +1257,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics/{comicId}/events: get: tags: - - public + - events summary: Fetches lists of events filtered by a comic id. - description: "Fetches lists of events in which a specific comic appears, with\ - \ optional filters. See notes on individual parameters below." - operationId: getIssueEventsCollection + description: "Fetches lists of events in which a specific comic appears, with optional filters." + operationId: getEventsByComicId parameters: - name: comicId in: path @@ -1174,25 +1281,26 @@ paths: - name: name in: query description: Filter the event list by name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only events which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only events which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1202,8 +1310,8 @@ paths: format: int32 - name: characters in: query - description: Return only events which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1213,8 +1321,8 @@ paths: format: int32 - name: series in: query - description: Return only events which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only events which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1224,8 +1332,8 @@ paths: format: int32 - name: stories in: query - description: Return only events which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1235,9 +1343,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1247,12 +1354,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1263,14 +1372,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/comics/{comicId}/stories: get: tags: - - public + - stories summary: Fetches lists of stories filtered by a comic id. - description: "Fetches lists of comic stories in a specific comic issue, with\ - \ optional filters. See notes on individual parameters below." - operationId: getComicStoryCollection + description: "Fetches lists of comic stories in a specific comic issue, with optional filters." + operationId: getStoriesByComicId parameters: - name: comicId in: path @@ -1281,15 +1395,15 @@ paths: format: int32 - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: series in: query - description: Return only stories contained the specified series (accepts a - comma-separated list of ids). + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1299,8 +1413,8 @@ paths: format: int32 - name: events in: query - description: Return only stories which take place during the specified events - (accepts a comma-separated list of ids). + description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1310,8 +1424,8 @@ paths: format: int32 - name: creators in: query - description: Return only stories which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1321,8 +1435,8 @@ paths: format: int32 - name: characters in: query - description: Return only stories which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1332,9 +1446,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1344,12 +1457,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources. + required: false schema: type: integer format: int32 @@ -1360,67 +1475,79 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators: get: tags: - - public + - creators summary: Fetches lists of creators. - description: Fetches lists of comic creators with optional filters. See notes - on individual parameters below. - operationId: getCreatorXCollection + description: Fetches lists of comic creators with optional filters. + operationId: getCreators parameters: - name: firstName in: query description: Filter by creator first name (e.g. Brian). + required: false schema: type: string - name: middleName in: query description: Filter by creator middle name (e.g. Michael). + required: false schema: type: string - name: lastName in: query description: Filter by creator last name (e.g. Bendis). + required: false schema: type: string - name: suffix in: query description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + required: false schema: type: string - name: nameStartsWith in: query description: "Filter by creator names that match critera (e.g. B, St L)." + required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St\ - \ L)." + description: "Filter by creator first names that match critera (e.g. B, St L)." + required: false schema: type: string - name: middleNameStartsWith in: query description: Filter by creator middle names that match critera (e.g. Mi). + required: false schema: type: string - name: lastNameStartsWith in: query description: Filter by creator last names that match critera (e.g. Ben). + required: false schema: type: string - name: modifiedSince in: query - description: Return only creators which have been modified since the specified - date. + description: Return only creators which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only creators who worked on in the specified comics (accepts - a comma-separated list of ids). + description: Return only creators who worked on in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1430,8 +1557,8 @@ paths: format: int32 - name: series in: query - description: Return only creators who worked on the specified series (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1441,8 +1568,8 @@ paths: format: int32 - name: events in: query - description: Return only creators who worked on comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1452,8 +1579,8 @@ paths: format: int32 - name: stories in: query - description: Return only creators who worked on the specified stories (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1463,9 +1590,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1475,12 +1601,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1491,14 +1619,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators/{creatorId}: get: tags: - - public + - creators summary: Fetches a single creator by id. - description: This method fetches a single creator resource. It is the canonical - URI for any creator resource provided by the API. - operationId: getCreatorIndividual + description: This method fetches a single creator resource. It is the canonical URI for any creator resource provided by the API. + operationId: getCreatorById parameters: - name: creatorId in: path @@ -1514,14 +1647,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators/{creatorId}/comics: get: tags: - - public + - comics summary: Fetches lists of comics filtered by a creator id. - description: "Fetches lists of comics in which the work of a specific creator\ - \ appears, with optional filters. See notes on individual parameters below." - operationId: getComicsECollection + description: "Fetches lists of comics in which the work of a specific creator appears, with optional filters." + operationId: getComicsByCreatorId parameters: - name: creatorId in: path @@ -1533,28 +1671,31 @@ paths: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query description: Exclude variant comics from the result set. + required: false schema: type: boolean - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false schema: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -1565,59 +1706,70 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false style: form explode: false schema: @@ -1626,15 +1778,15 @@ paths: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: characters in: query - description: Return only comics which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1644,8 +1796,8 @@ paths: format: int32 - name: series in: query - description: Return only comics which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1655,8 +1807,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1666,8 +1818,8 @@ paths: format: int32 - name: stories in: query - description: Return only comics which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1677,8 +1829,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). + required: false style: form explode: false schema: @@ -1688,8 +1840,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). + required: false style: form explode: false schema: @@ -1699,9 +1851,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1711,12 +1862,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1727,14 +1880,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators/{creatorId}/events: get: tags: - - public + - events summary: Fetches lists of events filtered by a creator id. - description: Fetches lists of events featuring the work of a specific creator - with optional filters. See notes on individual parameters below. - operationId: getCreatorEventsCollection + description: Fetches lists of events featuring the work of a specific creator with optional filters. + operationId: getEventsByCreatorId parameters: - name: creatorId in: path @@ -1746,25 +1904,26 @@ paths: - name: name in: query description: Filter the event list by name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: characters in: query - description: Return only events which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1774,8 +1933,8 @@ paths: format: int32 - name: series in: query - description: Return only events which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only events which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1785,8 +1944,8 @@ paths: format: int32 - name: comics in: query - description: Return only events which take place in the specified comics (accepts - a comma-separated list of ids). + description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1796,8 +1955,8 @@ paths: format: int32 - name: stories in: query - description: Return only events which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1807,9 +1966,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1819,12 +1977,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1835,14 +1995,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators/{creatorId}/series: get: tags: - - public + - series summary: Fetches lists of series filtered by a creator id. - description: "Fetches lists of comic series in which a specific creator's work\ - \ appears, with optional filters. See notes on individual parameters below." - operationId: getCreatorSeriesCollection + description: "Fetches lists of comic series in which a specific creator's work appears, with optional filters." + operationId: getSeriesByCreatorId parameters: - name: creatorId in: path @@ -1854,31 +2019,33 @@ paths: - name: title in: query description: Filter by series title. + required: false schema: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string - (e.g. Sp). + description: Return series with titles that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: startYear in: query description: Return only series matching the specified start year. + required: false schema: type: integer format: int32 - name: modifiedSince in: query - description: Return only series which have been modified since the specified - date. + description: Return only series which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only series which contain the specified comics (accepts - a comma-separated list of ids). + description: Return only series which contain the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1888,8 +2055,8 @@ paths: format: int32 - name: stories in: query - description: Return only series which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1899,8 +2066,8 @@ paths: format: int32 - name: events in: query - description: Return only series which have comics that take place during the - specified events (accepts a comma-separated list of ids). + description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1910,8 +2077,8 @@ paths: format: int32 - name: characters in: query - description: Return only series which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -1922,12 +2089,13 @@ paths: - name: seriesType in: query description: Filter the series by publication frequency type. + required: false schema: type: string - name: contains in: query - description: Return only series containing one or more comics with the specified - format. + description: Return only series containing one or more comics with the specified format. + required: false style: form explode: false schema: @@ -1936,9 +2104,8 @@ paths: type: string - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -1948,12 +2115,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -1964,14 +2133,19 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/creators/{creatorId}/stories: get: tags: - - public + - stories summary: Fetches lists of stories filtered by a creator id. - description: Fetches lists of comic stories by a specific creator with optional - filters. See notes on individual parameters below. - operationId: getCreatorStoryCollection + description: Fetches lists of comic stories by a specific creator with optional filters. + operationId: getStoriesByCreatorId parameters: - name: creatorId in: path @@ -1982,15 +2156,15 @@ paths: format: int32 - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only stories contained in the specified comics (accepts - a comma-separated list of ids). + description: Return only stories contained in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2000,8 +2174,8 @@ paths: format: int32 - name: series in: query - description: Return only stories contained the specified series (accepts a - comma-separated list of ids). + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2011,8 +2185,8 @@ paths: format: int32 - name: events in: query - description: Return only stories which take place during the specified events - (accepts a comma-separated list of ids). + description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2022,8 +2196,8 @@ paths: format: int32 - name: characters in: query - description: Return only stories which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2033,9 +2207,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2045,12 +2218,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2061,37 +2236,43 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events: get: tags: - - public + - events summary: Fetches lists of events. - description: Fetches lists of events with optional filters. See notes on individual - parameters below. - operationId: getEventsCollection + description: Fetches lists of events with optional filters. + operationId: getEvents parameters: - name: name in: query description: Return only events which match the specified name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only events which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only events which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2101,8 +2282,8 @@ paths: format: int32 - name: characters in: query - description: Return only events which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2112,8 +2293,8 @@ paths: format: int32 - name: series in: query - description: Return only events which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only events which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2123,8 +2304,8 @@ paths: format: int32 - name: comics in: query - description: Return only events which take place in the specified comics (accepts - a comma-separated list of ids). + description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2134,8 +2315,8 @@ paths: format: int32 - name: stories in: query - description: Return only events which take place in the specified stories - (accepts a comma-separated list of ids). + description: Return only events which take place in the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2145,9 +2326,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2157,12 +2337,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2173,14 +2355,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}: get: tags: - - public + - events summary: Fetches a single event by id. - description: This method fetches a single event resource. It is the canonical - URI for any event resource provided by the API. - operationId: getEventIndividual + description: This method fetches a single event resource. It is the canonical URI for any event resource provided by the API. + operationId: getEventById parameters: - name: eventId in: path @@ -2196,14 +2383,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}/characters: get: tags: - - public + - characters summary: Fetches lists of characters filtered by an event id. - description: "Fetches lists of characters which appear in a specific event,\ - \ with optional filters. See notes on individual parameters below." - operationId: getEventCharacterCollection + description: "Fetches lists of characters which appear in a specific event, with optional filters." + operationId: getCharactersByEventId parameters: - name: eventId in: path @@ -2214,27 +2406,27 @@ paths: format: int32 - name: name in: query - description: Return only characters matching the specified full character - name (e.g. Spider-Man). + description: Return only characters matching the specified full character name (e.g. Spider-Man). + required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string - (e.g. Sp). + description: Return characters with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only characters which have been modified since the specified - date. + description: Return only characters which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only characters which appear in the specified comics (accepts - a comma-separated list of ids). + description: Return only characters which appear in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2244,8 +2436,8 @@ paths: format: int32 - name: series in: query - description: Return only characters which appear the specified series (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2255,8 +2447,8 @@ paths: format: int32 - name: stories in: query - description: Return only characters which appear the specified stories (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2266,9 +2458,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2278,12 +2469,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2294,14 +2487,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}/comics: get: tags: - - public + - comics summary: Fetches lists of comics filtered by an event id. - description: "Fetches lists of comics which take place during a specific event,\ - \ with optional filters. See notes on individual parameters below." - operationId: getComicsXCollection + description: "Fetches lists of comics which take place during a specific event, with optional filters." + operationId: getComicsByEventId parameters: - name: eventId in: path @@ -2313,16 +2511,19 @@ paths: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query description: Exclude variant comics from the result set. + required: false style: form explode: false schema: @@ -2332,6 +2533,7 @@ paths: - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false style: form explode: false schema: @@ -2340,9 +2542,8 @@ paths: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -2353,59 +2554,70 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false style: form explode: false schema: @@ -2414,15 +2626,15 @@ paths: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only comics which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only comics which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2432,8 +2644,8 @@ paths: format: int32 - name: characters in: query - description: Return only comics which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2443,8 +2655,8 @@ paths: format: int32 - name: series in: query - description: Return only comics which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2454,8 +2666,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2465,8 +2677,8 @@ paths: format: int32 - name: stories in: query - description: Return only comics which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2476,8 +2688,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). + required: false style: form explode: false schema: @@ -2487,8 +2699,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). + required: false style: form explode: false schema: @@ -2498,9 +2710,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2510,12 +2721,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2526,14 +2739,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}/creators: get: tags: - - public + - creators summary: Fetches lists of creators filtered by an event id. - description: "Fetches lists of comic creators whose work appears in a specific\ - \ event, with optional filters. See notes on individual parameters below." - operationId: getCreatorZCollection + description: "Fetches lists of comic creators whose work appears in a specific event, with optional filters." + operationId: getCreatorsByEventId parameters: - name: eventId in: path @@ -2545,55 +2763,62 @@ paths: - name: firstName in: query description: Filter by creator first name (e.g. brian). + required: false schema: type: string - name: middleName in: query description: Filter by creator middle name (e.g. Michael). + required: false schema: type: string - name: lastName in: query description: Filter by creator last name (e.g. Bendis). + required: false schema: type: string - name: suffix in: query description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + required: false schema: type: string - name: nameStartsWith in: query description: "Filter by creator names that match critera (e.g. B, St L)." + required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St\ - \ L)." + description: "Filter by creator first names that match critera (e.g. B, St L)." + required: false schema: type: string - name: middleNameStartsWith in: query description: Filter by creator middle names that match critera (e.g. Mi). + required: false schema: type: string - name: lastNameStartsWith in: query description: Filter by creator last names that match critera (e.g. Ben). + required: false schema: type: string - name: modifiedSince in: query - description: Return only creators which have been modified since the specified - date. + description: Return only creators which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only creators who worked on in the specified comics (accepts - a comma-separated list of ids). + description: Return only creators who worked on in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2603,8 +2828,8 @@ paths: format: int32 - name: series in: query - description: Return only creators who worked on the specified series (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2614,8 +2839,8 @@ paths: format: int32 - name: stories in: query - description: Return only creators who worked on the specified stories (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2625,9 +2850,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2637,12 +2861,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2653,14 +2879,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}/series: get: tags: - - public + - series summary: Fetches lists of series filtered by an event id. - description: "Fetches lists of comic series in which a specific event takes\ - \ place, with optional filters. See notes on individual parameters below." - operationId: getEventSeriesCollection + description: "Fetches lists of comic series in which a specific event takes place, with optional filters." + operationId: getSeriesByEventId parameters: - name: eventId in: path @@ -2672,31 +2903,33 @@ paths: - name: title in: query description: Filter by series title. + required: false schema: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string - (e.g. Sp). + description: Return series with titles that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: startYear in: query description: Return only series matching the specified start year. + required: false schema: type: integer format: int32 - name: modifiedSince in: query - description: Return only series which have been modified since the specified - date. + description: Return only series which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only series which contain the specified comics (accepts - a comma-separated list of ids). + description: Return only series which contain the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2706,8 +2939,8 @@ paths: format: int32 - name: stories in: query - description: Return only series which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2717,8 +2950,8 @@ paths: format: int32 - name: creators in: query - description: Return only series which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2728,8 +2961,8 @@ paths: format: int32 - name: characters in: query - description: Return only series which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2740,12 +2973,13 @@ paths: - name: seriesType in: query description: Filter the series by publication frequency type. + required: false schema: type: string - name: contains in: query - description: Return only series containing one or more comics with the specified - format. + description: Return only series containing one or more comics with the specified format. + required: false style: form explode: false schema: @@ -2754,9 +2988,8 @@ paths: type: string - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2766,12 +2999,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2782,14 +3017,19 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/events/{eventId}/stories: get: tags: - - public + - stories summary: Fetches lists of stories filtered by an event id. - description: "Fetches lists of comic stories from a specific event, with optional\ - \ filters. See notes on individual parameters below." - operationId: getEventStoryCollection + description: "Fetches lists of comic stories from a specific event, with optional filters." + operationId: getStoriesByEventId parameters: - name: eventId in: path @@ -2800,15 +3040,15 @@ paths: format: int32 - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only stories contained in the specified (accepts a comma-separated - list of ids). + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2818,8 +3058,8 @@ paths: format: int32 - name: series in: query - description: Return only stories contained the specified series (accepts a - comma-separated list of ids). + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2829,8 +3069,8 @@ paths: format: int32 - name: creators in: query - description: Return only stories which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2840,8 +3080,8 @@ paths: format: int32 - name: characters in: query - description: Return only stories which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2851,9 +3091,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2863,12 +3102,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -2879,43 +3120,50 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series: get: tags: - - public + - series summary: Fetches lists of series. - description: Fetches lists of comic series with optional filters. See notes - on individual parameters below. - operationId: getSeriesCollection + description: Fetches lists of comic series with optional filters. + operationId: getSeries parameters: - name: title in: query description: Return only series matching the specified title. + required: false schema: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string - (e.g. Sp). + description: Return series with titles that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: startYear in: query description: Return only series matching the specified start year. + required: false schema: type: integer format: int32 - name: modifiedSince in: query - description: Return only series which have been modified since the specified - date. + description: Return only series which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only series which contain the specified comics (accepts - a comma-separated list of ids). + description: Return only series which contain the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2925,8 +3173,8 @@ paths: format: int32 - name: stories in: query - description: Return only series which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2936,8 +3184,8 @@ paths: format: int32 - name: events in: query - description: Return only series which have comics that take place during the - specified events (accepts a comma-separated list of ids). + description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2947,8 +3195,8 @@ paths: format: int32 - name: creators in: query - description: Return only series which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2958,8 +3206,8 @@ paths: format: int32 - name: characters in: query - description: Return only series which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -2970,12 +3218,13 @@ paths: - name: seriesType in: query description: Filter the series by publication frequency type. + required: false schema: type: string - name: contains in: query - description: Return only series containing one or more comics with the specified - format. + description: Return only series containing one or more comics with the specified format. + required: false style: form explode: false schema: @@ -2984,9 +3233,8 @@ paths: type: string - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -2996,12 +3244,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3012,14 +3262,19 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}: get: tags: - - public + - series summary: Fetches a single comic series by id. - description: This method fetches a single comic series resource. It is the - canonical URI for any comic series resource provided by the API. - operationId: getSeriesIndividual + description: This method fetches a single comic series resource. It is the canonical URI for any comic series resource provided by the API. + operationId: getSeriesById parameters: - name: seriesId in: path @@ -3035,14 +3290,19 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}/characters: get: tags: - - public + - characters summary: Fetches lists of characters filtered by a series id. - description: "Fetches lists of characters which appear in specific series, with\ - \ optional filters. See notes on individual parameters below." - operationId: getSeriesCharacterWrapper + description: "Fetches lists of characters which appear in specific series, with optional filters." + operationId: getCharactersBySeriesId parameters: - name: seriesId in: path @@ -3053,27 +3313,27 @@ paths: format: int32 - name: name in: query - description: Return only characters matching the specified full character - name (e.g. Spider-Man). + description: Return only characters matching the specified full character name (e.g. Spider-Man). + required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string - (e.g. Sp). + description: Return characters with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only characters which have been modified since the specified - date. + description: Return only characters which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only characters which appear in the specified comics (accepts - a comma-separated list of ids). + description: Return only characters which appear in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3083,8 +3343,8 @@ paths: format: int32 - name: events in: query - description: Return only characters which appear comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3094,8 +3354,8 @@ paths: format: int32 - name: stories in: query - description: Return only characters which appear the specified stories (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3105,9 +3365,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3117,12 +3376,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3133,14 +3394,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}/comics: get: tags: - - public + - comics summary: Fetches lists of comics filtered by a series id. - description: "Fetches lists of comics which are published as part of a specific\ - \ series, with optional filters. See notes on individual parameters below." - operationId: getComicsZCollection + description: "Fetches lists of comics which are published as part of a specific series, with optional filters." + operationId: getComicsBySeriesId parameters: - name: seriesId in: path @@ -3152,16 +3418,19 @@ paths: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query description: Exclude variant comics from the result set. + required: false style: form explode: false schema: @@ -3171,6 +3440,7 @@ paths: - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false style: form explode: false schema: @@ -3179,9 +3449,8 @@ paths: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -3192,59 +3461,70 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false style: form explode: false schema: @@ -3253,15 +3533,15 @@ paths: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only comics which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only comics which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3271,8 +3551,8 @@ paths: format: int32 - name: characters in: query - description: Return only comics which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3282,8 +3562,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3293,8 +3573,8 @@ paths: format: int32 - name: stories in: query - description: Return only comics which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3304,8 +3584,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). + required: false style: form explode: false schema: @@ -3315,8 +3595,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). + required: false style: form explode: false schema: @@ -3326,9 +3606,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3338,12 +3617,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3354,14 +3635,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}/creators: get: tags: - - public + - creators summary: Fetches lists of creators filtered by a series id. - description: "Fetches lists of comic creators whose work appears in a specific\ - \ series, with optional filters. See notes on individual parameters below." - operationId: getCreatorCCollection + description: "Fetches lists of comic creators whose work appears in a specific series, with optional filters." + operationId: getCreatorsBySeriesId parameters: - name: seriesId in: path @@ -3373,55 +3659,62 @@ paths: - name: firstName in: query description: Filter by creator first name (e.g. brian). + required: false schema: type: string - name: middleName in: query description: Filter by creator middle name (e.g. Michael). + required: false schema: type: string - name: lastName in: query description: Filter by creator last name (e.g. Bendis). + required: false schema: type: string - name: suffix in: query description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + required: false schema: type: string - name: nameStartsWith in: query description: "Filter by creator names that match critera (e.g. B, St L)." + required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St\ - \ L)." + description: "Filter by creator first names that match critera (e.g. B, St L)." + required: false schema: type: string - name: middleNameStartsWith in: query description: Filter by creator middle names that match critera (e.g. Mi). + required: false schema: type: string - name: lastNameStartsWith in: query description: Filter by creator last names that match critera (e.g. Ben). + required: false schema: type: string - name: modifiedSince in: query - description: Return only creators which have been modified since the specified - date. + description: Return only creators which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only creators who worked on in the specified comics (accepts - a comma-separated list of ids). + description: Return only creators who worked on in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3431,8 +3724,8 @@ paths: format: int32 - name: events in: query - description: Return only creators who worked on comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3442,8 +3735,8 @@ paths: format: int32 - name: stories in: query - description: Return only creators who worked on the specified stories (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3453,9 +3746,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3465,12 +3757,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3481,14 +3775,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}/events: get: tags: - - public + - events summary: Fetches lists of events filtered by a series id. - description: "Fetches lists of events which occur in a specific series, with\ - \ optional filters. See notes on individual parameters below." - operationId: getEventsWCollection + description: "Fetches lists of events which occur in a specific series, with optional filters." + operationId: getEventsBySeriesId parameters: - name: seriesId in: path @@ -3500,25 +3799,26 @@ paths: - name: name in: query description: Filter the event list by name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only events which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only events which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3528,8 +3828,8 @@ paths: format: int32 - name: characters in: query - description: Return only events which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3539,8 +3839,8 @@ paths: format: int32 - name: comics in: query - description: Return only events which take place in the specified comics (accepts - a comma-separated list of ids). + description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3550,8 +3850,8 @@ paths: format: int32 - name: stories in: query - description: Return only events which contain the specified stories (accepts - a comma-separated list of ids). + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3561,9 +3861,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3573,12 +3872,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3589,14 +3890,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/series/{seriesId}/stories: get: tags: - - public + - stories summary: Fetches lists of stories filtered by a series id. - description: Fetches lists of comic stories from a specific series with optional - filters. See notes on individual parameters below. - operationId: getSeriesStoryCollection + description: Fetches lists of comic stories from a specific series with optional filters. + operationId: getStoriesBySeriesId parameters: - name: seriesId in: path @@ -3607,15 +3913,15 @@ paths: format: int32 - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only stories contained in the specified (accepts a comma-separated - list of ids). + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3625,8 +3931,8 @@ paths: format: int32 - name: events in: query - description: Return only stories which take place during the specified events - (accepts a comma-separated list of ids). + description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3636,8 +3942,8 @@ paths: format: int32 - name: creators in: query - description: Return only stories which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3647,8 +3953,8 @@ paths: format: int32 - name: characters in: query - description: Return only stories which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3658,9 +3964,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3670,12 +3975,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3686,26 +3993,31 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories: get: tags: - - public + - stories summary: Fetches lists of stories. - description: Fetches lists of comic stories with optional filters. See notes - on individual parameters below. - operationId: getStoryCollection + description: Fetches lists of comic stories with optional filters. + operationId: getStories parameters: - name: modifiedSince in: query - description: Return only stories which have been modified since the specified - date. + description: Return only stories which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only stories contained in the specified (accepts a comma-separated - list of ids). + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3715,8 +4027,8 @@ paths: format: int32 - name: series in: query - description: Return only stories contained the specified series (accepts a - comma-separated list of ids). + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3726,8 +4038,8 @@ paths: format: int32 - name: events in: query - description: Return only stories which take place during the specified events - (accepts a comma-separated list of ids). + description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3737,8 +4049,8 @@ paths: format: int32 - name: creators in: query - description: Return only stories which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3748,8 +4060,8 @@ paths: format: int32 - name: characters in: query - description: Return only stories which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3759,9 +4071,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3771,12 +4082,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3787,14 +4100,19 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}: get: tags: - - public + - stories summary: Fetches a single comic story by id. - description: This method fetches a single comic story resource. It is the canonical - URI for any comic story resource provided by the API. - operationId: getStoryIndividual + description: This method fetches a single comic story resource. It is the canonical URI for any comic story resource provided by the API. + operationId: getStoryById parameters: - name: storyId in: path @@ -3810,14 +4128,19 @@ paths: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "404": + description: Not found response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}/characters: get: tags: - - public + - characters summary: Fetches lists of characters filtered by a story id. - description: "Fetches lists of comic characters appearing in a single story,\ - \ with optional filters. See notes on individual parameters below." - operationId: getCreatorVCollection + description: "Fetches lists of comic characters appearing in a single story, with optional filters." + operationId: getCharactersByStoryId parameters: - name: storyId in: path @@ -3828,27 +4151,27 @@ paths: format: int32 - name: name in: query - description: Return only characters matching the specified full character - name (e.g. Spider-Man). + description: Return only characters matching the specified full character name (e.g. Spider-Man). + required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string - (e.g. Sp). + description: Return characters with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only characters which have been modified since the specified - date. + description: Return only characters which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only characters which appear in the specified comics (accepts - a comma-separated list of ids). + description: Return only characters which appear in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3858,8 +4181,8 @@ paths: format: int32 - name: series in: query - description: Return only characters which appear the specified series (accepts - a comma-separated list of ids). + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3869,8 +4192,8 @@ paths: format: int32 - name: events in: query - description: Return only characters which appear comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -3880,9 +4203,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -3892,12 +4214,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -3908,14 +4232,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}/comics: get: tags: - - public + - comics summary: Fetches lists of comics filtered by a story id. - description: "Fetches lists of comics in which a specific story appears, with\ - \ optional filters. See notes on individual parameters below." - operationId: getComicsCCollection + description: "Fetches lists of comics in which a specific story appears, with optional filters." + operationId: getComicsByStoryId parameters: - name: storyId in: path @@ -3927,16 +4256,19 @@ paths: - name: format in: query description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + required: false schema: type: string - name: formatType in: query description: Filter by the issue format type (comic or collection). + required: false schema: type: string - name: noVariants in: query description: Exclude variant comics from the result set. + required: false style: form explode: false schema: @@ -3946,6 +4278,7 @@ paths: - name: dateDescriptor in: query description: Return comics within a predefined date range. + required: false style: form explode: false schema: @@ -3954,9 +4287,8 @@ paths: type: string - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be\ - \ specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably\ - \ formatted as YYYY-MM-DD but may be sent as any common date format." + description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + required: false style: form explode: false schema: @@ -3967,59 +4299,70 @@ paths: - name: title in: query description: Return only issues in series whose title matches the input. + required: false schema: type: string - name: titleStartsWith in: query description: Return only issues in series whose title starts with the input. + required: false schema: type: string - name: startYear in: query description: Return only issues in series whose start year matches the input. + required: false schema: type: integer format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. + required: false schema: type: integer format: int32 - name: diamondCode in: query description: Filter by diamond code. + required: false schema: type: string - name: digitalId in: query description: Filter by digital comic id. + required: false schema: type: integer format: int32 - name: upc in: query description: Filter by UPC. + required: false schema: type: string - name: isbn in: query description: Filter by ISBN. + required: false schema: type: string - name: ean in: query description: Filter by EAN. + required: false schema: type: string - name: issn in: query description: Filter by ISSN. + required: false schema: type: string - name: hasDigitalIssue in: query description: Include only results which are available digitally. + required: false style: form explode: false schema: @@ -4028,15 +4371,15 @@ paths: type: boolean - name: modifiedSince in: query - description: Return only comics which have been modified since the specified - date. + description: Return only comics which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only comics which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only comics which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4046,8 +4389,8 @@ paths: format: int32 - name: characters in: query - description: Return only comics which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4057,8 +4400,8 @@ paths: format: int32 - name: series in: query - description: Return only comics which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4068,8 +4411,8 @@ paths: format: int32 - name: events in: query - description: Return only comics which take place in the specified events (accepts - a comma-separated list of ids). + description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4079,8 +4422,8 @@ paths: format: int32 - name: sharedAppearances in: query - description: Return only comics in which the specified characters appear together - (for example in which BOTH Spider-Man and Wolverine appear). + description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). + required: false style: form explode: false schema: @@ -4090,8 +4433,8 @@ paths: format: int32 - name: collaborators in: query - description: Return only comics in which the specified creators worked together - (for example in which BOTH Stan Lee and Jack Kirby did work). + description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). + required: false style: form explode: false schema: @@ -4101,9 +4444,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -4113,12 +4455,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -4129,14 +4473,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}/creators: get: tags: - - public + - creators summary: Fetches lists of creators filtered by a story id. - description: "Fetches lists of comic creators whose work appears in a specific\ - \ story, with optional filters. See notes on individual parameters below." - operationId: getCreatorQCollection + description: "Fetches lists of comic creators whose work appears in a specific story, with optional filters." + operationId: getCreatorsByStoryId parameters: - name: storyId in: path @@ -4148,55 +4497,62 @@ paths: - name: firstName in: query description: Filter by creator first name (e.g. brian). + required: false schema: type: string - name: middleName in: query description: Filter by creator middle name (e.g. Michael). + required: false schema: type: string - name: lastName in: query description: Filter by creator last name (e.g. Bendis). + required: false schema: type: string - name: suffix in: query description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + required: false schema: type: string - name: nameStartsWith in: query description: "Filter by creator names that match critera (e.g. B, St L)." + required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St\ - \ L)." + description: "Filter by creator first names that match critera (e.g. B, St L)." + required: false schema: type: string - name: middleNameStartsWith in: query description: Filter by creator middle names that match critera (e.g. Mi). + required: false schema: type: string - name: lastNameStartsWith in: query description: Filter by creator last names that match critera (e.g. Ben). + required: false schema: type: string - name: modifiedSince in: query - description: Return only creators which have been modified since the specified - date. + description: Return only creators which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only creators who worked on in the specified comics (accepts - a comma-separated list of ids). + description: Return only creators who worked on in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4206,8 +4562,8 @@ paths: format: int32 - name: series in: query - description: Return only creators who worked on the specified series (accepts - a comma-separated list of ids). + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4217,8 +4573,8 @@ paths: format: int32 - name: events in: query - description: Return only creators who worked on comics that took place in - the specified events (accepts a comma-separated list of ids). + description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4228,9 +4584,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -4240,12 +4595,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -4256,14 +4613,19 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}/events: get: tags: - - public + - events summary: Fetches lists of events filtered by a story id. - description: "Fetches lists of events in which a specific story appears, with\ - \ optional filters. See notes on individual parameters below." - operationId: getEventsZCollection + description: "Fetches lists of events in which a specific story appears, with optional filters." + operationId: getEventsByStoryId parameters: - name: storyId in: path @@ -4275,25 +4637,26 @@ paths: - name: name in: query description: Filter the event list by name. + required: false schema: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string - (e.g. Sp). + description: Return events with names that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: modifiedSince in: query - description: Return only events which have been modified since the specified - date. + description: Return only events which have been modified since the specified date. + required: false schema: type: string format: date - name: creators in: query - description: Return only events which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only events which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4303,8 +4666,8 @@ paths: format: int32 - name: characters in: query - description: Return only events which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4314,8 +4677,8 @@ paths: format: int32 - name: series in: query - description: Return only events which are part of the specified series (accepts - a comma-separated list of ids). + description: Return only events which are part of the specified series (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4325,8 +4688,8 @@ paths: format: int32 - name: comics in: query - description: Return only events which take place in the specified comics (accepts - a comma-separated list of ids). + description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4336,9 +4699,8 @@ paths: format: int32 - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -4348,12 +4710,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -4364,14 +4728,19 @@ paths: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /v1/public/stories/{storyId}/series: get: tags: - - public + - series summary: Fetches lists of series filtered by a story id. - description: Fetches lists of comic series in which the specified story takes - place. See notes on individual parameters below. - operationId: getStorySeriesCollection + description: Fetches lists of comic series in which the specified story takes place. + operationId: getSeriesByStoryId parameters: - name: storyId in: path @@ -4382,8 +4751,8 @@ paths: format: int32 - name: events in: query - description: Return only series which have comics that take place during the - specified events (accepts a comma-separated list of ids). + description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4394,31 +4763,33 @@ paths: - name: title in: query description: Filter by series title. + required: false schema: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string - (e.g. Sp). + description: Return series with titles that begin with the specified string (e.g. Sp). + required: false schema: type: string - name: startYear in: query description: Return only series matching the specified start year. + required: false schema: type: integer format: int32 - name: modifiedSince in: query - description: Return only series which have been modified since the specified - date. + description: Return only series which have been modified since the specified date. + required: false schema: type: string format: date - name: comics in: query - description: Return only series which contain the specified comics (accepts - a comma-separated list of ids). + description: Return only series which contain the specified comics (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4428,8 +4799,8 @@ paths: format: int32 - name: creators in: query - description: Return only series which feature work by the specified creators - (accepts a comma-separated list of ids). + description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4439,8 +4810,8 @@ paths: format: int32 - name: characters in: query - description: Return only series which feature the specified characters (accepts - a comma-separated list of ids). + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false style: form explode: false schema: @@ -4451,12 +4822,13 @@ paths: - name: seriesType in: query description: Filter the series by publication frequency type. + required: false schema: type: string - name: contains in: query - description: Return only series containing one or more comics with the specified - format. + description: Return only series containing one or more comics with the specified format. + required: false style: form explode: false schema: @@ -4465,9 +4837,8 @@ paths: type: string - name: orderBy in: query - description: Order the result set by a field or fields. Add a "-" to the value - sort in descending order. Multiple values are given priority in the order - in which they are passed. + description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. + required: false style: form explode: false schema: @@ -4477,12 +4848,14 @@ paths: - name: limit in: query description: Limit the result set to the specified number of resources. + required: false schema: type: integer format: int32 - name: offset in: query description: Skip the specified number of resources in the result set. + required: false schema: type: integer format: int32 @@ -4493,6 +4866,12 @@ paths: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' components: schemas: ComicList: @@ -5382,4 +5761,15 @@ components: $ref: '#/components/schemas/CreatorList' originalissue: $ref: '#/components/schemas/ComicSummary' -x-original-swagger-version: "2.0" + ErrorResponse: + type: object + properties: + code: + type: integer + description: The HTTP status code of the returned result. + reason: + type: string + description: A reason describing the error. + required: + - code + - reason -- 2.52.0