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