swift-libs/docs/swift-libs-communication/data/documentation/swiftlibscommunication/endpoint.json

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/endpoint"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"title":"Endpoint","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:22SwiftLibsCommunication8EndpointP","modules":[{"name":"SwiftLibsCommunication"}],"navigatorTitle":[{"kind":"identifier","text":"Endpoint"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/body","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/headers-swift.property","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/host","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/method","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/parameters-swift.property","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/path","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/port","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/scheme"]},{"title":"Type Aliases","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/Headers-swift.typealias","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/Parameters-swift.typealias"]}],"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/path":{"role":"symbol","title":"path","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The path subcomponent for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/path","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/path"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/Headers-swift.typealias":{"role":"symbol","title":"Endpoint.Headers","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/Headers-swift.typealias","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"url":"\/documentation\/swiftlibscommunication\/endpoint\/headers-swift.typealias"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/host":{"role":"symbol","title":"host","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"host"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The host subcomponent for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/host","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/host"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint":{"role":"symbol","title":"Endpoint","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endpoint"}],"url":"\/documentation\/swiftlibscommunication\/endpoint"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/scheme":{"role":"symbol","title":"scheme","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"scheme"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The scheme subcomponent for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/scheme","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/scheme"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/port":{"role":"symbol","title":"port","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"port"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The port subcomponent for the component."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/port","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/port"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/headers-swift.property":{"role":"symbol","title":"headers","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP7Headersa"}],"abstract":[{"type":"text","text":"The HTTP header fields as a dictionary for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/headers-swift.property","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/headers-swift.property"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/Parameters-swift.typealias":{"role":"symbol","title":"Endpoint.Parameters","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/Parameters-swift.typealias","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Parameters"}],"url":"\/documentation\/swiftlibscommunication\/endpoint\/parameters-swift.typealias"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/method":{"role":"symbol","title":"method","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO"}],"abstract":[{"type":"text","text":"The HTTP request method for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/method","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/method"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/body":{"role":"symbol","title":"body","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The message body as data for a request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/body","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/body"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint/parameters-swift.property":{"role":"symbol","title":"parameters","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP10Parametersa"}],"abstract":[{"type":"text","text":"The query parameter subcomponents for the endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint\/parameters-swift.property","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/endpoint\/parameters-swift.property"}}}