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
6.6 KiB
JSON
1 line
6.6 KiB
JSON
{"sections":[],"abstract":[{"type":"text","text":"Fetches lists of stories filtered by a creator id."}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoriesByCreatorId"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comic stories by a specific creator with optional filters.","type":"text"}]},{"name":"Remark","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/creators\/{creatorId}\/stories"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Remark","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/creators\/{creatorId}\/stories\/get(getStoriesByCreatorId)"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"]]},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/Input"],"generated":true,"title":"Structures","anchor":"Structures"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/id"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/AcceptableContentType","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/Output"],"generated":true,"title":"Enumerations","anchor":"Enumerations"}],"metadata":{"symbolKind":"enum","role":"symbol","navigatorTitle":[{"text":"getStoriesByCreatorId","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO21getStoriesByCreatorIdO","roleHeading":"Enumeration","title":"Operations.getStoriesByCreatorId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getStoriesByCreatorId"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getstoriesbycreatorid"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCreatorId/id":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/id","title":"id","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getstoriesbycreatorid\/id"},"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":{"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/getStoriesByCreatorId/Output":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbycreatorid\/output","title":"Operations.getStoriesByCreatorId.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCreatorId":{"abstract":[{"type":"text","text":"Fetches lists of stories filtered by a creator id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId","navigatorTitle":[{"text":"getStoriesByCreatorId","kind":"identifier"}],"title":"Operations.getStoriesByCreatorId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByCreatorId","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getstoriesbycreatorid"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCreatorId/Input":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbycreatorid\/input","title":"Operations.getStoriesByCreatorId.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCreatorId/AcceptableContentType":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCreatorId\/AcceptableContentType","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"title":"Operations.getStoriesByCreatorId.AcceptableContentType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getstoriesbycreatorid\/acceptablecontenttype"}}} |