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
5.8 KiB
JSON
1 line
5.8 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/comics"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"title":"comics","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"comics"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"]?"}],"externalID":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV6comicsSaySiGSgvp","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"comics","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/events\/{eventId}\/characters\/GET\/query\/comics"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/comics"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids).","type":"text"}],"references":{"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"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/comics":{"title":"comics","abstract":[{"type":"text","text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids)."}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/comics","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/comics","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"comics"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"]?"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct","title":"Operations.getCharactersByEventId.Input.Query","navigatorTitle":[{"kind":"identifier","text":"Query"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"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/getCharactersByEventId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input","title":"Operations.getCharactersByEventId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]}}} |