d5bd9feb0a
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>
1 line
7.9 KiB
JSON
1 line
7.9 KiB
JSON
{"sections":[],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output\/conflict-swift.property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"conflict","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","text":"getSeriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO8ConflictV","text":"Conflict","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output\/Conflict-swift.struct","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["macOS"]}]},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Throws","style":"note","content":[{"inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","name":"See Also","style":"note","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getseriesbyeventid\/output\/conflict-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"conflict","externalID":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO8conflictAG8ConflictVvp","role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"conflict","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","text":"getSeriesByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO8ConflictV","text":"Conflict","kind":"typeIdentifier"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Output/conflict-swift.property":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"conflict"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","kind":"typeIdentifier","text":"getSeriesByEventId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO8ConflictV","kind":"typeIdentifier","text":"Conflict"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output\/conflict-swift.property","kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/output\/conflict-swift.property","title":"conflict","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".conflict","type":"codeVoice"},{"type":"text","text":"."}],"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/getSeriesByEventId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getSeriesByEventId.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/output","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId":{"abstract":[{"type":"text","text":"Fetches lists of series filtered by an event id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","navigatorTitle":[{"kind":"identifier","text":"getSeriesByEventId"}],"title":"Operations.getSeriesByEventId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByEventId"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid","type":"topic"},"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/getSeriesByEventId/Output/Conflict-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/output\/conflict-swift.struct","title":"Operations.getSeriesByEventId.Output.Conflict","navigatorTitle":[{"kind":"identifier","text":"Conflict"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output\/Conflict-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Conflict"}]}}} |