Documentation update (#17)
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #17.
This commit is contained in:
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+1
-1
@@ -1 +1 @@
|
||||
{"topicSections":[{"title":"Operators","anchor":"Operators","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/!=(_:_:)"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/createlisting\/input\/equatable-implementations"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"Equatable Implementations","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing":{"url":"\/documentation\/discogsservice\/operations\/createlisting","title":"Operations.CreateListing","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreateListing"}],"navigatorTitle":[{"kind":"identifier","text":"CreateListing"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","abstract":[{"text":"Create a new listing in a marketplace.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input":{"url":"\/documentation\/discogsservice\/operations\/createlisting\/input","title":"Operations.CreateListing.Input","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/!=(_:_:)":{"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"!=(_:_:)","url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/!=(_:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/!=(_:_:)","abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","url":"\/documentation\/discogsservice\/operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol"}}}
|
||||
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Equatable-Implementations"},"kind":"article","topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/!=(_:_:)"],"generated":true,"anchor":"Operators","title":"Operators"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input"]]},"sections":[],"metadata":{"modules":[{"name":"DiscogsService"}],"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/createlisting\/input\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/!=(_:_:)":{"title":"!=(_:_:)","type":"topic","url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/!=(_:_:)","kind":"symbol","abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreateListing"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","type":"topic","role":"symbol","kind":"symbol","title":"Operations.CreateListing","abstract":[{"type":"text","text":"Create a new listing in a marketplace."}],"navigatorTitle":[{"kind":"identifier","text":"CreateListing"}],"url":"\/documentation\/discogsservice\/operations\/createlisting"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.CreateListing.Input","url":"\/documentation\/discogsservice\/operations\/createlisting\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input"}}}
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -1 +1 @@
|
||||
{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"article","topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/!=(_:_:)"],"anchor":"Operators","title":"Operators"}],"metadata":{"title":"Equatable Implementations","modules":[{"name":"DiscogsService"}],"roleHeading":"API Collection","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct\/equatable-implementations"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/Equatable-Implementations","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/Headers-swift.struct/!=(_:_:)":{"abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct\/!=(_:_:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/!=(_:_:)","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing":{"url":"\/documentation\/discogsservice\/operations\/createlisting","title":"Operations.CreateListing","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreateListing"}],"navigatorTitle":[{"kind":"identifier","text":"CreateListing"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","abstract":[{"text":"Create a new listing in a marketplace.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input":{"url":"\/documentation\/discogsservice\/operations\/createlisting\/input","title":"Operations.CreateListing.Input","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/Headers-swift.struct":{"abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct","title":"Operations.CreateListing.Input.Headers","url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","url":"\/documentation\/discogsservice\/operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"}}}
|
||||
{"variants":[{"paths":["\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct"]]},"kind":"article","metadata":{"modules":[{"name":"DiscogsService"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Equatable Implementations"},"sections":[],"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/!=(_:_:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/Equatable-Implementations","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/Headers-swift.struct/!=(_:_:)":{"url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct\/!=(_:_:)","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct\/!=(_:_:)","type":"topic","title":"!=(_:_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.CreateListing.Input.Headers","url":"\/documentation\/discogsservice\/operations\/createlisting\/input\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input\/Headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreateListing"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing","type":"topic","role":"symbol","kind":"symbol","title":"Operations.CreateListing","abstract":[{"type":"text","text":"Create a new listing in a marketplace."}],"navigatorTitle":[{"kind":"identifier","text":"CreateListing"}],"url":"\/documentation\/discogsservice\/operations\/createlisting"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/CreateListing/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.CreateListing.Input","url":"\/documentation\/discogsservice\/operations\/createlisting\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/CreateListing\/Input"}}}
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user