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