eaee2b84f0
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>
1 line
13 KiB
JSON
1 line
13 KiB
JSON
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload","interfaceLanguage":"swift"},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"A type that represents the statistics associated with a seller."}],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatsPayload"}],"role":"symbol","title":"Components.Schemas.Seller.Value2Payload.StatsPayload","navigatorTitle":[{"kind":"identifier","text":"StatsPayload"}],"symbolKind":"struct","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO6SellerV13Value2PayloadV05StatsG0V","roleHeading":"Structure"},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/init(rating:stars:total:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/rating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/stars","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/total"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/CodingKeys"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/Equatable-Implementations"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatsPayload","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/Seller\/value2\/stats","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside","name":"Remark"}]}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/stars":{"url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/stars","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/stars","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stars"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sf","kind":"typeIdentifier","text":"Float"}],"abstract":[{"type":"text","text":"An average number of stars given to a seller."}],"kind":"symbol","type":"topic","title":"stars"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/Equatable-Implementations":{"role":"collectionGroup","url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/equatable-implementations","kind":"article","title":"Equatable Implementations","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/init(rating:stars:total:)":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/init(rating:stars:total:)","kind":"symbol","title":"init(rating:stars:total:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"StatsPayload","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"stars"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sf","text":"Float"},{"kind":"text","text":", "},{"kind":"externalParam","text":"total"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/init(rating:stars:total:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/rating":{"url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/rating","abstract":[{"text":"A total percentage number of the ratings given to a seller.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/rating","kind":"symbol","type":"topic","title":"rating"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/init(from:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/init(from:)","type":"topic","role":"symbol","title":"init(from:)","kind":"symbol","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/init(from:)"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/total":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/total","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"total","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"abstract":[{"text":"A total number of rating reviews given to a seller.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/total","title":"total"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatsPayload","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload","type":"topic","role":"symbol","title":"Components.Schemas.Seller.Value2Payload.StatsPayload","abstract":[{"text":"A type that represents the statistics associated with a seller.","type":"text"}],"kind":"symbol","navigatorTitle":[{"text":"StatsPayload","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/seller","kind":"symbol","title":"Components.Schemas.Seller","abstract":[{"text":"A type that represents a user that sells inventory in a marketplace.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Seller"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller","navigatorTitle":[{"kind":"identifier","text":"Seller"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Value2Payload","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload","title":"Components.Schemas.Seller.Value2Payload","type":"topic","abstract":[],"navigatorTitle":[{"text":"Value2Payload","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload"},"doc://DiscogsService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Seller/Value2Payload/StatsPayload/CodingKeys":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/seller\/value2payload\/statspayload\/codingkeys","kind":"symbol","title":"Components.Schemas.Seller.Value2Payload.StatsPayload.CodingKeys","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Seller\/Value2Payload\/StatsPayload\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"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."}]}}} |