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