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