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