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
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output\/tooManyRequests(_:)","interfaceLanguage":"swift"},"metadata":{"title":"Operations.getEventsByCharacterId.Output.tooManyRequests(_:)","externalID":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO15tooManyRequestsyA2G03TookL0VcAGmF","role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"case","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tooManyRequests","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByCharacterId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO"},{"text":".","kind":"text"},{"text":"TooManyRequests","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO15TooManyRequestsV"},{"text":")","kind":"text"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"case","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"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","text":"getEventsByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output\/TooManyRequests-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO15TooManyRequestsV","text":"TooManyRequests","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/v1\/public\/characters\/{characterId}\/events\/get(getEventsByCharacterId)\/responses\/429","type":"codeVoice"},{"text":".","type":"text"}]}]},{"inlineContent":[{"text":"HTTP response code: ","type":"text"},{"type":"codeVoice","code":"429 tooManyRequests"},{"text":".","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/output\/toomanyrequests(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Too Many Requests response","type":"text"}],"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/getEventsByCharacterId":{"abstract":[{"text":"Fetches lists of events filtered by a character id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","navigatorTitle":[{"kind":"identifier","text":"getEventsByCharacterId"}],"title":"Operations.getEventsByCharacterId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsByCharacterId"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid"},"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/getEventsByCharacterId/Output/tooManyRequests(_:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output\/tooManyRequests(_:)","title":"Operations.getEventsByCharacterId.Output.tooManyRequests(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"tooManyRequests"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier","text":"getEventsByCharacterId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO15TooManyRequestsV","kind":"typeIdentifier","text":"TooManyRequests"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/output\/toomanyrequests(_:)","role":"symbol","abstract":[{"text":"Too Many Requests response","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getEventsByCharacterId.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/output"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Output/TooManyRequests-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output\/TooManyRequests-swift.struct","navigatorTitle":[{"text":"TooManyRequests","kind":"identifier"}],"title":"Operations.getEventsByCharacterId.Output.TooManyRequests","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TooManyRequests"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/output\/toomanyrequests-swift.struct"}}} |