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.9 KiB
JSON
1 line
5.9 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct\/sharedAppearances","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"sharedAppearances","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sharedAppearances","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"role":"symbol","externalID":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV5QueryV17sharedAppearancesSaySiGSgvp","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sharedAppearances","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/v1\/public\/series\/{seriesId}\/comics\/GET\/query\/sharedAppearances","type":"codeVoice"},{"text":".","type":"text"}]}]}]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/query-swift.struct\/sharedappearances"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear)."}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/query-swift.struct","title":"Operations.getComicsBySeriesId.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"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":{"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"},"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/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input","title":"Operations.getComicsBySeriesId.Input","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Input/Query-swift.struct/sharedAppearances":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct\/sharedAppearances","title":"sharedAppearances","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sharedAppearances","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/query-swift.struct\/sharedappearances","role":"symbol","abstract":[{"type":"text","text":"Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear)."}]}}} |