From a137d4abe6fb0301274b3194c1e420b3ef319779 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 5 Oct 2025 11:28:15 +0200 Subject: [PATCH] Improved on the endpoints definitions for the OpenAPI specification in the library target. --- Sources/MarvelService/openapi.yaml | 2410 ++++++++++++++++++++++------ 1 file changed, 1897 insertions(+), 513 deletions(-) diff --git a/Sources/MarvelService/openapi.yaml b/Sources/MarvelService/openapi.yaml index 6a18db9a..078faaee 100644 --- a/Sources/MarvelService/openapi.yaml +++ b/Sources/MarvelService/openapi.yaml @@ -46,13 +46,15 @@ paths: parameters: - name: name in: query - description: Return only characters matching the specified full character name (e.g. Spider-Man). + description: Return only characters matching the specified full character name. + example: Spider-Man required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string (e.g. Sp). + description: Return characters with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -73,7 +75,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only characters which appear the specified series (accepts a comma-separated list of ids). @@ -84,7 +85,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only characters which appear in the specified events (accepts a comma-separated list of ids). @@ -95,7 +95,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). @@ -106,7 +105,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -117,20 +115,25 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": description: OK response @@ -138,18 +141,42 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not Found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}: get: tags: @@ -160,11 +187,10 @@ paths: parameters: - name: characterId in: path - description: A single character id. + description: A character id. required: true schema: type: integer - format: int32 responses: "200": description: OK response @@ -172,18 +198,48 @@ paths: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/comics: get: tags: - comics summary: Fetches lists of comics filtered by a character id. - description: "Fetches lists of comics containing a specific character, with optional filters." + description: Fetches lists of comics containing a specific character, with optional filters. operationId: getComicsByCharacterId parameters: - name: characterId @@ -192,19 +248,33 @@ paths: required: true schema: type: integer - format: int32 + - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. + example: comic required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. + example: comic required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -217,17 +287,22 @@ paths: required: false schema: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -246,14 +321,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -266,7 +339,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -314,7 +386,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). @@ -325,7 +396,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -336,7 +406,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). @@ -347,7 +416,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). @@ -358,7 +426,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). @@ -369,7 +436,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -380,20 +446,31 @@ paths: type: array items: type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": description: OK response @@ -401,28 +478,56 @@ paths: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/events: get: tags: - events summary: Fetches lists of events filtered by a character id. - description: "Fetches lists of events in which a specific character appears,\ - \ with optional filters." + description: Fetches lists of events in which a specific character appears, with optional filters. operationId: getEventsByCharacterId parameters: - name: characterId in: path - description: The character ID. + description: A character id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -431,7 +536,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -452,7 +558,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only events which are part of the specified series (accepts a comma-separated list of ids). @@ -463,7 +568,6 @@ paths: type: array items: type: integer - format: int32 - name: comics in: query description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). @@ -474,7 +578,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only events which contain the specified stories (accepts a comma-separated list of ids). @@ -485,7 +588,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -496,48 +598,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/series: get: tags: - series summary: Fetches lists of series filtered by a character id. - description: "Fetches lists of comic series in which a specific character appears, with optional filters. See notes on individual parameters below." + description: Fetches lists of comic series in which a specific character appears, with optional filters. operationId: getSeriesByCharacterId parameters: - name: characterId in: path - description: The character ID + description: A character id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -546,7 +684,8 @@ paths: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string (e.g. Sp). + description: Return series with titles that begin with the specified string. + example: Sp required: false schema: type: string @@ -556,7 +695,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -574,7 +712,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only series which contain the specified stories (accepts a comma-separated list of ids). @@ -585,7 +722,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). @@ -596,7 +732,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). @@ -607,13 +742,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -624,6 +763,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -634,33 +782,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/characters/{characterId}/stories: get: tags: @@ -671,11 +856,10 @@ paths: parameters: - name: characterId in: path - description: The character ID. + description: A character id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -693,7 +877,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only stories contained the specified series (accepts a comma-separated list of ids). @@ -704,7 +887,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). @@ -715,7 +897,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). @@ -726,7 +907,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -737,33 +917,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics: get: tags: @@ -774,16 +989,28 @@ paths: parameters: - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: "Filter by the issue format." required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: "Exclude variants (alternate covers, secondary printings, director's cuts, etc.) from the result set." @@ -796,17 +1023,22 @@ paths: required: false schema: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -825,14 +1057,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -845,7 +1075,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -893,7 +1122,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). @@ -904,7 +1132,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). @@ -915,7 +1142,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -926,7 +1152,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). @@ -937,7 +1162,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). Accepts a comma-separated list of ids. @@ -948,7 +1172,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). Accepts a comma-separated list of ids. @@ -959,7 +1182,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -970,33 +1192,74 @@ paths: type: array items: type: string + enum: + - issueNumber + - modified + - onSaleDate + - focDate + - title + - -issueNumber + - -modified + - -onSaleDate + - -focDate + - -title - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}: get: tags: @@ -1007,24 +1270,53 @@ paths: parameters: - name: comicId in: path - description: A single comic. + description: A comic id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/characters: get: tags: @@ -1035,20 +1327,21 @@ paths: parameters: - name: comicId in: path - description: The comic id. + description: A comic id. required: true schema: type: integer - format: int32 - name: name in: query - description: Return only characters matching the specified full character name (e.g. Spider-Man). + description: Return only characters matching the specified full character name + example: Spider-Man required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string (e.g. Sp). + description: Return characters with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -1069,7 +1362,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). @@ -1080,7 +1372,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). @@ -1091,7 +1382,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1102,33 +1392,68 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/creators: get: tags: @@ -1139,56 +1464,63 @@ paths: parameters: - name: comicId in: path - description: The comic id. + description: A comic id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: "Filter by suffix or honorific" + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: "Filter by creator names that match critera" + example: B required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St L)." + description: "Filter by creator first names that match critera" + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -1209,7 +1541,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). @@ -1220,7 +1551,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). @@ -1231,7 +1561,7 @@ paths: type: array items: type: integer - format: int32 + - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1242,48 +1572,88 @@ paths: type: array items: type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/events: get: tags: - events summary: Fetches lists of events filtered by a comic id. - description: "Fetches lists of events in which a specific comic appears, with optional filters." + description: Fetches lists of events in which a specific comic appears, with optional filters. operationId: getEventsByComicId parameters: - name: comicId in: path - description: The comic ID. + description: A comic id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -1292,7 +1662,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -1313,7 +1684,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only events which feature the specified characters (accepts a comma-separated list of ids). @@ -1324,7 +1694,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only events which are part of the specified series (accepts a comma-separated list of ids). @@ -1335,7 +1704,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only events which contain the specified stories (accepts a comma-separated list of ids). @@ -1346,7 +1714,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1357,48 +1724,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/comics/{comicId}/stories: get: tags: - stories summary: Fetches lists of stories filtered by a comic id. - description: "Fetches lists of comic stories in a specific comic issue, with optional filters." + description: Fetches lists of comic stories in a specific comic issue, with optional filters. operationId: getStoriesByComicId parameters: - name: comicId in: path - description: The comic ID. + description: A comic id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -1416,7 +1819,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). @@ -1427,7 +1829,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). @@ -1438,7 +1839,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). @@ -1449,7 +1849,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1460,33 +1859,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators: get: tags: @@ -1497,49 +1931,57 @@ paths: parameters: - name: firstName in: query - description: Filter by creator first name (e.g. Brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St L)." + description: Filter by creator first names that match criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -1560,7 +2002,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). @@ -1571,7 +2012,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). @@ -1582,7 +2022,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). @@ -1593,7 +2032,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1604,33 +2042,74 @@ paths: type: array items: type: string + enum: + - firstName + - middleName + - lastName + - suffix + - modified + - -firstName + - -middleName + - -lastName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}: get: tags: @@ -1641,51 +2120,91 @@ paths: parameters: - name: creatorId in: path - description: A single creator id. + description: A creator id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/comics: get: tags: - comics summary: Fetches lists of comics filtered by a creator id. - description: "Fetches lists of comics in which the work of a specific creator appears, with optional filters." + description: Fetches lists of comics in which the work of a specific creator appears, with optional filters. operationId: getComicsByCreatorId parameters: - name: creatorId in: path - description: The creator ID. + description: A creator id. required: true schema: type: integer - format: int32 - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -1698,17 +2217,22 @@ paths: required: false schema: type: string + enum: + - thisWeek + - lastWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -1727,14 +2251,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -1747,7 +2269,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -1799,7 +2320,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). @@ -1810,7 +2330,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -1821,7 +2340,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). @@ -1832,7 +2350,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). @@ -1843,7 +2360,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). @@ -1854,7 +2370,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1865,33 +2380,74 @@ paths: type: array items: type: string + enum: + - title + - issueNumber + - modified + - onSaleDate + - focDate + - -title + - -issueNumber + - -modified + - -onSaleDate + - -focDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/events: get: tags: @@ -1902,11 +2458,10 @@ paths: parameters: - name: creatorId in: path - description: The creator ID. + description: A creator id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -1915,7 +2470,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -1936,7 +2492,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only events which are part of the specified series (accepts a comma-separated list of ids). @@ -1947,7 +2502,6 @@ paths: type: array items: type: integer - format: int32 - name: comics in: query description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). @@ -1958,7 +2512,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only events which contain the specified stories (accepts a comma-separated list of ids). @@ -1969,7 +2522,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -1980,48 +2532,84 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/series: get: tags: - series summary: Fetches lists of series filtered by a creator id. - description: "Fetches lists of comic series in which a specific creator's work appears, with optional filters." + description: Fetches lists of comic series in which a specific creator's work appears, with optional filters. operationId: getSeriesByCreatorId parameters: - name: creatorId in: path - description: The creator ID. + description: A creator id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -2030,7 +2618,8 @@ paths: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string (e.g. Sp). + description: Return series with titles that begin with the specified string. + example: Sp required: false schema: type: string @@ -2040,7 +2629,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -2058,7 +2646,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only series which contain the specified stories (accepts a comma-separated list of ids). @@ -2069,7 +2656,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). @@ -2080,7 +2666,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only series which feature the specified characters (accepts a comma-separated list of ids). @@ -2091,13 +2676,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -2108,6 +2697,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2118,33 +2716,70 @@ paths: type: array items: type: string + enum: + - title + - startYear + - modified + - -title + - -startYear + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/creators/{creatorId}/stories: get: tags: @@ -2155,11 +2790,10 @@ paths: parameters: - name: creatorId in: path - description: The ID of the creator. + description: A creator id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -2177,7 +2811,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only stories contained the specified series (accepts a comma-separated list of ids). @@ -2188,7 +2821,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). @@ -2199,7 +2831,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). @@ -2210,7 +2841,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2221,33 +2851,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events: get: tags: @@ -2264,7 +2929,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -2285,7 +2951,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only events which feature the specified characters (accepts a comma-separated list of ids). @@ -2296,7 +2961,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only events which are part of the specified series (accepts a comma-separated list of ids). @@ -2307,7 +2971,6 @@ paths: type: array items: type: integer - format: int32 - name: comics in: query description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). @@ -2318,7 +2981,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only events which take place in the specified stories (accepts a comma-separated list of ids). @@ -2329,7 +2991,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2340,33 +3001,70 @@ paths: type: array items: type: string + enum: + - name + - modified + - startDate + - -name + - -modified + - -startDate - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}: get: tags: @@ -2377,48 +3075,78 @@ paths: parameters: - name: eventId in: path - description: A single event. + description: An event id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": description: Not found response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/characters: get: tags: - characters summary: Fetches lists of characters filtered by an event id. - description: "Fetches lists of characters which appear in a specific event, with optional filters." + description: Fetches lists of characters which appear in a specific event, with optional filters. operationId: getCharactersByEventId parameters: - name: eventId in: path - description: The event ID + description: An event id. required: true schema: type: integer - format: int32 - name: name in: query - description: Return only characters matching the specified full character name (e.g. Spider-Man). + description: Return only characters matching the specified full character name. + example: Spider-Man. required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string (e.g. Sp). + description: Return characters with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -2439,7 +3167,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only characters which appear the specified series (accepts a comma-separated list of ids). @@ -2450,7 +3177,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). @@ -2461,7 +3187,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2472,60 +3197,106 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/comics: get: tags: - comics summary: Fetches lists of comics filtered by an event id. - description: "Fetches lists of comics which take place during a specific event, with optional filters." + description: Fetches lists of comics which take place during a specific event, with optional filters. operationId: getComicsByEventId parameters: - name: eventId in: path - description: The event id. + description: An event id. required: true schema: type: integer - format: int32 - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -2546,17 +3317,22 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -2575,14 +3351,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -2595,7 +3369,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -2647,7 +3420,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). @@ -2658,7 +3430,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). @@ -2669,7 +3440,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -2680,7 +3450,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). @@ -2691,7 +3460,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). @@ -2702,7 +3470,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). @@ -2713,7 +3480,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2724,93 +3490,140 @@ paths: type: array items: type: string + enum: + - focDate + - onSaleDate + - title + - issueNumber + - modified + - -focDate + - -onSaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/creators: get: tags: - creators summary: Fetches lists of creators filtered by an event id. - description: "Fetches lists of comic creators whose work appears in a specific event, with optional filters." + description: Fetches lists of comic creators whose work appears in a specific event, with optional filters. operationId: getCreatorsByEventId parameters: - name: eventId in: path - description: The event ID. + description: An event id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St L)." + description: Filter by creator first names that match criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. required: false schema: type: string @@ -2831,7 +3644,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). @@ -2842,7 +3654,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). @@ -2853,7 +3664,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -2864,33 +3674,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/series: get: tags: @@ -2901,11 +3752,10 @@ paths: parameters: - name: eventId in: path - description: The event ID. + description: An event id. required: true schema: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -2914,7 +3764,8 @@ paths: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string (e.g. Sp). + description: Return series with titles that begin with the specified string. + example: Sp required: false schema: type: string @@ -2924,7 +3775,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -2942,7 +3792,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only series which contain the specified stories (accepts a comma-separated list of ids). @@ -2953,7 +3802,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). @@ -2964,7 +3812,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only series which feature the specified characters (accepts a comma-separated list of ids). @@ -2975,13 +3822,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -2992,6 +3843,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3002,48 +3862,84 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/events/{eventId}/stories: get: tags: - stories summary: Fetches lists of stories filtered by an event id. - description: "Fetches lists of comic stories from a specific event, with optional filters." + description: Fetches lists of comic stories from a specific event, with optional filters. operationId: getStoriesByEventId parameters: - name: eventId in: path - description: The ID of the event. + description: An event id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -3061,7 +3957,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only stories contained the specified series (accepts a comma-separated list of ids). @@ -3072,7 +3967,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). @@ -3083,7 +3977,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). @@ -3094,7 +3987,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3105,33 +3997,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series: get: tags: @@ -3148,7 +4075,8 @@ paths: type: string - name: titleStartsWith in: query - description: Return series with titles that begin with the specified string (e.g. Sp). + description: Return series with titles that begin with the specified string. + example: Sp required: false schema: type: string @@ -3158,7 +4086,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -3176,7 +4103,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only series which contain the specified stories (accepts a comma-separated list of ids). @@ -3187,7 +4113,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). @@ -3198,7 +4123,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). @@ -3209,7 +4133,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only series which feature the specified characters (accepts a comma-separated list of ids). @@ -3220,13 +4143,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -3237,6 +4164,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3247,33 +4183,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}: get: tags: @@ -3284,20 +4257,49 @@ paths: parameters: - name: seriesId in: path - description: Filter by series title. + description: A series id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": - description: Not found response + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response content: application/json: schema: @@ -3307,25 +4309,26 @@ paths: tags: - characters summary: Fetches lists of characters filtered by a series id. - description: "Fetches lists of characters which appear in specific series, with optional filters." + description: Fetches lists of characters which appear in specific series, with optional filters. operationId: getCharactersBySeriesId parameters: - name: seriesId in: path - description: The series id. + description: A series id. required: true schema: type: integer - format: int32 - name: name in: query - description: Return only characters matching the specified full character name (e.g. Spider-Man). + description: Return only characters matching the specified full character name. + example: Spider-Man required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string (e.g. Sp). + description: Return characters with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -3346,7 +4349,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). @@ -3357,7 +4359,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only characters which appear the specified stories (accepts a comma-separated list of ids). @@ -3368,7 +4369,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3379,33 +4379,68 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/comics: get: tags: @@ -3416,23 +4451,34 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -3453,17 +4499,22 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false schema: type: array items: - type: integer - format: int32 + type: string - name: title in: query description: Return only issues in series whose title matches the input. @@ -3482,14 +4533,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -3502,7 +4551,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -3554,7 +4602,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). @@ -3565,7 +4612,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -3576,7 +4622,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only comics which contain the specified stories (accepts a comma-separated list of ids). @@ -3587,7 +4632,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). @@ -3598,7 +4642,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). @@ -3609,7 +4652,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3620,93 +4662,141 @@ paths: type: array items: type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/creators: get: tags: - creators summary: Fetches lists of creators filtered by a series id. - description: "Fetches lists of comic creators whose work appears in a specific series, with optional filters." + description: Fetches lists of comic creators whose work appears in a specific series, with optional filters. operationId: getCreatorsBySeriesId parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St L)." + description: Filter by creator first names that match criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -3727,7 +4817,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). @@ -3738,7 +4827,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only creators who worked on the specified stories (accepts a comma-separated list of ids). @@ -3749,7 +4837,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3760,33 +4847,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/series/{seriesId}/events: get: tags: @@ -3797,11 +4925,10 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -3810,7 +4937,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -3831,7 +4959,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only events which feature the specified characters (accepts a comma-separated list of ids). @@ -3842,7 +4969,6 @@ paths: type: array items: type: integer - format: int32 - name: comics in: query description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). @@ -3853,7 +4979,6 @@ paths: type: array items: type: integer - format: int32 - name: stories in: query description: Return only events which contain the specified stories (accepts a comma-separated list of ids). @@ -3864,7 +4989,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3875,23 +4999,30 @@ paths: type: array items: type: string + enum: + - name + - startDate + - modified + - -name + - -startDate + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: @@ -3912,11 +5043,10 @@ paths: parameters: - name: seriesId in: path - description: The series ID. + description: A series id. required: true schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only stories which have been modified since the specified date. @@ -3934,7 +5064,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). @@ -3945,7 +5074,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). @@ -3956,7 +5084,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). @@ -3967,7 +5094,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -3978,33 +5104,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories: get: tags: @@ -4030,7 +5191,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only stories contained the specified series (accepts a comma-separated list of ids). @@ -4041,7 +5201,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only stories which take place during the specified events (accepts a comma-separated list of ids). @@ -4052,7 +5211,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only stories which feature work by the specified creators (accepts a comma-separated list of ids). @@ -4063,7 +5221,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only stories which feature the specified characters (accepts a comma-separated list of ids). @@ -4074,7 +5231,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4085,33 +5241,68 @@ paths: type: array items: type: string + enum: + - id + - modified + - -id + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}: get: tags: @@ -4122,20 +5313,49 @@ paths: parameters: - name: storyId in: path - description: Filter by story id. + description: A story id. required: true schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/StoryDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "404": - description: Not found response + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "409": + description: Conflict response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response content: application/json: schema: @@ -4150,20 +5370,21 @@ paths: parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: name in: query - description: Return only characters matching the specified full character name (e.g. Spider-Man). + description: Return only characters matching the specified full character name. + example: Spider-Man required: false schema: type: string - name: nameStartsWith in: query - description: Return characters with names that begin with the specified string (e.g. Sp). + description: Return characters with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -4184,7 +5405,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only characters which appear the specified series (accepts a comma-separated list of ids). @@ -4195,7 +5415,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids). @@ -4206,7 +5425,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4217,60 +5435,106 @@ paths: type: array items: type: string + enum: + - name + - modified + - -name + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CharacterDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/comics: get: tags: - comics summary: Fetches lists of comics filtered by a story id. - description: "Fetches lists of comics in which a specific story appears, with optional filters." + description: Fetches lists of comics in which a specific story appears, with optional filters. operationId: getComicsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: format in: query - description: "Filter by the issue format (e.g. comic, digital comic, hardcover)." + description: Filter by the issue format. required: false schema: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: formatType in: query - description: Filter by the issue format type (comic or collection). + description: Filter by the issue format type. required: false schema: type: string + enum: + - comic + - collection - name: noVariants in: query description: Exclude variant comics from the result set. @@ -4291,9 +5555,15 @@ paths: type: array items: type: string + enum: + - lastWeek + - thisWeek + - nextWeek + - thisMonth - name: dateRange in: query - description: "Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format." + description: Return comics within a predefined date range. Dates must be specified as date1,date2. Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format. + example: 2013-01-01,2013-01-02 required: false style: form explode: false @@ -4301,7 +5571,6 @@ paths: type: array items: type: integer - format: int32 - name: title in: query description: Return only issues in series whose title matches the input. @@ -4320,14 +5589,12 @@ paths: required: false schema: type: integer - format: int32 - name: issueNumber in: query description: Return only issues in series whose issue number matches the input. required: false schema: type: integer - format: int32 - name: diamondCode in: query description: Filter by diamond code. @@ -4340,7 +5607,6 @@ paths: required: false schema: type: integer - format: int32 - name: upc in: query description: Filter by UPC. @@ -4392,7 +5658,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only comics which feature the specified characters (accepts a comma-separated list of ids). @@ -4403,7 +5668,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only comics which are part of the specified series (accepts a comma-separated list of ids). @@ -4414,7 +5678,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only comics which take place in the specified events (accepts a comma-separated list of ids). @@ -4425,7 +5688,6 @@ paths: type: array items: type: integer - format: int32 - name: sharedAppearances in: query description: Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). @@ -4436,7 +5698,6 @@ paths: type: array items: type: integer - format: int32 - name: collaborators in: query description: Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). @@ -4447,7 +5708,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4458,93 +5718,141 @@ paths: type: array items: type: string + enum: + - focDate + - onsaleDate + - title + - issueNumber + - modified + - -focDate + - -onsaleDate + - -title + - -issueNumber + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/ComicDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/creators: get: tags: - creators summary: Fetches lists of creators filtered by a story id. - description: "Fetches lists of comic creators whose work appears in a specific story, with optional filters." + description: Fetches lists of comic creators whose work appears in a specific story, with optional filters. operationId: getCreatorsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: firstName in: query - description: Filter by creator first name (e.g. brian). + description: Filter by creator first name. + example: Brian required: false schema: type: string - name: middleName in: query - description: Filter by creator middle name (e.g. Michael). + description: Filter by creator middle name. + example: Michael required: false schema: type: string - name: lastName in: query - description: Filter by creator last name (e.g. Bendis). + description: Filter by creator last name. + example: Bendis required: false schema: type: string - name: suffix in: query - description: "Filter by suffix or honorific (e.g. Jr., Sr.)." + description: Filter by suffix or honorific. + example: Sr. required: false schema: type: string - name: nameStartsWith in: query - description: "Filter by creator names that match critera (e.g. B, St L)." + description: Filter by creator names that match criteria. + example: B required: false schema: type: string - name: firstNameStartsWith in: query - description: "Filter by creator first names that match critera (e.g. B, St L)." + description: Filter by creator first names that match criteria. + example: B required: false schema: type: string - name: middleNameStartsWith in: query - description: Filter by creator middle names that match critera (e.g. Mi). + description: Filter by creator middle names that match criteria. + example: Mi required: false schema: type: string - name: lastNameStartsWith in: query - description: Filter by creator last names that match critera (e.g. Ben). + description: Filter by creator last names that match criteria. + example: Ben required: false schema: type: string @@ -4565,7 +5873,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only creators who worked on the specified series (accepts a comma-separated list of ids). @@ -4576,7 +5883,6 @@ paths: type: array items: type: integer - format: int32 - name: events in: query description: Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids). @@ -4587,7 +5893,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4598,48 +5903,88 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/CreatorDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/events: get: tags: - events summary: Fetches lists of events filtered by a story id. - description: "Fetches lists of events in which a specific story appears, with optional filters." + description: Fetches lists of events in which a specific story appears, with optional filters. operationId: getEventsByStoryId parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: name in: query description: Filter the event list by name. @@ -4648,7 +5993,8 @@ paths: type: string - name: nameStartsWith in: query - description: Return events with names that begin with the specified string (e.g. Sp). + description: Return events with names that begin with the specified string. + example: Sp required: false schema: type: string @@ -4669,7 +6015,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only events which feature the specified characters (accepts a comma-separated list of ids). @@ -4680,7 +6025,6 @@ paths: type: array items: type: integer - format: int32 - name: series in: query description: Return only events which are part of the specified series (accepts a comma-separated list of ids). @@ -4691,7 +6035,6 @@ paths: type: array items: type: integer - format: int32 - name: comics in: query description: Return only events which take place in the specified comics (accepts a comma-separated list of ids). @@ -4702,7 +6045,6 @@ paths: type: array items: type: integer - format: int32 - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4713,33 +6055,74 @@ paths: type: array items: type: string + enum: + - lastName + - firstName + - middleName + - suffix + - modified + - -lastName + - -firstName + - -middleName + - -suffix + - -modified - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/EventDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' /v1/public/stories/{storyId}/series: get: tags: @@ -4750,11 +6133,10 @@ paths: parameters: - name: storyId in: path - description: The story ID. + description: A story id. required: true schema: type: integer - format: int32 - name: events in: query description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids). @@ -4765,7 +6147,6 @@ paths: type: array items: type: integer - format: int32 - name: title in: query description: Filter by series title. @@ -4784,7 +6165,6 @@ paths: required: false schema: type: integer - format: int32 - name: modifiedSince in: query description: Return only series which have been modified since the specified date. @@ -4802,7 +6182,6 @@ paths: type: array items: type: integer - format: int32 - name: creators in: query description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids). @@ -4813,7 +6192,6 @@ paths: type: array items: type: integer - format: int32 - name: characters in: query description: Return only series which feature the specified characters (accepts a comma-separated list of ids). @@ -4824,13 +6202,17 @@ paths: type: array items: type: integer - format: int32 - name: seriesType in: query description: Filter the series by publication frequency type. required: false schema: type: string + enum: + - collection + - one shot + - limited + - ongoing - name: contains in: query description: Return only series containing one or more comics with the specified format. @@ -4841,6 +6223,15 @@ paths: type: array items: type: string + enum: + - comic + - magazine + - trade paperback + - hardcover + - digest + - graphic novel + - digital comic + - infinite comic - name: orderBy in: query description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. @@ -4851,33 +6242,70 @@ paths: type: array items: type: string + enum: + - title + - modified + - startYear + - -title + - -modified + - -startYear - name: limit in: query description: Limit the result set to the specified number of resources. required: false schema: type: integer - format: int32 + minimum: 1 + maximum: 100 - name: offset in: query description: Skip the specified number of resources in the result set. required: false schema: type: integer - format: int32 responses: "200": - description: No response was specified + description: OK response content: application/json: schema: $ref: '#/components/schemas/SeriesDataWrapper' + "401": + description: Unauthorized response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "403": + description: Forbidden response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "404": + description: Not Found response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' + "405": + description: Method Not Allowed response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' "409": description: Conflict response content: application/json: schema: $ref: '#/components/schemas/StandardError' + "429": + description: Too Many Requests response + content: + application/json: + schema: + $ref: '#/components/schemas/StandardError' components: schemas: # Core Entity Representations @@ -4888,7 +6316,7 @@ components: id: type: integer description: The unique ID of the character resource. - format: int32 + name: type: string description: The name of the character. @@ -4941,11 +6369,11 @@ components: id: type: integer description: The unique ID of the comic resource. - format: int32 + digitalId: type: integer description: The ID of the digital comic representation of this comic. Will be 0 if the comic is not available digitally. - format: int32 + title: type: string description: The canonical title of the comic. @@ -4984,7 +6412,7 @@ components: pageCount: type: integer description: The number of story pages in the comic. - format: int32 + textObjects: type: array description: A set of descriptive text blurbs for the comic. @@ -5083,7 +6511,6 @@ components: id: type: integer description: The unique ID of the creator resource. - format: int32 firstName: type: string description: The first name of the creator. @@ -5148,7 +6575,6 @@ components: id: type: integer description: The unique ID of the event resource. - format: int32 title: type: string description: The title of the event. @@ -5223,7 +6649,6 @@ components: id: type: integer description: The unique ID of the series resource. - format: int32 title: type: string description: The canonical title of the series. @@ -5241,11 +6666,9 @@ components: startYear: type: integer description: The first year of publication for the series. - format: int32 endYear: type: integer - description: "The last year of publication for the series (conventionally, 2099 for ongoing series)." - format: int32 + description: The last year of publication for the series (conventionally, 2099 for ongoing series). rating: type: string description: The age-appropriateness rating for the series. @@ -5302,7 +6725,6 @@ components: id: type: integer description: The unique ID of the story resource. - format: int32 title: type: string description: The story title. @@ -5455,11 +6877,10 @@ components: available: type: integer description: The number of total available characters in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of characters returned in this collection (up to 20). - format: int32 + description: The number of characters returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of characters in this collection. @@ -5480,11 +6901,10 @@ components: available: type: integer description: The number of total available issues in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of issues returned in this collection (up to 20). - format: int32 + description: The number of issues returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of issues in this collection. @@ -5505,11 +6925,10 @@ components: available: type: integer description: The number of total available creators in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of creators returned in this collection (up to 20). - format: int32 + description: The number of creators returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of creators in this collection. @@ -5530,11 +6949,10 @@ components: available: type: integer description: The number of total available events in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of events returned in this collection (up to 20). - format: int32 + description: The number of events returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of events in this collection. @@ -5555,11 +6973,10 @@ components: available: type: integer description: The number of total available series in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of series returned in this collection (up to 20). - format: int32 + description: The number of series returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of series in this collection. @@ -5580,11 +6997,10 @@ components: available: type: integer description: The number of total available stories in this list. Will always be greater than or equal to the "returned" value. - format: int32 returned: type: integer - description: The number of stories returned in this collection (up to 20). - format: int32 + description: The number of stories returned in this collection. + maximum: 20 collectionURI: type: string description: The path to the full list of stories in this collection. @@ -5607,20 +7023,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer - description: The total number of resources available given the current filter - set. - format: int32 + description: The total number of resources available given the current filter set. count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of characters returned by the call. @@ -5639,20 +7050,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer - description: The total number of resources available given the current filter - set. - format: int32 + description: The total number of resources available given the current filter set. count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of comics returned by the call @@ -5671,19 +7077,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer description: The total number of resources available given the current filter set. - format: int32 count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of creators returned by the call. @@ -5702,20 +7104,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer - description: The total number of resources available given the current filter - set. - format: int32 + description: The total number of resources available given the current filter set. count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of events returned by the call @@ -5734,20 +7131,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer - description: The total number of resources available given the current filter - set. - format: int32 + description: The total number of resources available given the current filter set. count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of series returned by the call @@ -5766,20 +7158,15 @@ components: offset: type: integer description: The requested offset (number of skipped results) of the call. - format: int32 limit: type: integer description: The requested result limit. - format: int32 total: type: integer - description: The total number of resources available given the current filter - set. - format: int32 + description: The total number of resources available given the current filter set. count: type: integer description: The total number of results returned by this call. - format: int32 results: type: array description: The list of stories returned by the call @@ -5800,7 +7187,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5833,7 +7219,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5866,7 +7251,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5899,7 +7283,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5932,7 +7315,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5965,7 +7347,6 @@ components: code: type: integer description: The HTTP status code of the returned result. - format: int32 status: type: string description: A string description of the call status. @@ -5999,7 +7380,7 @@ components: properties: type: type: string - description: "A description of the date (e.g. onsale date, FOC date)." + description: A description of the date (e.g. onsale date, FOC date). date: type: string description: The date. @@ -6013,7 +7394,7 @@ components: properties: type: type: string - description: "A description of the price (e.g. print price, digital price)." + description: A description of the price (e.g. print price, digital price). price: type: number description: The price (all prices in USD). @@ -6040,7 +7421,7 @@ components: properties: type: type: string - description: "The canonical type of the text object (e.g. solicit text, preview text, etc.)." + description: The canonical type of the text object (e.g. solicit text, preview text, etc.). language: type: string description: The IETF language tag (or language code) denoting which language the text object is written in. @@ -6060,7 +7441,7 @@ components: description: A text identifier for the URL. url: type: string - description: "A full URL (including scheme, domain, and path)." + description: A full URL (including scheme, domain, and path). required: - type - url @@ -6073,6 +7454,9 @@ components: code: type: string description: The HTTP status code of the returned result. + message: + type: string + description: A human readable message providing more details about the error. required: - code - \ No newline at end of file +