Dagger
Search

api-tool

No long description provided.

Installation

dagger install github.com/orvis98/api-tool@v0.1.0

Entrypoint

Return Type 
ApiTool
Example
dagger -m github.com/orvis98/api-tool@68360574176d72242a361cc86ed672a6639a534c call \

func (m *MyModule) Example() *dagger.ApiTool  {
	return dag.
			ApiTool()
}
@function
def example() -> dagger.ApiTool:
	return (
		dag.api_tool()
	)
@func()
example(): ApiTool {
	return dag
		.apiTool()
}

Types

ApiTool 🔗

cue() 🔗

A container with CUE and a source directory.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory -No description provided
Example
dagger -m github.com/orvis98/api-tool@68360574176d72242a361cc86ed672a6639a534c call \
 cue
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			ApiTool().
			Cue()
}
@function
def example() -> dagger.Container:
	return (
		dag.api_tool()
		.cue()
	)
@func()
example(): Container {
	return dag
		.apiTool()
		.cue()
}

genXrd() 🔗

Generate and print an XRD from an API specification.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiSpecFile !-No description provided
sourceDirectory -No description provided
Example
dagger -m github.com/orvis98/api-tool@68360574176d72242a361cc86ed672a6639a534c call \
 gen-xrd --api-spec file:path
func (m *MyModule) Example(ctx context.Context, apiSpec *dagger.File) string  {
	return dag.
			ApiTool().
			GenXrd(ctx, apiSpec)
}
@function
async def example(api_spec: dagger.File) -> str:
	return await (
		dag.api_tool()
		.gen_xrd(api_spec)
	)
@func()
async example(apiSpec: File): Promise<string> {
	return dag
		.apiTool()
		.genXrd(apiSpec)
}

genCompositions() 🔗

Generate and print Compositions from an API specification.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiSpecFile !-No description provided
sourceDirectory -No description provided
Example
dagger -m github.com/orvis98/api-tool@68360574176d72242a361cc86ed672a6639a534c call \
 gen-compositions --api-spec file:path
func (m *MyModule) Example(ctx context.Context, apiSpec *dagger.File) string  {
	return dag.
			ApiTool().
			GenCompositions(ctx, apiSpec)
}
@function
async def example(api_spec: dagger.File) -> str:
	return await (
		dag.api_tool()
		.gen_compositions(api_spec)
	)
@func()
async example(apiSpec: File): Promise<string> {
	return dag
		.apiTool()
		.genCompositions(apiSpec)
}

gen() 🔗

Generate and print XRD and Compositions from an API specification.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiSpecFile !-No description provided
sourceDirectory -No description provided
Example
dagger -m github.com/orvis98/api-tool@68360574176d72242a361cc86ed672a6639a534c call \
 gen --api-spec file:path
func (m *MyModule) Example(ctx context.Context, apiSpec *dagger.File) string  {
	return dag.
			ApiTool().
			Gen(ctx, apiSpec)
}
@function
async def example(api_spec: dagger.File) -> str:
	return await (
		dag.api_tool()
		.gen(api_spec)
	)
@func()
async example(apiSpec: File): Promise<string> {
	return dag
		.apiTool()
		.gen(apiSpec)
}