rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/operations/geteventsbyseriesid/output.json
T
javier d5bd9feb0a First version of the library documentation (#7) 
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it.

Reviewed-on: #7
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-05 18:41:22 +00:00

1 line
13 KiB
JSON
Raw Blame History

{"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"platforms":["macOS"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"title":"Structures","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Conflict-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Ok-swift.struct"],"generated":true,"anchor":"Structures"},{"title":"Enumeration Cases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/conflict(_:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/ok(_:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/undocumented(statusCode:_:)"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/conflict-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/ok-swift.property"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output"},"kind":"symbol","metadata":{"title":"Operations.getEventsBySeriesId.Output","externalID":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","navigatorTitle":[{"kind":"identifier","text":"Output"}],"role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Enumeration","symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"references":{"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Equatable-Implementations","kind":"article"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/ok(_:)":{"abstract":[{"type":"text","text":"OK response"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/ok(_:)","title":"Operations.getEventsBySeriesId.Output.ok(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/ok(_:)"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/Conflict-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Conflict-swift.struct","navigatorTitle":[{"text":"Conflict","kind":"identifier"}],"title":"Operations.getEventsBySeriesId.Output.Conflict","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Conflict","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/conflict-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsBySeriesId","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId","kind":"symbol","navigatorTitle":[{"text":"getEventsBySeriesId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid","title":"Operations.getEventsBySeriesId","role":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/undocumented(statusCode:_:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/undocumented(statusCode:_:)","title":"Operations.getEventsBySeriesId.Output.undocumented(statusCode:_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","text":"UndocumentedPayload","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/undocumented(statuscode:_:)","role":"symbol","abstract":[{"text":"Undocumented response.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/Ok-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/Ok-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/ok-swift.struct","title":"Operations.getEventsBySeriesId.Output.Ok","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output","kind":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output","title":"Operations.getEventsBySeriesId.Output","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/conflict-swift.property":{"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/conflict-swift.property","title":"conflict","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".conflict","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/conflict-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"conflict"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Conflict","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO8ConflictV"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/ok-swift.property":{"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/ok-swift.property","title":"ok","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/ok-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO2OkV"}]},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output/conflict(_:)":{"abstract":[{"text":"Conflict response","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output\/conflict(_:)","title":"Operations.getEventsBySeriesId.Output.conflict(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"conflict","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO8ConflictV","text":"Conflict","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output\/conflict(_:)"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"}}}
View Git Blame Copy Permalink