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
9.0 KiB
JSON
1 line
9.0 KiB
JSON
{"sections":[],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"overview","text":"Overview"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/v1\/public\/series\/{seriesId}\/stories\/GET\/header","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input"]]},"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/init(accept:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/accept"],"title":"Instance Properties"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/Equatable-Implementations"],"title":"Default Implementations"}],"metadata":{"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO5InputV7HeadersV","roleHeading":"Structure","title":"Operations.getStoriesBySeriesId.Input.Headers","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input\/headers-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input\/headers-swift.struct","title":"Operations.getStoriesBySeriesId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"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/getStoriesBySeriesId/Input/Headers-swift.struct/accept":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/accept","title":"accept","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accept","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO","text":"getStoriesBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO21AcceptableContentTypeO","text":"AcceptableContentType","kind":"typeIdentifier"},{"text":">]","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input\/headers-swift.struct\/accept","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid","title":"Operations.getStoriesBySeriesId","navigatorTitle":[{"text":"getStoriesBySeriesId","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of stories filtered by a series id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesBySeriesId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Input/Headers-swift.struct/init(accept:)":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input\/headers-swift.struct\/init(accept:)","title":"init(accept:)","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Headers"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/init(accept:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO","text":"getStoriesBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO21AcceptableContentTypeO","text":"AcceptableContentType","kind":"typeIdentifier"},{"text":">])","kind":"text"}]},"doc://MarvelService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Input/Headers-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input\/headers-swift.struct\/equatable-implementations","kind":"article","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input\/Headers-swift.struct\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getStoriesBySeriesId.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input","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"}}} |