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