From 15ff10bb4ef2cd7988dab9a8da2e089397a6869c Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sat, 4 Oct 2025 19:57:45 +0200 Subject: [PATCH 1/4] Removed unnecessary boiler-plated file from the library target. --- Sources/MarvelService/Public/marvel_service.swift | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 Sources/MarvelService/Public/marvel_service.swift diff --git a/Sources/MarvelService/Public/marvel_service.swift b/Sources/MarvelService/Public/marvel_service.swift deleted file mode 100644 index 08b22b80..00000000 --- a/Sources/MarvelService/Public/marvel_service.swift +++ /dev/null @@ -1,2 +0,0 @@ -// The Swift Programming Language -// https://docs.swift.org/swift-book -- 2.52.0 From 677482ffcba3bfd3e65f4343d3662275c394471e Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sat, 4 Oct 2025 21:33:55 +0200 Subject: [PATCH 2/4] Improved the definition of the schema types for the OpenAPI specification in the library target. --- Sources/MarvelService/openapi.yaml | 1676 ++++++++++++++++------------ 1 file changed, 991 insertions(+), 685 deletions(-) diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml index 1da5d1c5..6a18db9a 100644 --- a/Sources/MarvelService/openapi.yaml +++ b/Sources/MarvelService/openapi.yaml @@ -138,12 +138,18 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}: get: tags: @@ -171,7 +177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/comics: get: tags: @@ -400,7 +406,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/events: get: tags: @@ -516,7 +522,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/series: get: tags: @@ -654,7 +660,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/stories: get: tags: @@ -757,7 +763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics: get: tags: @@ -990,7 +996,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}: get: tags: @@ -1018,7 +1024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/characters: get: tags: @@ -1122,7 +1128,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/creators: get: tags: @@ -1262,7 +1268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/events: get: tags: @@ -1377,7 +1383,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/stories: get: tags: @@ -1480,7 +1486,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators: get: tags: @@ -1624,7 +1630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}: get: tags: @@ -1652,7 +1658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/comics: get: tags: @@ -1885,7 +1891,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/events: get: tags: @@ -2000,7 +2006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/series: get: tags: @@ -2138,7 +2144,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/stories: get: tags: @@ -2241,7 +2247,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events: get: tags: @@ -2360,7 +2366,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}: get: tags: @@ -2388,7 +2394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/characters: get: tags: @@ -2492,7 +2498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/comics: get: tags: @@ -2744,7 +2750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/creators: get: tags: @@ -2884,7 +2890,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/series: get: tags: @@ -3022,7 +3028,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/stories: get: tags: @@ -3125,7 +3131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series: get: tags: @@ -3267,7 +3273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}: get: tags: @@ -3295,7 +3301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/characters: get: tags: @@ -3399,7 +3405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/comics: get: tags: @@ -3640,7 +3646,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/creators: get: tags: @@ -3780,7 +3786,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/events: get: tags: @@ -3895,7 +3901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/stories: get: tags: @@ -3998,7 +4004,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories: get: tags: @@ -4105,7 +4111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}: get: tags: @@ -4133,7 +4139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/characters: get: tags: @@ -4237,7 +4243,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/comics: get: tags: @@ -4478,7 +4484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/creators: get: tags: @@ -4618,7 +4624,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/events: get: tags: @@ -4733,7 +4739,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/series: get: tags: @@ -4871,311 +4877,208 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: '#/components/schemas/StandardError' components: schemas: - ComicList: +# Core Entity Representations + Character: type: object + description: A character resource type that represents the women, men, organizations, alien species, deities, animals, non-corporeal entities, trans-dimensional manifestations, abstract personifications, and green amorphous blobs which occupy the Marvel Universe as well as various alternate universes, timelines and altered realities therein (e.g. Spider-Man). properties: - available: + id: type: integer - description: The number of total available issues in this list. Will always - be greater than or equal to the "returned" value. + description: The unique ID of the character resource. format: int32 - returned: - type: integer - description: The number of issues returned in this collection (up to 20). - format: int32 - collectionURI: + name: type: string - description: The path to the full list of issues in this collection. - items: + 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: The list of returned issues in this collection. + description: A set of public web site URLs for the resource. + items: + $ref: '#/components/schemas/Url' + thumbnail: + description: The representative image for this character. + $ref: '#/components/schemas/Image' + comics: + description: A resource list containing comics which feature this character. + $ref: '#/components/schemas/ComicList' + stories: + description: A resource list containing stories which this character appears. + $ref: '#/components/schemas/StoryList' + events: + description: A resource list containing events which this character appears. + $ref: '#/components/schemas/EventList' + series: + description: A resource list containing series in which this character appears. + $ref: '#/components/schemas/SeriesList' + required: + - id + - name + - description + - modified + - resourceURI + - urls + - thumbnail + - comics + - stories + - events + - series + Comic: + type: object + description: A comic book resource type that represents physical or digital products that end-users read. This definition includes individual print and digital comic issues, collections and graphic novels (e.g. Amazing Fantasy \#15). + 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: + description: A summary representation of the series to which this comic belongs. + $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' - 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: + collections: type: array - description: The list of returned events in this collection. + 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/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: + $ref: '#/components/schemas/ComicSummary' + collectedIssues: type: array - description: The list of returned creators in this collection. + 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/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: + $ref: '#/components/schemas/ComicSummary' + dates: type: array - description: The list of returned characters in this collection. + description: A list of key dates for this comic. 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: + $ref: '#/components/schemas/ComicDate' + prices: type: array - description: The list of returned series in this collection. + description: A list of prices for this comic. 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: + $ref: '#/components/schemas/ComicPrice' + thumbnail: + description: The representative image for this comic. + $ref: '#/components/schemas/Image' + images: type: array - description: The list of returned stories in this collection. + description: A list of promotional images associated with this comic. 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. + $ref: '#/components/schemas/Image' + creators: + description: A resource list containing creators associated with this comic. + $ref: '#/components/schemas/CreatorList' + characters: + description: A resource list containing characters which appear in this comic. + $ref: '#/components/schemas/CharacterList' + stories: + description: A resource list containing stories which appear in this comic. + $ref: '#/components/schemas/StoryList' + events: + description: A resource list containing events which this comic appears. + $ref: '#/components/schemas/EventList' + required: + - id + - digitalId + - title + - issueNumber + - variantDescription + - description + - modified + - isbn + - upc + - diamondCode + - ean + - issn + - format + - pageCount + - textObjects + - resourceURI + - urls + - series + - variants + - collections + - collectedIssues + - dates + - prices + - thumbnail + - images + - creators + - characters + - stories + - events Creator: type: object + description: A creator resource type that represents women, men and organizations who create comics (e.g. Jack Kirby). They are assigned to the specific comic stories on which they worked, but we bubble up those assignments to the issues, series and events in which the stories appear as a convenience. properties: id: type: integer @@ -5195,8 +5098,7 @@ components: 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). + 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. @@ -5210,17 +5112,38 @@ components: items: $ref: '#/components/schemas/Url' thumbnail: + description: The representative image for this creator. $ref: '#/components/schemas/Image' series: + description: A resource list containing series which feature work by this creator. $ref: '#/components/schemas/SeriesList' stories: + description: A resource list containing stories which feature work by this creator. $ref: '#/components/schemas/StoryList' comics: + description: A resource list containing comics which feature work by this creator. $ref: '#/components/schemas/ComicList' events: + description: A resource list containing events which feature work by this creator. $ref: '#/components/schemas/EventList' + required: + - id + - firstName + - middleName + - lastName + - suffix + - fullName + - modified + - resourceURI + - urls + - thumbnail + - series + - stories + - comics + - events Event: type: object + description: An event resource type that represents big, universe-altering storylines (e.g. Infinity). A comic's appearance in an event is often independent of its membership in a series. properties: id: type: integer @@ -5253,209 +5176,49 @@ components: description: The date of publication of the last issue in this event. format: date thumbnail: + description: The representative image for this event. $ref: '#/components/schemas/Image' comics: + description: A resource list containing the comics in this event. $ref: '#/components/schemas/ComicList' stories: + description: A resource list containing the stories in this event. $ref: '#/components/schemas/StoryList' series: + description: A resource list containing the series in this event. $ref: '#/components/schemas/SeriesList' characters: + description: A resource list containing the characters which appear in this event. $ref: '#/components/schemas/CharacterList' creators: + description: A resource list containing the creators whose work appears in this event. $ref: '#/components/schemas/CreatorList' next: $ref: '#/components/schemas/EventSummary' + description: A summary representation of the event which follows this event. previous: + description: A summary representation of the event which preceded this event. $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. + required: + - id + - title + - description + - resourceURI + - urls + - modified + - start + - end + - thumbnail + - comics + - stories + - series + - characters + - creators + - next + - previous Series: type: object + description: A series resource type that represents (usually) sequentially number list of comics with the same title and volume (e.g. Uncanny X-Men). Marvel uses the year of original publication for a series as the volume number. properties: id: type: integer @@ -5481,8 +5244,7 @@ components: format: int32 endYear: type: integer - description: "The last year of publication for the series (conventionally,\ - \ 2099 for ongoing series) ." + description: "The last year of publication for the series (conventionally, 2099 for ongoing series)." format: int32 rating: type: string @@ -5492,51 +5254,482 @@ components: description: The date the resource was most recently modified. format: date thumbnail: + description: The representative image for this series. $ref: '#/components/schemas/Image' comics: + description: A resource list containing comics in this series. $ref: '#/components/schemas/ComicList' stories: + description: A resource list containing stories which occur in comics in this series. $ref: '#/components/schemas/StoryList' events: + description: A resource list containing events which take place in comics in this series. $ref: '#/components/schemas/EventList' characters: + description: A resource list containing characters which appear in comics in this series. $ref: '#/components/schemas/CharacterList' creators: + description: A resource list containing creators whose work appears in comics in this series. $ref: '#/components/schemas/CreatorList' next: + description: A summary representation of the series which follows this series. $ref: '#/components/schemas/SeriesSummary' previous: + description: A summary representation of the series which preceded this series. $ref: '#/components/schemas/SeriesSummary' - SeriesDataWrapper: + required: + - id + - title + - description + - resourceURI + - urls + - startYear + - endYear + - rating + - modified + - thumbnail + - comics + - stories + - events + - characters + - creators + - next + - previous + Story: type: object + description: A story resource type that represents an indivisible, reusable components of comics. Most comics have two stories - a cover and an interior story (e. g. the cover from Amazing Fantasy \#15 and the origin of Spider-Man story from that comic) - but many, such as anthology comics and collections, will have more. Stories may be re-published in several comics, but the comic in which they originally appeared will always be present as a data point. properties: - code: + id: type: integer - description: The HTTP status code of the returned result. + description: The unique ID of the story resource. format: int32 - status: + title: type: string - description: A string description of the call status. - copyright: + description: The story title. + description: type: string - description: The copyright notice for the returned result. - attributionText: + description: A short description of the story. + resourceURI: 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: + description: The canonical URL identifier for this resource. + type: 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: + description: The story type (e.g. interior story, cover, text story). + modified: type: string - description: A digest value of the content returned by the call. + description: The date the resource was most recently modified. + format: date + thumbnail: + description: The representative image for this story. + $ref: '#/components/schemas/Image' + comics: + description: A resource list containing comics in which this story takes place. + $ref: '#/components/schemas/ComicList' + series: + description: A resource list containing series in which this story appears. + $ref: '#/components/schemas/SeriesList' + events: + description: A resource list containing events in which this story appears. + $ref: '#/components/schemas/EventList' + characters: + description: A resource list containing characters which appear in this story. + $ref: '#/components/schemas/CharacterList' + creators: + description: A resource list containing creators worked on this story. + $ref: '#/components/schemas/CreatorList' + originalissue: + description: A summary representation of the issue in which this story was originally published. + $ref: '#/components/schemas/ComicSummary' + required: + - id + - title + - description + - resourceURI + - type + - modified + - thumbnail + - comics + - series + - events + - characters + - creators + - originalissue + +# Core Entity Summary Representations + CharacterSummary: + type: object + description: A type that represents a summary of a character resource. + 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. + required: + - resourceURI + - name + - role + ComicSummary: + type: object + description: A type that represents a summary of a comic resource. + properties: + resourceURI: + type: string + description: The path to the individual comic resource. + name: + type: string + description: The canonical name of the comic. + required: + - resourceURI + - name + CreatorSummary: + type: object + description: A type that represents a summary of a creator resource. + 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. + required: + - resourceURI + - name + - role + EventSummary: + type: object + description: A type that represents a summary of an event resource. + properties: + resourceURI: + type: string + description: The path to the individual event resource. + name: + type: string + description: The name of the event. + required: + - resourceURI + - name + SeriesSummary: + type: object + description: A type that represents a summary of a series resource. + properties: + resourceURI: + type: string + description: The path to the individual series resource. + name: + type: string + description: The canonical name of the series. + required: + - resourceURI + - name + StorySummary: + type: object + description: A type that represents a summary of a story resource. + 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). + required: + - resourceURI + - name + - type + +# Core Entity List Representations + CharacterList: + type: object + description: A resource list containing characters which appear in this story. + 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' + required: + - available + - returned + - collectionURI + - items + ComicList: + type: object + description: A resource list containing comics which feature this story. + 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' + required: + - available + - returned + - collectionURI + - items + CreatorList: + type: object + description: A resource list containing creators whose work appears in this story. + 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' + required: + - available + - returned + - collectionURI + - items + EventList: + type: object + description: A resource list containing events which feature this story. + 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' + required: + - available + - returned + - collectionURI + - items + SeriesList: + type: object + description: A resource list containing series in which this story appears. + 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' + required: + - available + - returned + - collectionURI + - items + StoryList: + type: object + description: A resource list containing stories which are related to this story. + 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' + required: + - available + - returned + - collectionURI + - items + +# Core Entity Container Representations + CharacterDataContainer: + type: object + description: The container for the character data. + 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' + required: + - offset + - limit + - total + - count + - results + ComicDataContainer: + type: object + description: The container for the comic data. + 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' + required: + - offset + - limit + - total + - count + - results + CreatorDataContainer: + type: object + description: A container type for lists of creators. + 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' + required: + - offset + - limit + - total + - count + - results + EventDataContainer: + type: object + description: The container for the event data. + 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' + required: + - offset + - limit + - total + - count + - results SeriesDataContainer: type: object + description: The container for the series data. properties: offset: type: integer @@ -5560,8 +5753,15 @@ components: description: The list of series returned by the call items: $ref: '#/components/schemas/Series' + required: + - offset + - limit + - total + - count + - results StoryDataContainer: type: object + description: The container for the story data. properties: offset: type: integer @@ -5585,188 +5785,294 @@ components: description: The list of stories returned by the call items: $ref: '#/components/schemas/Story' - Comic: + required: + - offset + - limit + - total + - count + - results + +# Core Entity Wrapper Representations + CharacterDataWrapper: type: object + description: The wrapper for the character data. properties: - id: + code: type: integer - description: The unique ID of the comic resource. + description: The HTTP status code of the returned result. 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: + status: 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: + description: A string description of the call status. + copyright: 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: + description: The copyright notice for the returned result. + attributionText: type: string - description: The preferred description of the comic. - modified: + 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: The date the resource was most recently modified. - format: date - isbn: + 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: 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: + description: A digest value of the content returned by the call. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + ComicDataWrapper: type: object + description: The wrapper for the comic data. properties: - offset: + code: type: integer - description: The requested offset (number of skipped results) of the call. + description: The HTTP status code of the returned result. 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: + 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. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + CreatorDataWrapper: type: object + description: The wrapper for the creator data. properties: - id: + code: type: integer - description: The unique ID of the story resource. + description: The HTTP status code of the returned result. format: int32 - title: + status: type: string - description: The story title. - description: + description: A string description of the call status. + copyright: type: string - description: A short description of the story. - resourceURI: + description: The copyright notice for the returned result. + attributionText: type: string - description: 'The canonical URL identifier for this resource. ' + 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. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + EventDataWrapper: + type: object + description: The wrapper for the event data. + 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. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + SeriesDataWrapper: + type: object + description: The wrapper for the series data. + 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. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + StoryDataWrapper: + type: object + description: The wrapper for the story data. + 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. + required: + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + +# Common Structures + ComicDate: + type: object + description: A type that represents a date and time for which the comic was released. + properties: type: type: string - description: "The story type e.g. interior story, cover, text story." - modified: + description: "A description of the date (e.g. onsale date, FOC date)." + date: type: string - description: The date the resource was most recently modified. + description: The date. 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' - ErrorResponse: + required: + - type + - date + ComicPrice: type: object - description: This is the standard error response type. + description: A type that represents a price (e.g. print price, digital price) for the comic. + 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 + required: + - type + - price + Image: + type: object + description: A type that represents an image for a resource. + properties: + path: + type: string + description: The directory path of to the image. + extension: + type: string + description: The file extension for the image. + required: + - path + - extension + TextObject: + type: object + description: A type that represents bits of descriptive text which are attached to an entity. + 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 (or language code) denoting which language the text object is written in. + text: + type: string + description: The text of the text object. + required: + - type + - language + - text + Url: + type: object + description: A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources. + properties: + type: + type: string + description: A text identifier for the URL. + url: + type: string + description: "A full URL (including scheme, domain, and path)." + required: + - type + - url + +# Errors + StandardError: + type: object + description: A standard error type. properties: code: type: string description: The HTTP status code of the returned result. required: - - code \ No newline at end of file + - code + \ No newline at end of file -- 2.52.0 From a137d4abe6fb0301274b3194c1e420b3ef319779 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 5 Oct 2025 11:28:15 +0200 Subject: [PATCH 3/4] Improved on the endpoints definitions for the OpenAPI specification in the library target. --- Sources/MarvelService/openapi.yaml | 2410 ++++++++++++++++++++++------ 1 file changed, 1897 insertions(+), 513 deletions(-) diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml index 6a18db9a..078faaee 100644 --- a/Sources/MarvelService/openapi.yaml +++ b/Sources/MarvelService/openapi.yaml @@ -46,13 +46,15 @@ paths: 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. + example: 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. + example: Sp required: false schema: type: string @@ -73,7 +75,6 @@ paths: 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). @@ -84,7 +85,6 @@ paths: 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). @@ -95,7 +95,6 @@ paths: 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). @@ -106,7 +105,6 @@ paths: 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. @@ -117,20 +115,25 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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: OK response @@ -138,18 +141,42 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not Found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}: get: tags: @@ -160,11 +187,10 @@ paths: parameters: - name: characterId in: path - description: A single character id. + description: A character id. required: true schema: type: integer - format: int32 responses: "200": description: OK response @@ -172,18 +198,48 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/comics: get: tags: - comics summary: Fetches lists of comics filtered by a character id. - description: "Fetches lists of comics containing a specific character, with optional filters." + description: Fetches lists of comics containing a specific character, with optional filters. operationId: getComicsByCharacterId parameters: - name: characterId @@ -192,19 +248,33 @@ paths: required: true schema: type: integer - format: int32 + - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. + example: comic required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. + example: comic required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -217,17 +287,22 @@ paths: required: false schema: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -246,14 +321,12 @@ paths: 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. @@ -266,7 +339,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -314,7 +386,6 @@ paths: 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). @@ -325,7 +396,6 @@ paths: 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). @@ -336,7 +406,6 @@ paths: 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). @@ -347,7 +416,6 @@ paths: 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). @@ -358,7 +426,6 @@ paths: 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). @@ -369,7 +436,6 @@ paths: 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. @@ -380,20 +446,31 @@ paths: type: array items: type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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: OK response @@ -401,28 +478,56 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/events: get: tags: - 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." + description: Fetches lists of events in which a specific character appears, with optional filters. operationId: getEventsByCharacterId parameters: - name: characterId in: path - description: The character ID. + description: A character id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -431,7 +536,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -452,7 +558,6 @@ paths: 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). @@ -463,7 +568,6 @@ paths: 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). @@ -474,7 +578,6 @@ paths: 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). @@ -485,7 +588,6 @@ paths: 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. @@ -496,48 +598,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/series: get: tags: - 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." + description: Fetches lists of comic series in which a specific character appears, with optional filters. operationId: getSeriesByCharacterId parameters: - name: characterId in: path - description: The character ID + description: A character id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -546,7 +684,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -556,7 +695,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -574,7 +712,6 @@ paths: 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). @@ -585,7 +722,6 @@ paths: 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). @@ -596,7 +732,6 @@ paths: 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). @@ -607,13 +742,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -624,6 +763,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - 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. @@ -634,33 +782,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/stories: get: tags: @@ -671,11 +856,10 @@ paths: parameters: - name: characterId in: path - description: The character ID. + description: A 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. @@ -693,7 +877,6 @@ paths: 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). @@ -704,7 +887,6 @@ paths: 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). @@ -715,7 +897,6 @@ paths: 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). @@ -726,7 +907,6 @@ paths: 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. @@ -737,33 +917,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics: get: tags: @@ -774,16 +989,28 @@ paths: parameters: - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: "Filter by the issue format." required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: "Exclude variants (alternate covers, secondary printings, director's cuts, etc.) from the result set." @@ -796,17 +1023,22 @@ paths: required: false schema: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -825,14 +1057,12 @@ paths: 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. @@ -845,7 +1075,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -893,7 +1122,6 @@ paths: 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). @@ -904,7 +1132,6 @@ paths: 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). @@ -915,7 +1142,6 @@ paths: 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). @@ -926,7 +1152,6 @@ paths: 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). @@ -937,7 +1162,6 @@ paths: 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. @@ -948,7 +1172,6 @@ paths: 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. @@ -959,7 +1182,6 @@ paths: 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. @@ -970,33 +1192,74 @@ paths: type: array items: type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}: get: tags: @@ -1007,24 +1270,53 @@ paths: parameters: - name: comicId in: path - description: A single comic. + description: A comic id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/characters: get: tags: @@ -1035,20 +1327,21 @@ paths: parameters: - name: comicId in: path - description: The comic id. + description: A 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). + description: Return only characters matching the specified full character name + example: 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. + example: Sp required: false schema: type: string @@ -1069,7 +1362,6 @@ paths: 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). @@ -1080,7 +1372,6 @@ paths: 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). @@ -1091,7 +1382,6 @@ paths: 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. @@ -1102,33 +1392,68 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/creators: get: tags: @@ -1139,56 +1464,63 @@ paths: parameters: - name: comicId in: path - description: The comic id. + description: A comic id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: "Filter by suffix or honorific" + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: "Filter by creator names that match critera" + example: B 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" + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -1209,7 +1541,6 @@ paths: 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). @@ -1220,7 +1551,6 @@ paths: 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). @@ -1231,7 +1561,7 @@ paths: 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. @@ -1242,48 +1572,88 @@ paths: type: array items: type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/events: get: tags: - 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." + description: Fetches lists of events in which a specific comic appears, with optional filters. operationId: getEventsByComicId parameters: - name: comicId in: path - description: The comic ID. + description: A comic id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -1292,7 +1662,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -1313,7 +1684,6 @@ paths: 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). @@ -1324,7 +1694,6 @@ paths: 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). @@ -1335,7 +1704,6 @@ paths: 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). @@ -1346,7 +1714,6 @@ paths: 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. @@ -1357,48 +1724,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/stories: get: tags: - 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." + description: Fetches lists of comic stories in a specific comic issue, with optional filters. operationId: getStoriesByComicId parameters: - name: comicId in: path - description: The comic ID. + description: A 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. @@ -1416,7 +1819,6 @@ paths: 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). @@ -1427,7 +1829,6 @@ paths: 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). @@ -1438,7 +1839,6 @@ paths: 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). @@ -1449,7 +1849,6 @@ paths: 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. @@ -1460,33 +1859,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators: get: tags: @@ -1497,49 +1931,57 @@ paths: parameters: - name: firstName in: query - description: Filter by creator first name (e.g. Brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B 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 criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -1560,7 +2002,6 @@ paths: 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). @@ -1571,7 +2012,6 @@ paths: 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). @@ -1582,7 +2022,6 @@ paths: 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). @@ -1593,7 +2032,6 @@ paths: 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. @@ -1604,33 +2042,74 @@ paths: type: array items: type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}: get: tags: @@ -1641,51 +2120,91 @@ paths: parameters: - name: creatorId in: path - description: A single creator id. + description: A creator id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/comics: get: tags: - 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." + description: Fetches lists of comics in which the work of a specific creator appears, with optional filters. operationId: getComicsByCreatorId parameters: - name: creatorId in: path - description: The creator ID. + description: A 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)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -1698,17 +2217,22 @@ paths: required: false schema: type: string + enum: + - thisWeek + - lastWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -1727,14 +2251,12 @@ paths: 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. @@ -1747,7 +2269,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -1799,7 +2320,6 @@ paths: 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). @@ -1810,7 +2330,6 @@ paths: 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). @@ -1821,7 +2340,6 @@ paths: 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). @@ -1832,7 +2350,6 @@ paths: 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). @@ -1843,7 +2360,6 @@ paths: 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). @@ -1854,7 +2370,6 @@ paths: 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. @@ -1865,33 +2380,74 @@ paths: type: array items: type: string + enum: + - title + - issueNumber + - modified + - onSaleDate + - focDate + - -title + - -issueNumber + - -modified + - -onSaleDate + - -focDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/events: get: tags: @@ -1902,11 +2458,10 @@ paths: parameters: - name: creatorId in: path - description: The creator ID. + description: A creator id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -1915,7 +2470,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -1936,7 +2492,6 @@ paths: 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). @@ -1947,7 +2502,6 @@ paths: 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). @@ -1958,7 +2512,6 @@ paths: 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). @@ -1969,7 +2522,6 @@ paths: 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. @@ -1980,48 +2532,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/series: get: tags: - 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." + description: Fetches lists of comic series in which a specific creator's work appears, with optional filters. operationId: getSeriesByCreatorId parameters: - name: creatorId in: path - description: The creator ID. + description: A creator id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -2030,7 +2618,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -2040,7 +2629,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -2058,7 +2646,6 @@ paths: 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). @@ -2069,7 +2656,6 @@ paths: 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). @@ -2080,7 +2666,6 @@ paths: 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). @@ -2091,13 +2676,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -2108,6 +2697,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - 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. @@ -2118,33 +2716,70 @@ paths: type: array items: type: string + enum: + - title + - startYear + - modified + - -title + - -startYear + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/stories: get: tags: @@ -2155,11 +2790,10 @@ paths: parameters: - name: creatorId in: path - description: The ID of the creator. + description: A creator id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -2177,7 +2811,6 @@ paths: 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). @@ -2188,7 +2821,6 @@ paths: 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). @@ -2199,7 +2831,6 @@ paths: 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). @@ -2210,7 +2841,6 @@ paths: 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. @@ -2221,33 +2851,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events: get: tags: @@ -2264,7 +2929,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -2285,7 +2951,6 @@ paths: 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). @@ -2296,7 +2961,6 @@ paths: 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). @@ -2307,7 +2971,6 @@ paths: 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). @@ -2318,7 +2981,6 @@ paths: 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). @@ -2329,7 +2991,6 @@ paths: 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. @@ -2340,33 +3001,70 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}: get: tags: @@ -2377,48 +3075,78 @@ paths: parameters: - name: eventId in: path - description: A single event. + description: An event id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/characters: get: tags: - 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." + description: Fetches lists of characters which appear in a specific event, with optional filters. operationId: getCharactersByEventId parameters: - name: eventId in: path - description: The event ID + description: An 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). + description: Return only characters matching the specified full character name. + example: 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. + example: Sp required: false schema: type: string @@ -2439,7 +3167,6 @@ paths: 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). @@ -2450,7 +3177,6 @@ paths: 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). @@ -2461,7 +3187,6 @@ paths: 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. @@ -2472,60 +3197,106 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/comics: get: tags: - 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." + description: Fetches lists of comics which take place during a specific event, with optional filters. operationId: getComicsByEventId parameters: - name: eventId in: path - description: The event id. + description: An 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)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -2546,17 +3317,22 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -2575,14 +3351,12 @@ paths: 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. @@ -2595,7 +3369,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -2647,7 +3420,6 @@ paths: 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). @@ -2658,7 +3430,6 @@ paths: 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). @@ -2669,7 +3440,6 @@ paths: 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). @@ -2680,7 +3450,6 @@ paths: 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). @@ -2691,7 +3460,6 @@ paths: 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). @@ -2702,7 +3470,6 @@ paths: 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). @@ -2713,7 +3480,6 @@ paths: 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. @@ -2724,93 +3490,140 @@ paths: type: array items: type: string + enum: + - focDate + - onSaleDate + - title + - issueNumber + - modified + - -focDate + - -onSaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/creators: get: tags: - 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." + description: Fetches lists of comic creators whose work appears in a specific event, with optional filters. operationId: getCreatorsByEventId parameters: - name: eventId in: path - description: The event ID. + description: An event id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B 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 criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. required: false schema: type: string @@ -2831,7 +3644,6 @@ paths: 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). @@ -2842,7 +3654,6 @@ paths: 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). @@ -2853,7 +3664,6 @@ paths: 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. @@ -2864,33 +3674,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/series: get: tags: @@ -2901,11 +3752,10 @@ paths: parameters: - name: eventId in: path - description: The event ID. + description: An event id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -2914,7 +3764,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -2924,7 +3775,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -2942,7 +3792,6 @@ paths: 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). @@ -2953,7 +3802,6 @@ paths: 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). @@ -2964,7 +3812,6 @@ paths: 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). @@ -2975,13 +3822,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -2992,6 +3843,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - 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. @@ -3002,48 +3862,84 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/stories: get: tags: - stories summary: Fetches lists of stories filtered by an event id. - description: "Fetches lists of comic stories from a specific event, with optional filters." + description: Fetches lists of comic stories from a specific event, with optional filters. operationId: getStoriesByEventId parameters: - name: eventId in: path - description: The ID of the event. + description: An event id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -3061,7 +3957,6 @@ paths: 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). @@ -3072,7 +3967,6 @@ paths: 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). @@ -3083,7 +3977,6 @@ paths: 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). @@ -3094,7 +3987,6 @@ paths: 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. @@ -3105,33 +3997,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series: get: tags: @@ -3148,7 +4075,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -3158,7 +4086,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -3176,7 +4103,6 @@ paths: 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). @@ -3187,7 +4113,6 @@ paths: 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). @@ -3198,7 +4123,6 @@ paths: 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). @@ -3209,7 +4133,6 @@ paths: 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). @@ -3220,13 +4143,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -3237,6 +4164,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - 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. @@ -3247,33 +4183,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}: get: tags: @@ -3284,20 +4257,49 @@ paths: parameters: - name: seriesId in: path - description: Filter by series title. + description: A series id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": - description: Not found response + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response content: application/json: schema: @@ -3307,25 +4309,26 @@ paths: tags: - characters summary: Fetches lists of characters filtered by a series id. - description: "Fetches lists of characters which appear in specific series, with optional filters." + description: Fetches lists of characters which appear in specific series, with optional filters. operationId: getCharactersBySeriesId parameters: - name: seriesId in: path - description: The series id. + description: A 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). + description: Return only characters matching the specified full character name. + example: 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. + example: Sp required: false schema: type: string @@ -3346,7 +4349,6 @@ paths: 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). @@ -3357,7 +4359,6 @@ paths: 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). @@ -3368,7 +4369,6 @@ paths: 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. @@ -3379,33 +4379,68 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/comics: get: tags: @@ -3416,23 +4451,34 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A 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)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -3453,17 +4499,22 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -3482,14 +4533,12 @@ paths: 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. @@ -3502,7 +4551,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -3554,7 +4602,6 @@ paths: 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). @@ -3565,7 +4612,6 @@ paths: 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). @@ -3576,7 +4622,6 @@ paths: 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). @@ -3587,7 +4632,6 @@ paths: 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). @@ -3598,7 +4642,6 @@ paths: 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). @@ -3609,7 +4652,6 @@ paths: 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. @@ -3620,93 +4662,141 @@ paths: type: array items: type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/creators: get: tags: - 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." + description: Fetches lists of comic creators whose work appears in a specific series, with optional filters. operationId: getCreatorsBySeriesId parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B 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 criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -3727,7 +4817,6 @@ paths: 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). @@ -3738,7 +4827,6 @@ paths: 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). @@ -3749,7 +4837,6 @@ paths: 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. @@ -3760,33 +4847,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/events: get: tags: @@ -3797,11 +4925,10 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -3810,7 +4937,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -3831,7 +4959,6 @@ paths: 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). @@ -3842,7 +4969,6 @@ paths: 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). @@ -3853,7 +4979,6 @@ paths: 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). @@ -3864,7 +4989,6 @@ paths: 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. @@ -3875,23 +4999,30 @@ paths: type: array items: type: string + enum: + - name + - startDate + - modified + - -name + - -startDate + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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: @@ -3912,11 +5043,10 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A 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. @@ -3934,7 +5064,6 @@ paths: 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). @@ -3945,7 +5074,6 @@ paths: 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). @@ -3956,7 +5084,6 @@ paths: 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). @@ -3967,7 +5094,6 @@ paths: 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. @@ -3978,33 +5104,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories: get: tags: @@ -4030,7 +5191,6 @@ paths: 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). @@ -4041,7 +5201,6 @@ paths: 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). @@ -4052,7 +5211,6 @@ paths: 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). @@ -4063,7 +5221,6 @@ paths: 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). @@ -4074,7 +5231,6 @@ paths: 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. @@ -4085,33 +5241,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}: get: tags: @@ -4122,20 +5313,49 @@ paths: parameters: - name: storyId in: path - description: Filter by story id. + description: A story id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": - description: Not found response + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response content: application/json: schema: @@ -4150,20 +5370,21 @@ paths: parameters: - name: storyId in: path - description: The story ID. + description: A 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). + description: Return only characters matching the specified full character name. + example: 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. + example: Sp required: false schema: type: string @@ -4184,7 +5405,6 @@ paths: 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). @@ -4195,7 +5415,6 @@ paths: 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). @@ -4206,7 +5425,6 @@ paths: 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. @@ -4217,60 +5435,106 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/comics: get: tags: - 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." + description: Fetches lists of comics in which a specific story appears, with optional filters. operationId: getComicsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A 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)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -4291,9 +5555,15 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - 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. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false @@ -4301,7 +5571,6 @@ paths: type: array items: type: integer - format: int32 - name: title in: query description: Return only issues in series whose title matches the input. @@ -4320,14 +5589,12 @@ paths: 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. @@ -4340,7 +5607,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -4392,7 +5658,6 @@ paths: 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). @@ -4403,7 +5668,6 @@ paths: 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). @@ -4414,7 +5678,6 @@ paths: 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). @@ -4425,7 +5688,6 @@ paths: 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). @@ -4436,7 +5698,6 @@ paths: 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). @@ -4447,7 +5708,6 @@ paths: 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. @@ -4458,93 +5718,141 @@ paths: type: array items: type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/creators: get: tags: - 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." + description: Fetches lists of comic creators whose work appears in a specific story, with optional filters. operationId: getCreatorsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B 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 criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -4565,7 +5873,6 @@ paths: 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). @@ -4576,7 +5883,6 @@ paths: 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). @@ -4587,7 +5893,6 @@ paths: 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. @@ -4598,48 +5903,88 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/events: get: tags: - 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." + description: Fetches lists of events in which a specific story appears, with optional filters. operationId: getEventsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -4648,7 +5993,8 @@ paths: 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. + example: Sp required: false schema: type: string @@ -4669,7 +6015,6 @@ paths: 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). @@ -4680,7 +6025,6 @@ paths: 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). @@ -4691,7 +6035,6 @@ paths: 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). @@ -4702,7 +6045,6 @@ paths: 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. @@ -4713,33 +6055,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/series: get: tags: @@ -4750,11 +6133,10 @@ paths: parameters: - name: storyId in: path - description: The story ID. + description: A 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). @@ -4765,7 +6147,6 @@ paths: type: array items: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -4784,7 +6165,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -4802,7 +6182,6 @@ paths: 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). @@ -4813,7 +6192,6 @@ paths: 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). @@ -4824,13 +6202,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -4841,6 +6223,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - 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. @@ -4851,33 +6242,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - 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/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' components: schemas: # Core Entity Representations @@ -4888,7 +6316,7 @@ components: id: type: integer description: The unique ID of the character resource. - format: int32 + name: type: string description: The name of the character. @@ -4941,11 +6369,11 @@ components: 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. @@ -4984,7 +6412,7 @@ components: 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. @@ -5083,7 +6511,6 @@ components: id: type: integer description: The unique ID of the creator resource. - format: int32 firstName: type: string description: The first name of the creator. @@ -5148,7 +6575,6 @@ components: id: type: integer description: The unique ID of the event resource. - format: int32 title: type: string description: The title of the event. @@ -5223,7 +6649,6 @@ components: id: type: integer description: The unique ID of the series resource. - format: int32 title: type: string description: The canonical title of the series. @@ -5241,11 +6666,9 @@ components: 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 + description: The last year of publication for the series (conventionally, 2099 for ongoing series). rating: type: string description: The age-appropriateness rating for the series. @@ -5302,7 +6725,6 @@ components: id: type: integer description: The unique ID of the story resource. - format: int32 title: type: string description: The story title. @@ -5455,11 +6877,10 @@ components: 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 + description: The number of characters returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of characters in this collection. @@ -5480,11 +6901,10 @@ components: 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 + description: The number of issues returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of issues in this collection. @@ -5505,11 +6925,10 @@ components: 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 + description: The number of creators returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of creators in this collection. @@ -5530,11 +6949,10 @@ components: 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 + description: The number of events returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of events in this collection. @@ -5555,11 +6973,10 @@ components: 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 + description: The number of series returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of series in this collection. @@ -5580,11 +6997,10 @@ components: 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 + description: The number of stories returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of stories in this collection. @@ -5607,20 +7023,15 @@ components: 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 + description: The total number of resources available given the current filter set. 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. @@ -5639,20 +7050,15 @@ components: 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 + description: The total number of resources available given the current filter set. 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 @@ -5671,19 +7077,15 @@ components: 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. @@ -5702,20 +7104,15 @@ components: 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 + description: The total number of resources available given the current filter set. 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 @@ -5734,20 +7131,15 @@ components: 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 + description: The total number of resources available given the current filter set. 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 @@ -5766,20 +7158,15 @@ components: 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 + description: The total number of resources available given the current filter set. 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 @@ -5800,7 +7187,6 @@ components: 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. @@ -5833,7 +7219,6 @@ components: 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. @@ -5866,7 +7251,6 @@ components: 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. @@ -5899,7 +7283,6 @@ components: 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. @@ -5932,7 +7315,6 @@ components: 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. @@ -5965,7 +7347,6 @@ components: 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. @@ -5999,7 +7380,7 @@ components: properties: type: type: string - description: "A description of the date (e.g. onsale date, FOC date)." + description: A description of the date (e.g. onsale date, FOC date). date: type: string description: The date. @@ -6013,7 +7394,7 @@ components: properties: type: type: string - description: "A description of the price (e.g. print price, digital price)." + description: A description of the price (e.g. print price, digital price). price: type: number description: The price (all prices in USD). @@ -6040,7 +7421,7 @@ components: properties: type: type: string - description: "The canonical type of the text object (e.g. solicit text, preview text, etc.)." + description: The canonical type of the text object (e.g. solicit text, preview text, etc.). language: type: string description: The IETF language tag (or language code) denoting which language the text object is written in. @@ -6060,7 +7441,7 @@ components: description: A text identifier for the URL. url: type: string - description: "A full URL (including scheme, domain, and path)." + description: A full URL (including scheme, domain, and path). required: - type - url @@ -6073,6 +7454,9 @@ components: code: type: string description: The HTTP status code of the returned result. + message: + type: string + description: A human readable message providing more details about the error. required: - code - \ No newline at end of file + -- 2.52.0 From 6b727230bc69f4d4b1b267d71970e65eb4b5ce9b Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 5 Oct 2025 14:11:13 +0200 Subject: [PATCH 4/4] Improved the formatting for the OpenAPI specification in the library target. --- Sources/MarvelService/openapi.yaml | 9033 ++++++++++++++-------------- 1 file changed, 4513 insertions(+), 4520 deletions(-) diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml index 078faaee..11ee1e08 100644 --- a/Sources/MarvelService/openapi.yaml +++ b/Sources/MarvelService/openapi.yaml @@ -20,120 +20,120 @@ info: termsOfService: https://developer.marvel.com/terms version: Cable servers: -- url: https://gateway.marvel.com - description: Live service + - url: https://gateway.marvel.com + description: Live service tags: -- 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. + - 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: - - characters + - characters summary: Fetches lists of characters. - description: Fetches lists of comic characters with optional filters. + 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. - example: Spider-Man - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Return characters with names that begin with the specified string. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - description: Return only characters which appear the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: events - in: query - description: Return only characters which appear in the specified events (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only characters matching the specified full character name. + example: Spider-Man + required: false + schema: type: string - enum: - - name - - modified - - -name - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + description: Return only characters which appear in the specified events (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - -name + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -180,17 +180,17 @@ paths: /v1/public/characters/{characterId}: get: tags: - - characters + - 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: getCharacterById parameters: - - name: characterId - in: path - description: A character id. - required: true - schema: - type: integer + - name: characterId + in: path + description: A character id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -237,240 +237,239 @@ paths: /v1/public/characters/{characterId}/comics: get: tags: - - comics + - comics summary: Fetches lists of comics filtered by a character id. description: Fetches lists of comics containing a specific character, with optional filters. operationId: getComicsByCharacterId parameters: - - name: characterId - in: path - description: The character id. - required: true - schema: - type: integer - - - name: format - in: query - description: Filter by the issue format. - example: comic - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - example: comic - required: false - schema: - type: string - enum: - - comic - - collection - - 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 - enum: - - lastWeek - - thisWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: string - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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. - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: characterId + in: path + description: The character id. + required: true + schema: type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: format + in: query + description: Filter by the issue format. + example: comic + required: false + schema: type: string enum: - - issueNumber - - modified - - onSaleDate - - focDate - - title - - -issueNumber - - -modified - - -onSaleDate - - -focDate - - -title - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + example: comic + required: false + schema: + type: string + enum: + - comic + - collection + - 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 + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: string + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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. + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -517,108 +516,108 @@ paths: /v1/public/characters/{characterId}/events: get: tags: - - events + - 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. operationId: getEventsByCharacterId parameters: - - name: characterId - in: path - description: A character id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: characterId + in: path + description: A character id. + required: true + schema: type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: comics - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only events which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Filter the event list by name. + required: false + schema: type: string - enum: - - name - - modified - - startDate - - -name - - -modified - - -startDate - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: comics + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -665,144 +664,144 @@ paths: /v1/public/characters/{characterId}/series: get: tags: - - series + - 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. operationId: getSeriesByCharacterId parameters: - - name: characterId - in: path - description: A character id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: startYear - in: query - description: Return only series matching the specified start year. - required: false - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: characterId + in: path + description: A character id. + required: true + schema: type: integer - - name: stories - in: query - description: Return only series which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: + - 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. + example: Sp + required: false + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + required: false + schema: type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: seriesType - in: query - description: Filter the series by publication frequency type. - required: false - schema: - type: string - enum: - - collection - - one shot - - limited - - ongoing - - name: contains - in: query - description: Return only series containing one or more comics with the specified format. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: seriesType + in: query + description: Filter the series by publication frequency type. + required: false + schema: type: string enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: string - enum: - - title - - modified - - startYear - - -title - - -modified - - -startYear - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - collection + - one shot + - limited + - ongoing + - name: contains + in: query + description: Return only series containing one or more comics with the specified format. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -849,93 +848,93 @@ paths: /v1/public/characters/{characterId}/stories: get: tags: - - stories + - stories summary: Fetches lists of stories filtered by a character id. description: Fetches lists of comic stories featuring a specific character with optional filters. operationId: getStoriesByCharacterId parameters: - - name: characterId - in: path - description: A character id. - required: true - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: characterId + in: path + description: A character id. + required: true + schema: type: integer - - name: series - in: query - description: Return only stories contained the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -982,241 +981,241 @@ paths: /v1/public/comics: get: tags: - - comics + - comics summary: Fetches lists of comics. description: Fetches lists of comics with optional filters. operationId: getComics parameters: - - name: format - in: query - description: "Filter by the issue format." - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - required: false - schema: - type: string - enum: - - comic - - collection - - name: noVariants - in: query - 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 - enum: - - lastWeek - - thisWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: string - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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. - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: format + in: query + description: "Filter by the issue format." + required: false + schema: type: string enum: - - issueNumber - - modified - - onSaleDate - - focDate - - title - - -issueNumber - - -modified - - -onSaleDate - - -focDate - - -title - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + required: false + schema: + type: string + enum: + - comic + - collection + - name: noVariants + in: query + 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 + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: string + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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. + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -1263,17 +1262,17 @@ paths: /v1/public/comics/{comicId}: get: tags: - - comics + - 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: getComicById parameters: - - name: comicId - in: path - description: A comic id. - required: true - schema: - type: integer + - name: comicId + in: path + description: A comic id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -1320,97 +1319,97 @@ paths: /v1/public/comics/{comicId}/characters: get: tags: - - characters + - 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. operationId: getCharactersByComicId parameters: - - name: comicId - in: path - description: A comic id. - required: true - schema: - type: integer - - name: name - in: query - description: Return only characters matching the specified full character name - example: Spider-Man - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Return characters with names that begin with the specified string. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: comicId + in: path + description: A comic id. + required: true + schema: type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only characters matching the specified full character name + example: Spider-Man + required: false + schema: type: string - enum: - - name - - modified - - -name - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - -name + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -1457,146 +1456,145 @@ paths: /v1/public/comics/{comicId}/creators: get: tags: - - creators + - 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." operationId: getCreatorsByComicId parameters: - - name: comicId - in: path - description: A comic id. - required: true - schema: - type: integer - - name: firstName - in: query - description: Filter by creator first name. - example: Brian - required: false - schema: - type: string - - name: middleName - in: query - description: Filter by creator middle name. - example: Michael - required: false - schema: - type: string - - name: lastName - in: query - description: Filter by creator last name. - example: Bendis - required: false - schema: - type: string - - name: suffix - in: query - description: "Filter by suffix or honorific" - example: Sr. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: "Filter by creator names that match critera" - example: B - required: false - schema: - type: string - - name: firstNameStartsWith - in: query - description: "Filter by creator first names that match critera" - example: B - required: false - schema: - type: string - - name: middleNameStartsWith - in: query - description: Filter by creator middle names that match criteria. - example: Mi - required: false - schema: - type: string - - name: lastNameStartsWith - in: query - description: Filter by creator last names that match criteria. - example: Ben - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: comicId + in: path + description: A comic id. + required: true + schema: type: integer - - name: series - in: query - description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: firstName + in: query + description: Filter by creator first name. + example: Brian + required: false + schema: type: string - enum: - - firstName - - middleName - - lastName - - suffix - - modified - - -firstName - - -middleName - - -lastName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: middleName + in: query + description: Filter by creator middle name. + example: Michael + required: false + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name. + example: Bendis + required: false + schema: + type: string + - name: suffix + in: query + description: "Filter by suffix or honorific" + example: Sr. + required: false + schema: + type: string + - name: nameStartsWith + in: query + description: "Filter by creator names that match critera" + example: B + required: false + schema: + type: string + - name: firstNameStartsWith + in: query + description: "Filter by creator first names that match critera" + example: B + required: false + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match criteria. + example: Mi + required: false + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match criteria. + example: Ben + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -1643,108 +1641,108 @@ paths: /v1/public/comics/{comicId}/events: get: tags: - - events + - 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. operationId: getEventsByComicId parameters: - - name: comicId - in: path - description: A comic id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: comicId + in: path + description: A comic id. + required: true + schema: type: integer - - name: characters - in: query - description: Return only events which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only events which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Filter the event list by name. + required: false + schema: type: string - enum: - - name - - modified - - startDate - - -name - - -modified - - -startDate - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -1791,93 +1789,93 @@ paths: /v1/public/comics/{comicId}/stories: get: tags: - - stories + - 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. operationId: getStoriesByComicId parameters: - - name: comicId - in: path - description: A comic id. - required: true - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: comicId + in: path + description: A comic id. + required: true + schema: type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources. - required: false - schema: - type: integer + format: date + - name: series + in: query + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources. + required: false + schema: + type: integer responses: "200": description: OK response @@ -1924,149 +1922,149 @@ paths: /v1/public/creators: get: tags: - - creators + - creators summary: Fetches lists of creators. description: Fetches lists of comic creators with optional filters. operationId: getCreators parameters: - - name: firstName - in: query - description: Filter by creator first name. - example: Brian - required: false - schema: - type: string - - name: middleName - in: query - description: Filter by creator middle name. - example: Michael - required: false - schema: - type: string - - name: lastName - in: query - description: Filter by creator last name. - example: Bendis - required: false - schema: - type: string - - name: suffix - in: query - description: Filter by suffix or honorific. - example: Sr. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Filter by creator names that match criteria. - example: B - required: false - schema: - type: string - - name: firstNameStartsWith - in: query - description: Filter by creator first names that match criteria. - example: B - required: false - schema: - type: string - - name: middleNameStartsWith - in: query - description: Filter by creator middle names that match criteria. - example: Mi - required: false - schema: - type: string - - name: lastNameStartsWith - in: query - description: Filter by creator last names that match criteria. - example: Ben - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: firstName + in: query + description: Filter by creator first name. + example: Brian + required: false + schema: type: string - enum: - - firstName - - middleName - - lastName - - suffix - - modified - - -firstName - - -middleName - - -lastName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: middleName + in: query + description: Filter by creator middle name. + example: Michael + required: false + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name. + example: Bendis + required: false + schema: + type: string + - name: suffix + in: query + description: Filter by suffix or honorific. + example: Sr. + required: false + schema: + type: string + - name: nameStartsWith + in: query + description: Filter by creator names that match criteria. + example: B + required: false + schema: + type: string + - name: firstNameStartsWith + in: query + description: Filter by creator first names that match criteria. + example: B + required: false + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match criteria. + example: Mi + required: false + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match criteria. + example: Ben + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -2113,17 +2111,17 @@ paths: /v1/public/creators/{creatorId}: get: tags: - - creators + - 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: getCreatorById parameters: - - name: creatorId - in: path - description: A creator id. - required: true - schema: - type: integer + - name: creatorId + in: path + description: A creator id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -2170,241 +2168,241 @@ paths: /v1/public/creators/{creatorId}/comics: get: tags: - - comics + - 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. operationId: getComicsByCreatorId parameters: - - name: creatorId - in: path - description: A creator id. - required: true - schema: - type: integer - - name: format - in: query - description: Filter by the issue format. - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - required: false - schema: - type: string - enum: - - comic - - collection - - 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 - enum: - - thisWeek - - lastWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: string - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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: - type: array - items: - type: boolean - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: creatorId + in: path + description: A creator id. + required: true + schema: type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: format + in: query + description: Filter by the issue format. + required: false + schema: type: string enum: - - title - - issueNumber - - modified - - onSaleDate - - focDate - - -title - - -issueNumber - - -modified - - -onSaleDate - - -focDate - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + required: false + schema: + type: string + enum: + - comic + - collection + - 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 + enum: + - thisWeek + - lastWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: string + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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: + type: array + items: + type: boolean + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - issueNumber + - modified + - onSaleDate + - focDate + - -title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -2451,108 +2449,108 @@ paths: /v1/public/creators/{creatorId}/events: get: tags: - - events + - 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. operationId: getEventsByCreatorId parameters: - - name: creatorId - in: path - description: A creator id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: creatorId + in: path + description: A creator id. + required: true + schema: type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: comics - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only events which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Filter the event list by name. + required: false + schema: type: string - enum: - - name - - modified - - startDate - - -name - - -modified - - -startDate - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: comics + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -2599,144 +2597,144 @@ paths: /v1/public/creators/{creatorId}/series: get: tags: - - series + - 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. operationId: getSeriesByCreatorId parameters: - - name: creatorId - in: path - description: A creator id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: startYear - in: query - description: Return only series matching the specified start year. - required: false - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: creatorId + in: path + description: A creator id. + required: true + schema: type: integer - - name: stories - in: query - description: Return only series which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: + - 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. + example: Sp + required: false + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + required: false + schema: type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only series which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: seriesType - in: query - description: Filter the series by publication frequency type. - required: false - schema: - type: string - enum: - - collection - - one shot - - limited - - ongoing - - name: contains - in: query - description: Return only series containing one or more comics with the specified format. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: seriesType + in: query + description: Filter the series by publication frequency type. + required: false + schema: type: string enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: string - enum: - - title - - startYear - - modified - - -title - - -startYear - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - collection + - one shot + - limited + - ongoing + - name: contains + in: query + description: Return only series containing one or more comics with the specified format. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - startYear + - modified + - -title + - -startYear + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -2783,93 +2781,93 @@ paths: /v1/public/creators/{creatorId}/stories: get: tags: - - stories + - stories summary: Fetches lists of stories filtered by a creator id. description: Fetches lists of comic stories by a specific creator with optional filters. operationId: getStoriesByCreatorId parameters: - - name: creatorId - in: path - description: A creator id. - required: true - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: creatorId + in: path + description: A creator id. + required: true + schema: type: integer - - name: series - in: query - description: Return only stories contained the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + format: date + - name: comics + in: query + description: Return only stories contained in the specified comics (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -2916,112 +2914,112 @@ paths: /v1/public/events: get: tags: - - events + - events summary: Fetches lists of events. 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only events which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: comics - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - 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: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only events which match the specified name. + required: false + schema: type: string - enum: - - name - - modified - - startDate - - -name - - -modified - - -startDate - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: comics + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + 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: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -3068,17 +3066,17 @@ paths: /v1/public/events/{eventId}: get: tags: - - events + - 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: getEventById parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer + - name: eventId + in: path + description: An event id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -3125,97 +3123,97 @@ paths: /v1/public/events/{eventId}/characters: get: tags: - - characters + - 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. operationId: getCharactersByEventId parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer - - name: name - in: query - description: Return only characters matching the specified full character name. - example: Spider-Man. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Return characters with names that begin with the specified string. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: eventId + in: path + description: An event id. + required: true + schema: type: integer - - name: series - in: query - description: Return only characters which appear the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only characters matching the specified full character name. + example: Spider-Man. + required: false + schema: type: string - enum: - - name - - modified - - -name - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - -name + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -3262,259 +3260,259 @@ paths: /v1/public/events/{eventId}/comics: get: tags: - - comics + - 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. operationId: getComicsByEventId parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer - - name: format - in: query - description: Filter by the issue format. - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - required: false - schema: - type: string - enum: - - comic - - collection - - name: noVariants - in: query - description: Exclude variant comics from the result set. - required: false - style: form - explode: false - schema: - type: array - items: - type: boolean - - name: dateDescriptor - in: query - description: Return comics within a predefined date range. - required: false - style: form - explode: false - schema: - type: array - items: + - name: eventId + in: path + description: An event id. + required: true + schema: + type: integer + - name: format + in: query + description: Filter by the issue format. + required: false + schema: type: string enum: - - lastWeek - - thisWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: string - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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: - type: array - items: - type: boolean - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + required: false + schema: type: string enum: - - focDate - - onSaleDate - - title - - issueNumber - - modified - - -focDate - - -onSaleDate - - -title - - -issueNumber - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - collection + - name: noVariants + in: query + description: Exclude variant comics from the result set. + required: false + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: string + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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: + type: array + items: + type: boolean + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - focDate + - onSaleDate + - title + - issueNumber + - modified + - -focDate + - -onSaleDate + - -title + - -issueNumber + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -3561,144 +3559,144 @@ paths: /v1/public/events/{eventId}/creators: get: tags: - - creators + - 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. operationId: getCreatorsByEventId parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer - - name: firstName - in: query - description: Filter by creator first name. - example: Brian - required: false - schema: - type: string - - name: middleName - in: query - description: Filter by creator middle name. - example: Michael - required: false - schema: - type: string - - name: lastName - in: query - description: Filter by creator last name. - example: Bendis - required: false - schema: - type: string - - name: suffix - in: query - description: Filter by suffix or honorific. - example: Sr. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Filter by creator names that match criteria. - example: B - required: false - schema: - type: string - - name: firstNameStartsWith - in: query - description: Filter by creator first names that match criteria. - example: B - required: false - schema: - type: string - - name: middleNameStartsWith - in: query - description: Filter by creator middle names that match criteria. - example: Mi - required: false - schema: - type: string - - name: lastNameStartsWith - in: query - description: Filter by creator last names that match criteria. - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: eventId + in: path + description: An event id. + required: true + schema: type: integer - - name: series - in: query - description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: firstName + in: query + description: Filter by creator first name. + example: Brian + required: false + schema: type: string - enum: - - lastName - - firstName - - middleName - - suffix - - modified - - -lastName - - -firstName - - -middleName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: middleName + in: query + description: Filter by creator middle name. + example: Michael + required: false + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name. + example: Bendis + required: false + schema: + type: string + - name: suffix + in: query + description: Filter by suffix or honorific. + example: Sr. + required: false + schema: + type: string + - name: nameStartsWith + in: query + description: Filter by creator names that match criteria. + example: B + required: false + schema: + type: string + - name: firstNameStartsWith + in: query + description: Filter by creator first names that match criteria. + example: B + required: false + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match criteria. + example: Mi + required: false + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match criteria. + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -3741,148 +3739,148 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StandardError' + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/series: get: tags: - - series + - 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." operationId: getSeriesByEventId parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: startYear - in: query - description: Return only series matching the specified start year. - required: false - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: eventId + in: path + description: An event id. + required: true + schema: type: integer - - name: stories - in: query - description: Return only series which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: + - 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. + example: Sp + required: false + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + required: false + schema: type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only series which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: seriesType - in: query - description: Filter the series by publication frequency type. - required: false - schema: - type: string - enum: - - collection - - one shot - - limited - - ongoing - - name: contains - in: query - description: Return only series containing one or more comics with the specified format. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: seriesType + in: query + description: Filter the series by publication frequency type. + required: false + schema: type: string enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: string - enum: - - title - - modified - - startYear - - -title - - -modified - - -startYear - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - collection + - one shot + - limited + - ongoing + - name: contains + in: query + description: Return only series containing one or more comics with the specified format. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -3929,93 +3927,93 @@ paths: /v1/public/events/{eventId}/stories: get: tags: - - stories + - stories summary: Fetches lists of stories filtered by an event id. description: Fetches lists of comic stories from a specific event, with optional filters. operationId: getStoriesByEventId parameters: - - name: eventId - in: path - description: An event id. - required: true - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: eventId + in: path + description: An event id. + required: true + schema: type: integer - - name: series - in: query - description: Return only stories contained the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -4062,148 +4060,148 @@ paths: /v1/public/series: get: tags: - - series + - series summary: Fetches lists of series. 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. - example: Sp - required: false - schema: - type: string - - name: startYear - in: query - description: Return only series matching the specified start year. - required: false - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - 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. + example: Sp + required: false + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + required: false + schema: type: integer - - name: stories - in: query - description: Return only series which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only series which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: seriesType - in: query - description: Filter the series by publication frequency type. - required: false - schema: - type: string - enum: - - collection - - one shot - - limited - - ongoing - - name: contains - in: query - description: Return only series containing one or more comics with the specified format. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only series which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: seriesType + in: query + description: Filter the series by publication frequency type. + required: false + schema: type: string enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: string - enum: - - title - - modified - - startYear - - -title - - -modified - - -startYear - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - collection + - one shot + - limited + - ongoing + - name: contains + in: query + description: Return only series containing one or more comics with the specified format. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -4250,17 +4248,17 @@ paths: /v1/public/series/{seriesId}: get: tags: - - series + - 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: getSeriesById parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer + - name: seriesId + in: path + description: A series id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -4307,97 +4305,97 @@ paths: /v1/public/series/{seriesId}/characters: get: tags: - - characters + - characters summary: Fetches lists of characters filtered by a series id. description: Fetches lists of characters which appear in specific series, with optional filters. operationId: getCharactersBySeriesId parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer - - name: name - in: query - description: Return only characters matching the specified full character name. - example: Spider-Man - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Return characters with names that begin with the specified string. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: seriesId + in: path + description: A series id. + required: true + schema: type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only characters matching the specified full character name. + example: Spider-Man + required: false + schema: type: string - enum: - - name - - modified - - -name - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - -name + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -4444,249 +4442,249 @@ paths: /v1/public/series/{seriesId}/comics: get: tags: - - comics + - 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." operationId: getComicsBySeriesId parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer - - name: format - in: query - description: Filter by the issue format. - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - required: false - schema: - type: string - enum: - - comic - - collection - - name: noVariants - in: query - description: Exclude variant comics from the result set. - required: false - style: form - explode: false - schema: - type: array - items: - type: boolean - - name: dateDescriptor - in: query - description: Return comics within a predefined date range. - required: false - style: form - explode: false - schema: - type: array - items: + - name: seriesId + in: path + description: A series id. + required: true + schema: + type: integer + - name: format + in: query + description: Filter by the issue format. + required: false + schema: type: string enum: - - lastWeek - - thisWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: string - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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: - type: array - items: - type: boolean - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + required: false + schema: type: string enum: - - focDate - - onsaleDate - - title - - issueNumber - - modified - - -focDate - - -onsaleDate - - -title - - -issueNumber - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - collection + - name: noVariants + in: query + description: Exclude variant comics from the result set. + required: false + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: string + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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: + type: array + items: + type: boolean + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -4733,145 +4731,145 @@ paths: /v1/public/series/{seriesId}/creators: get: tags: - - creators + - 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. operationId: getCreatorsBySeriesId parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer - - name: firstName - in: query - description: Filter by creator first name. - example: Brian - required: false - schema: - type: string - - name: middleName - in: query - description: Filter by creator middle name. - example: Michael - required: false - schema: - type: string - - name: lastName - in: query - description: Filter by creator last name. - example: Bendis - required: false - schema: - type: string - - name: suffix - in: query - description: Filter by suffix or honorific. - example: Sr. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Filter by creator names that match criteria. - example: B - required: false - schema: - type: string - - name: firstNameStartsWith - in: query - description: Filter by creator first names that match criteria. - example: B - required: false - schema: - type: string - - name: middleNameStartsWith - in: query - description: Filter by creator middle names that match criteria. - example: Mi - required: false - schema: - type: string - - name: lastNameStartsWith - in: query - description: Filter by creator last names that match criteria. - example: Ben - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: seriesId + in: path + description: A series id. + required: true + schema: type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: stories - in: query - description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: firstName + in: query + description: Filter by creator first name. + example: Brian + required: false + schema: type: string - enum: - - lastName - - firstName - - middleName - - suffix - - modified - - -lastName - - -firstName - - -middleName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: middleName + in: query + description: Filter by creator middle name. + example: Michael + required: false + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name. + example: Bendis + required: false + schema: + type: string + - name: suffix + in: query + description: Filter by suffix or honorific. + example: Sr. + required: false + schema: + type: string + - name: nameStartsWith + in: query + description: Filter by creator names that match criteria. + example: B + required: false + schema: + type: string + - name: firstNameStartsWith + in: query + description: Filter by creator first names that match criteria. + example: B + required: false + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match criteria. + example: Mi + required: false + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match criteria. + example: Ben + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: stories + in: query + description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -4918,108 +4916,108 @@ paths: /v1/public/series/{seriesId}/events: get: tags: - - events + - 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." operationId: getEventsBySeriesId parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: seriesId + in: path + description: A series id. + required: true + schema: type: integer - - name: characters - in: query - description: Return only events which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: comics - in: query - 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: - type: array - items: - type: integer - - name: stories - in: query - description: Return only events which contain the specified stories (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Filter the event list by name. + required: false + schema: type: string - enum: - - name - - startDate - - modified - - -name - - -startDate - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: comics + in: query + 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: + type: array + items: + type: integer + - name: stories + in: query + description: Return only events which contain the specified stories (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - startDate + - modified + - -name + - -startDate + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5036,93 +5034,93 @@ paths: /v1/public/series/{seriesId}/stories: get: tags: - - stories + - stories summary: Fetches lists of stories filtered by a series id. description: Fetches lists of comic stories from a specific series with optional filters. operationId: getStoriesBySeriesId parameters: - - name: seriesId - in: path - description: A series id. - required: true - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: seriesId + in: path + description: A series id. + required: true + schema: type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5169,97 +5167,97 @@ paths: /v1/public/stories: get: tags: - - stories + - stories summary: Fetches lists of stories. 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. - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - description: Return only stories contained the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + description: Return only stories which have been modified since the specified date. + required: false + schema: type: string - enum: - - id - - modified - - -id - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + format: date + - name: comics + in: query + description: Return only stories contained in the specified (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only stories contained the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - id + - modified + - -id + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5306,17 +5304,17 @@ paths: /v1/public/stories/{storyId}: get: tags: - - stories + - 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: getStoryById parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer + - name: storyId + in: path + description: A story id. + required: true + schema: + type: integer responses: "200": description: OK response @@ -5363,97 +5361,97 @@ paths: /v1/public/stories/{storyId}/characters: get: tags: - - characters + - 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." operationId: getCharactersByStoryId parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer - - name: name - in: query - description: Return only characters matching the specified full character name. - example: Spider-Man - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Return characters with names that begin with the specified string. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: storyId + in: path + description: A story id. + required: true + schema: type: integer - - name: series - in: query - description: Return only characters which appear the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Return only characters matching the specified full character name. + example: Spider-Man + required: false + schema: type: string - enum: - - name - - modified - - -name - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return characters with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only characters which appear the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - name + - modified + - -name + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5500,249 +5498,249 @@ paths: /v1/public/stories/{storyId}/comics: get: tags: - - comics + - 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. operationId: getComicsByStoryId parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer - - name: format - in: query - description: Filter by the issue format. - required: false - schema: - type: string - enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - name: formatType - in: query - description: Filter by the issue format type. - required: false - schema: - type: string - enum: - - comic - - collection - - name: noVariants - in: query - description: Exclude variant comics from the result set. - required: false - style: form - explode: false - schema: - type: array - items: - type: boolean - - name: dateDescriptor - in: query - description: Return comics within a predefined date range. - required: false - style: form - explode: false - schema: - type: array - items: + - name: storyId + in: path + description: A story id. + required: true + schema: + type: integer + - name: format + in: query + description: Filter by the issue format. + required: false + schema: type: string enum: - - lastWeek - - thisWeek - - nextWeek - - thisMonth - - name: dateRange - in: query - description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. - example: 2013-01-01,2013-01-02 - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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 - - name: issueNumber - in: query - description: Return only issues in series whose issue number matches the input. - required: false - schema: - type: integer - - 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 - - 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: - type: array - items: - type: boolean - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: characters - in: query - description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: events - in: query - 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: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - name: formatType + in: query + description: Filter by the issue format type. + required: false + schema: type: string enum: - - focDate - - onsaleDate - - title - - issueNumber - - modified - - -focDate - - -onsaleDate - - -title - - -issueNumber - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - comic + - collection + - name: noVariants + in: query + description: Exclude variant comics from the result set. + required: false + style: form + explode: false + schema: + type: array + items: + type: boolean + - name: dateDescriptor + in: query + description: Return comics within a predefined date range. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth + - name: dateRange + in: query + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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 + - name: issueNumber + in: query + description: Return only issues in series whose issue number matches the input. + required: false + schema: + type: integer + - 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 + - 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: + type: array + items: + type: boolean + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: events + in: query + 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: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5789,145 +5787,145 @@ paths: /v1/public/stories/{storyId}/creators: get: tags: - - creators + - 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. operationId: getCreatorsByStoryId parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer - - name: firstName - in: query - description: Filter by creator first name. - example: Brian - required: false - schema: - type: string - - name: middleName - in: query - description: Filter by creator middle name. - example: Michael - required: false - schema: - type: string - - name: lastName - in: query - description: Filter by creator last name. - example: Bendis - required: false - schema: - type: string - - name: suffix - in: query - description: Filter by suffix or honorific. - example: Sr. - required: false - schema: - type: string - - name: nameStartsWith - in: query - description: Filter by creator names that match criteria. - example: B - required: false - schema: - type: string - - name: firstNameStartsWith - in: query - description: Filter by creator first names that match criteria. - example: B - required: false - schema: - type: string - - name: middleNameStartsWith - in: query - description: Filter by creator middle names that match criteria. - example: Mi - required: false - schema: - type: string - - name: lastNameStartsWith - in: query - description: Filter by creator last names that match criteria. - example: Ben - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: storyId + in: path + description: A story id. + required: true + schema: type: integer - - name: series - in: query - description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: firstName + in: query + description: Filter by creator first name. + example: Brian + required: false + schema: type: string - enum: - - lastName - - firstName - - middleName - - suffix - - modified - - -lastName - - -firstName - - -middleName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: middleName + in: query + description: Filter by creator middle name. + example: Michael + required: false + schema: + type: string + - name: lastName + in: query + description: Filter by creator last name. + example: Bendis + required: false + schema: + type: string + - name: suffix + in: query + description: Filter by suffix or honorific. + example: Sr. + required: false + schema: + type: string + - name: nameStartsWith + in: query + description: Filter by creator names that match criteria. + example: B + required: false + schema: + type: string + - name: firstNameStartsWith + in: query + description: Filter by creator first names that match criteria. + example: B + required: false + schema: + type: string + - name: middleNameStartsWith + in: query + description: Filter by creator middle names that match criteria. + example: Mi + required: false + schema: + type: string + - name: lastNameStartsWith + in: query + description: Filter by creator last names that match criteria. + example: Ben + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -5974,112 +5972,112 @@ paths: /v1/public/stories/{storyId}/events: get: tags: - - events + - 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. operationId: getEventsByStoryId parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer - - 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. - example: Sp - required: false - schema: - type: string - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: storyId + in: path + description: A story id. + required: true + schema: type: integer - - name: characters - in: query - description: Return only events which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: series - in: query - 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: - type: array - items: - type: integer - - name: comics - in: query - 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: - type: array - items: - type: integer - - 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. - required: false - style: form - explode: false - schema: - type: array - items: + - name: name + in: query + description: Filter the event list by name. + required: false + schema: type: string - enum: - - lastName - - firstName - - middleName - - suffix - - modified - - -lastName - - -firstName - - -middleName - - -suffix - - -modified - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - name: nameStartsWith + in: query + description: Return events with names that begin with the specified string. + example: Sp + required: false + schema: + type: string + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: characters + in: query + description: Return only events which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: series + in: query + 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: + type: array + items: + type: integer + - name: comics + in: query + 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: + type: array + items: + type: integer + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -6126,143 +6124,143 @@ paths: /v1/public/stories/{storyId}/series: get: tags: - - series + - series summary: Fetches lists of series filtered by a story id. description: Fetches lists of comic series in which the specified story takes place. operationId: getSeriesByStoryId parameters: - - name: storyId - in: path - description: A story id. - required: true - schema: - type: integer - - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - name: storyId + in: path + description: A story id. + required: true + schema: type: integer - - 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). - required: false - schema: - type: string - - name: startYear - in: query - description: Return only series matching the specified start year. - required: false - schema: - type: integer - - name: modifiedSince - in: query - 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). - required: false - style: form - explode: false - schema: - type: array - items: + - 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - 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). + required: false + schema: + type: string + - name: startYear + in: query + description: Return only series matching the specified start year. + required: false + schema: type: integer - - name: creators - in: query - 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: - type: array - items: - type: integer - - name: characters - in: query - description: Return only series which feature the specified characters (accepts a comma-separated list of ids). - required: false - style: form - explode: false - schema: - type: array - items: - type: integer - - name: seriesType - in: query - description: Filter the series by publication frequency type. - required: false - schema: - type: string - enum: - - collection - - one shot - - limited - - ongoing - - name: contains - in: query - description: Return only series containing one or more comics with the specified format. - required: false - style: form - explode: false - schema: - type: array - items: + - name: modifiedSince + in: query + 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). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: creators + in: query + 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: + type: array + items: + type: integer + - name: characters + in: query + description: Return only series which feature the specified characters (accepts a comma-separated list of ids). + required: false + style: form + explode: false + schema: + type: array + items: + type: integer + - name: seriesType + in: query + description: Filter the series by publication frequency type. + required: false + schema: type: string enum: - - comic - - magazine - - trade paperback - - hardcover - - digest - - graphic novel - - digital comic - - infinite comic - - 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. - required: false - style: form - explode: false - schema: - type: array - items: - type: string - enum: - - title - - modified - - startYear - - -title - - -modified - - -startYear - - name: limit - in: query - description: Limit the result set to the specified number of resources. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - - name: offset - in: query - description: Skip the specified number of resources in the result set. - required: false - schema: - type: integer + - collection + - one shot + - limited + - ongoing + - name: contains + in: query + description: Return only series containing one or more comics with the specified format. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic + - 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. + required: false + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear + - name: limit + in: query + description: Limit the result set to the specified number of resources. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: offset + in: query + description: Skip the specified number of resources in the result set. + required: false + schema: + type: integer responses: "200": description: OK response @@ -6316,7 +6314,6 @@ components: id: type: integer description: The unique ID of the character resource. - name: type: string description: The name of the character. @@ -6351,17 +6348,17 @@ components: description: A resource list containing series in which this character appears. $ref: '#/components/schemas/SeriesList' required: - - id - - name - - description - - modified - - resourceURI - - urls - - thumbnail - - comics - - stories - - events - - series + - id + - name + - description + - modified + - resourceURI + - urls + - thumbnail + - comics + - stories + - events + - series Comic: type: object description: A comic book resource type that represents physical or digital products that end-users read. This definition includes individual print and digital comic issues, collections and graphic novels (e.g. Amazing Fantasy \#15). @@ -6369,11 +6366,9 @@ components: id: type: integer description: The unique ID of the comic resource. - digitalId: type: integer description: The ID of the digital comic representation of this comic. Will be 0 if the comic is not available digitally. - title: type: string description: The canonical title of the comic. @@ -6412,7 +6407,6 @@ components: pageCount: type: integer description: The number of story pages in the comic. - textObjects: type: array description: A set of descriptive text blurbs for the comic. @@ -6475,35 +6469,35 @@ components: description: A resource list containing events which this comic appears. $ref: '#/components/schemas/EventList' required: - - id - - digitalId - - title - - issueNumber - - variantDescription - - description - - modified - - isbn - - upc - - diamondCode - - ean - - issn - - format - - pageCount - - textObjects - - resourceURI - - urls - - series - - variants - - collections - - collectedIssues - - dates - - prices - - thumbnail - - images - - creators - - characters - - stories - - events + - id + - digitalId + - title + - issueNumber + - variantDescription + - description + - modified + - isbn + - upc + - diamondCode + - ean + - issn + - format + - pageCount + - textObjects + - resourceURI + - urls + - series + - variants + - collections + - collectedIssues + - dates + - prices + - thumbnail + - images + - creators + - characters + - stories + - events Creator: type: object description: A creator resource type that represents women, men and organizations who create comics (e.g. Jack Kirby). They are assigned to the specific comic stories on which they worked, but we bubble up those assignments to the issues, series and events in which the stories appear as a convenience. @@ -6554,20 +6548,20 @@ components: description: A resource list containing events which feature work by this creator. $ref: '#/components/schemas/EventList' required: - - id - - firstName - - middleName - - lastName - - suffix - - fullName - - modified - - resourceURI - - urls - - thumbnail - - series - - stories - - comics - - events + - id + - firstName + - middleName + - lastName + - suffix + - fullName + - modified + - resourceURI + - urls + - thumbnail + - series + - stories + - comics + - events Event: type: object description: An event resource type that represents big, universe-altering storylines (e.g. Infinity). A comic's appearance in an event is often independent of its membership in a series. @@ -6626,22 +6620,22 @@ components: description: A summary representation of the event which preceded this event. $ref: '#/components/schemas/EventSummary' required: - - id - - title - - description - - resourceURI - - urls - - modified - - start - - end - - thumbnail - - comics - - stories - - series - - characters - - creators - - next - - previous + - id + - title + - description + - resourceURI + - urls + - modified + - start + - end + - thumbnail + - comics + - stories + - series + - characters + - creators + - next + - previous Series: type: object description: A series resource type that represents (usually) sequentially number list of comics with the same title and volume (e.g. Uncanny X-Men). Marvel uses the year of original publication for a series as the volume number. @@ -6701,23 +6695,23 @@ components: description: A summary representation of the series which preceded this series. $ref: '#/components/schemas/SeriesSummary' required: - - id - - title - - description - - resourceURI - - urls - - startYear - - endYear - - rating - - modified - - thumbnail - - comics - - stories - - events - - characters - - creators - - next - - previous + - id + - title + - description + - resourceURI + - urls + - startYear + - endYear + - rating + - modified + - thumbnail + - comics + - stories + - events + - characters + - creators + - next + - previous Story: type: object description: A story resource type that represents an indivisible, reusable components of comics. Most comics have two stories - a cover and an interior story (e. g. the cover from Amazing Fantasy \#15 and the origin of Spider-Man story from that comic) - but many, such as anthology comics and collections, will have more. Stories may be re-published in several comics, but the comic in which they originally appeared will always be present as a data point. @@ -6763,20 +6757,20 @@ components: description: A summary representation of the issue in which this story was originally published. $ref: '#/components/schemas/ComicSummary' required: - - id - - title - - description - - resourceURI - - type - - modified - - thumbnail - - comics - - series - - events - - characters - - creators - - originalissue - + - id + - title + - description + - resourceURI + - type + - modified + - thumbnail + - comics + - series + - events + - characters + - creators + - originalissue + # Core Entity Summary Representations CharacterSummary: type: object @@ -6792,9 +6786,9 @@ components: type: string description: The role of the creator in the parent entity. required: - - resourceURI - - name - - role + - resourceURI + - name + - role ComicSummary: type: object description: A type that represents a summary of a comic resource. @@ -6806,8 +6800,8 @@ components: type: string description: The canonical name of the comic. required: - - resourceURI - - name + - resourceURI + - name CreatorSummary: type: object description: A type that represents a summary of a creator resource. @@ -6822,9 +6816,9 @@ components: type: string description: The role of the creator in the parent entity. required: - - resourceURI - - name - - role + - resourceURI + - name + - role EventSummary: type: object description: A type that represents a summary of an event resource. @@ -6836,8 +6830,8 @@ components: type: string description: The name of the event. required: - - resourceURI - - name + - resourceURI + - name SeriesSummary: type: object description: A type that represents a summary of a series resource. @@ -6849,8 +6843,8 @@ components: type: string description: The canonical name of the series. required: - - resourceURI - - name + - resourceURI + - name StorySummary: type: object description: A type that represents a summary of a story resource. @@ -6865,10 +6859,10 @@ components: type: string description: The type of the story (interior or cover). required: - - resourceURI - - name - - type - + - resourceURI + - name + - type + # Core Entity List Representations CharacterList: type: object @@ -6890,10 +6884,10 @@ components: items: $ref: '#/components/schemas/CharacterSummary' required: - - available - - returned - - collectionURI - - items + - available + - returned + - collectionURI + - items ComicList: type: object description: A resource list containing comics which feature this story. @@ -6913,11 +6907,11 @@ components: description: The list of returned issues in this collection. items: $ref: '#/components/schemas/ComicSummary' - required: - - available - - returned - - collectionURI - - items + required: + - available + - returned + - collectionURI + - items CreatorList: type: object description: A resource list containing creators whose work appears in this story. @@ -6938,10 +6932,10 @@ components: items: $ref: '#/components/schemas/CreatorSummary' required: - - available - - returned - - collectionURI - - items + - available + - returned + - collectionURI + - items EventList: type: object description: A resource list containing events which feature this story. @@ -6962,10 +6956,10 @@ components: items: $ref: '#/components/schemas/EventSummary' required: - - available - - returned - - collectionURI - - items + - available + - returned + - collectionURI + - items SeriesList: type: object description: A resource list containing series in which this story appears. @@ -6986,10 +6980,10 @@ components: items: $ref: '#/components/schemas/SeriesSummary' required: - - available - - returned - - collectionURI - - items + - available + - returned + - collectionURI + - items StoryList: type: object description: A resource list containing stories which are related to this story. @@ -7010,11 +7004,11 @@ components: items: $ref: '#/components/schemas/StorySummary' required: - - available - - returned - - collectionURI - - items - + - available + - returned + - collectionURI + - items + # Core Entity Container Representations CharacterDataContainer: type: object @@ -7038,11 +7032,11 @@ components: items: $ref: '#/components/schemas/Character' required: - - offset - - limit - - total - - count - - results + - offset + - limit + - total + - count + - results ComicDataContainer: type: object description: The container for the comic data. @@ -7065,11 +7059,11 @@ components: items: $ref: '#/components/schemas/Comic' required: - - offset - - limit - - total - - count - - results + - offset + - limit + - total + - count + - results CreatorDataContainer: type: object description: A container type for lists of creators. @@ -7092,11 +7086,11 @@ components: items: $ref: '#/components/schemas/Creator' required: - - offset - - limit - - total - - count - - results + - offset + - limit + - total + - count + - results EventDataContainer: type: object description: The container for the event data. @@ -7119,11 +7113,11 @@ components: items: $ref: '#/components/schemas/Event' required: - - offset - - limit - - total - - count - - results + - offset + - limit + - total + - count + - results SeriesDataContainer: type: object description: The container for the series data. @@ -7146,11 +7140,11 @@ components: items: $ref: '#/components/schemas/Series' required: - - offset - - limit - - total - - count - - results + - offset + - limit + - total + - count + - results StoryDataContainer: type: object description: The container for the story data. @@ -7173,12 +7167,12 @@ components: items: $ref: '#/components/schemas/Story' required: - - offset - - limit - - total - - count - - results - + - offset + - limit + - total + - count + - results + # Core Entity Wrapper Representations CharacterDataWrapper: type: object @@ -7205,13 +7199,13 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag ComicDataWrapper: type: object description: The wrapper for the comic data. @@ -7237,13 +7231,13 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag CreatorDataWrapper: type: object description: The wrapper for the creator data. @@ -7269,13 +7263,13 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag EventDataWrapper: type: object description: The wrapper for the event data. @@ -7301,13 +7295,13 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag SeriesDataWrapper: type: object description: The wrapper for the series data. @@ -7333,13 +7327,13 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag StoryDataWrapper: type: object description: The wrapper for the story data. @@ -7365,14 +7359,14 @@ components: type: string description: A digest value of the content returned by the call. required: - - code - - status - - copyright - - attributionText - - attributionHTML - - data - - etag - + - code + - status + - copyright + - attributionText + - attributionHTML + - data + - etag + # Common Structures ComicDate: type: object @@ -7386,8 +7380,8 @@ components: description: The date. format: date required: - - type - - date + - type + - date ComicPrice: type: object description: A type that represents a price (e.g. print price, digital price) for the comic. @@ -7400,8 +7394,8 @@ components: description: The price (all prices in USD). format: float required: - - type - - price + - type + - price Image: type: object description: A type that represents an image for a resource. @@ -7413,8 +7407,8 @@ components: type: string description: The file extension for the image. required: - - path - - extension + - path + - extension TextObject: type: object description: A type that represents bits of descriptive text which are attached to an entity. @@ -7429,9 +7423,9 @@ components: type: string description: The text of the text object. required: - - type - - language - - text + - type + - language + - text Url: type: object description: A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources. @@ -7443,8 +7437,8 @@ components: type: string description: A full URL (including scheme, domain, and path). required: - - type - - url + - type + - url # Errors StandardError: @@ -7459,4 +7453,3 @@ components: description: A human readable message providing more details about the error. required: - code - -- 2.52.0