javier
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
5.4 KiB
JSON
1 line
5.4 KiB
JSON
{"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Product","kind":"identifier"}],"roleHeading":"Structure","externalID":"s:14DiscogsService7ProductV","title":"Product","role":"symbol","symbolKind":"struct","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Product","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A representation of the product information used to generate the "},{"type":"codeVoice","code":"User-Agent"},{"type":"text","text":" header for requests to the Discogs API."}],"topicSections":[{"title":"Initializers","anchor":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product\/init(name:version:url:)"]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Product"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"inlineContent":[{"type":"text","text":"The Discogs API requires a "},{"code":"User-Agent","type":"codeVoice"},{"type":"text","text":" header that identifies the application making the request. This model captures"},{"text":" ","type":"text"},{"text":"the product name, version, and URL needed to build that header via the ","type":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The generated "},{"type":"codeVoice","code":"User-Agent"},{"type":"text","text":" header follows the format: "},{"type":"codeVoice","code":"ProductName\/1.0.0 +https:\/\/example.com"}]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/product"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware"],"generated":true,"anchor":"User-Agent","title":"User Agent"}],"sections":[],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/UserAgentMiddleware":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserAgentMiddleware"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserAgentMiddleware"}],"abstract":[{"text":"A middleware that attaches the user agent header into the requests to the service.","type":"text"}],"title":"UserAgentMiddleware","url":"\/documentation\/discogsservice\/useragentmiddleware","type":"topic"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Product/init(name:version:url:)":{"role":"symbol","url":"\/documentation\/discogsservice\/product\/init(name:version:url:)","kind":"symbol","title":"init(name:version:url:)","abstract":[{"type":"text","text":"Initializes this model."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product\/init(name:version:url:)"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"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/Product":{"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Product","kind":"identifier"}],"navigatorTitle":[{"text":"Product","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A representation of the product information used to generate the ","type":"text"},{"code":"User-Agent","type":"codeVoice"},{"text":" header for requests to the Discogs API.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product","title":"Product","url":"\/documentation\/discogsservice\/product"}}} |