From 6b727230bc69f4d4b1b267d71970e65eb4b5ce9b Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 5 Oct 2025 14:11:13 +0200 Subject: [PATCH] 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 -