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