Skip to content

Commit

Permalink
update links
Browse files Browse the repository at this point in the history
  • Loading branch information
leonitousconforti committed Oct 22, 2024
1 parent cf24b45 commit 54eb77f
Show file tree
Hide file tree
Showing 15 changed files with 143 additions and 143 deletions.
16 changes: 8 additions & 8 deletions src/endpoints/Configs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* mode must be enabled for these endpoints to work.
*
* @since 1.0.0
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Config
*/

import * as PlatformError from "@effect/platform/Error";
Expand Down Expand Up @@ -63,7 +63,7 @@ export class ConfigsError extends PlatformError.TypeIdError(ConfigsErrorTypeId,
*
* @since 1.0.0
* @category Services
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Config
*/
export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoints/Configs", {
accessors: false,
Expand All @@ -73,7 +73,7 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
const contextClient = yield* HttpClient.HttpClient;
const client = contextClient.pipe(HttpClient.filterStatusOk);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config/operation/ConfigList */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Config/operation/ConfigList */
const list_ = (
options?:
| {
Expand All @@ -95,7 +95,7 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config/operation/ConfigCreate */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Config/operation/ConfigCreate */
const create_ = (
options: typeof SwarmConfigSpec.Encoded
): Effect.Effect<Readonly<SwarmConfigCreateResponse>, ConfigsError, never> =>
Expand All @@ -109,7 +109,7 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config/operation/ConfigDelete */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Config/operation/ConfigDelete */
const delete_ = (id: string): Effect.Effect<void, ConfigsError, never> =>
Function.pipe(
HttpClientRequest.del(`/configs/${encodeURIComponent(id)}`),
Expand All @@ -119,7 +119,7 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config/operation/ConfigInspect */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Config/operation/ConfigInspect */
const inspect_ = (id: string): Effect.Effect<Readonly<SwarmConfig>, ConfigsError, never> =>
Function.pipe(
HttpClientRequest.get(`/configs/${encodeURIComponent(id)}`),
Expand All @@ -129,7 +129,7 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config/operation/ConfigUpdate */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Config/operation/ConfigUpdate */
const update_ = (
id: string,
options: {
Expand Down Expand Up @@ -172,6 +172,6 @@ export class Configs extends Effect.Service<Configs>()("@the-moby-effect/endpoin
*
* @since 1.0.0
* @category Layers
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Config
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Config
*/
export const ConfigsLayer: Layer.Layer<Configs, never, HttpClient.HttpClient> = Configs.Default;
56 changes: 28 additions & 28 deletions src/endpoints/Containers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @since 1.0.0
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Container
*/

import * as PlatformError from "@effect/platform/Error";
Expand Down Expand Up @@ -81,7 +81,7 @@ export class ContainersError extends PlatformError.TypeIdError(ContainersErrorTy
/**
* @since 1.0.0
* @category Services
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Container
*/
export class Containers extends Effect.Service<Containers>()("@the-moby-effect/endpoints/Containers", {
accessors: false,
Expand All @@ -94,7 +94,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
HttpClient.filterStatus((status) => (status >= 200 && status < 300) || status === 101)
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerList */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerList */
const list_ = (
options?:
| {
Expand Down Expand Up @@ -143,7 +143,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerCreate */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerCreate */
const create_ = (options: {
readonly name?: string | undefined;
readonly platform?: string | undefined;
Expand All @@ -161,7 +161,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerInspect */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerInspect */
const inspect_ = (
id: string,
options?:
Expand All @@ -179,7 +179,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerTop */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerTop */
const top_ = (
id: string,
options?:
Expand All @@ -197,7 +197,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerLogs */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerLogs */
const logs_ = (
id: string,
options?:
Expand Down Expand Up @@ -227,7 +227,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Stream.mapError((cause) => new ContainersError({ method: "logs", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerChanges */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerChanges */
const changes_ = (id: string): Effect.Effect<ReadonlyArray<ContainerChange> | null, ContainersError> =>
Function.pipe(
HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/changes`),
Expand All @@ -237,7 +237,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerExport */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerExport */
const export_ = (id: string): Stream.Stream<Uint8Array, ContainersError, never> =>
Function.pipe(
HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/export`),
Expand All @@ -246,7 +246,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Stream.mapError((cause) => new ContainersError({ method: "export", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerStats */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStats */
const stats_ = (
id: string,
options?:
Expand All @@ -267,7 +267,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Stream.mapError((cause) => new ContainersError({ method: "stats", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerResize */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerResize */
const resize_ = (
id: string,
options?:
Expand All @@ -287,7 +287,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerStart */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStart */
const start_ = (
id: string,
options?:
Expand All @@ -305,7 +305,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerStop */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStop */
const stop_ = (
id: string,
options?:
Expand All @@ -325,7 +325,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerRestart */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerRestart */
const restart_ = (
id: string,
options?:
Expand All @@ -345,7 +345,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerKill */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerKill */
const kill_ = (
id: string,
options?:
Expand All @@ -363,7 +363,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerUpdate */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerUpdate */
const update_ = (
id: string,
options: {
Expand All @@ -379,7 +379,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerRename */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerRename */
const rename_ = (
id: string,
options: {
Expand All @@ -395,7 +395,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerPause */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerPause */
const pause_ = (id: string): Effect.Effect<void, ContainersError, never> =>
Function.pipe(
HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/pause`),
Expand All @@ -405,7 +405,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerUnpause */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerUnpause */
const unpause_ = (id: string): Effect.Effect<void, ContainersError, never> =>
Function.pipe(
HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/unpause`),
Expand Down Expand Up @@ -435,7 +435,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
* @param stdin - Attach to `stdin`
* @param stdout - Attach to `stdout`
* @param stderr - Attach to `stderr`
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerAttach
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerAttach
*/
const attach_ = (
id: string,
Expand Down Expand Up @@ -465,7 +465,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.mapError((cause) => new ContainersError({ method: "attach", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerAttachWebsocket */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerAttachWebsocket */
const attachWebsocket_ = (
id: string,
options?:
Expand Down Expand Up @@ -493,7 +493,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.mapError((cause) => new ContainersError({ method: "attachWebsocket", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerWait */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerWait */
const wait_ = (
id: string,
options?: { readonly condition?: string | undefined } | undefined
Expand All @@ -507,7 +507,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerDelete */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerDelete */
const delete_ = (
id: string,
options?:
Expand All @@ -529,7 +529,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerArchive */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerArchive */
const archive_ = (
id: string,
options: { readonly path: string }
Expand All @@ -542,7 +542,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Stream.mapError((cause) => new ContainersError({ method: "archive", cause }))
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerArchiveInfo */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerArchiveInfo */
const archiveInfo_ = (
id: string,
options: { readonly path: string }
Expand All @@ -556,7 +556,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/PutContainerArchive */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/PutContainerArchive */
const putArchive_ = <E1>(
id: string,
options: {
Expand All @@ -578,7 +578,7 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
Effect.scoped
);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container/operation/ContainerPrune */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerPrune */
const prune_ = (
options?:
| {
Expand Down Expand Up @@ -633,6 +633,6 @@ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/e
/**
* @since 1.0.0
* @category Layers
* @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Container
* @see https://docs.docker.com/reference/api/engine/latest/#tag/Container
*/
export const ContainersLayer: Layer.Layer<Containers, never, HttpClient.HttpClient> = Containers.Default;
2 changes: 1 addition & 1 deletion src/endpoints/Distribution.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export class Distributions extends Effect.Service<Distributions>()("@the-moby-ef
const contextClient = yield* HttpClient.HttpClient;
const client = contextClient.pipe(HttpClient.filterStatusOk);

/** @see https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Distribution/operation/DistributionInspect */
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Distribution/operation/DistributionInspect */
const inspect_ = (
name: string
): Effect.Effect<Readonly<RegistryDistributionInspect>, DistributionsError, never> =>
Expand Down
Loading

0 comments on commit 54eb77f

Please sign in to comment.