de5b4ff5d0
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document. Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation. Reviewed-on: #8 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
8.8 KiB
JSON
1 line
8.8 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"StatsPayload"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"init(community:)","externalID":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV9communityA2I09CommunityH0VSg_tcfc","modules":[{"name":"DiscogsService"}],"roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"community"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ReleaseVersion","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"StatsPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"CommunityPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V"},{"kind":"text","text":"?)"}],"symbolKind":"init"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(community:)"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"community"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ReleaseVersion","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"StatsPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"CommunityPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload"},{"kind":"text","text":"? = nil)"}],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"A type that represents the relationship between users and a release version."}],"type":"paragraph"}],"name":"community"}]}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatsPayload","kind":"identifier"}],"title":"Components.Schemas.ReleaseVersion.StatsPayload","navigatorTitle":[{"text":"StatsPayload","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","kind":"symbol","abstract":[{"text":"A type contains statictics about a release version.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseVersion","kind":"identifier"}],"title":"Components.Schemas.ReleaseVersion","navigatorTitle":[{"text":"ReleaseVersion","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","kind":"symbol","abstract":[{"type":"text","text":"A type that represents a version of a release."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/CommunityPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/communitypayload","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CommunityPayload","kind":"identifier"}],"title":"Components.Schemas.ReleaseVersion.StatsPayload.CommunityPayload","navigatorTitle":[{"text":"CommunityPayload","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload","kind":"symbol","abstract":[{"text":"A type that represents the relationship between users and a release version.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/init(community:)":{"type":"topic","title":"init(community:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"StatsPayload"},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(community:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"community"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV","text":"ReleaseVersion"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV","text":"StatsPayload"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V","text":"CommunityPayload"},{"kind":"text","text":"?)"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"type":"topic","title":"Components.Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]}}} |