List module example tree

List the immediate children (files and subdirectories) at the given path within a module version's examples/ tree. The path must be exactly "examples" (root listing) or begin with "examples/". Returns one level of entries, each tagged as a file or directory.

get

Path parameters

module_idstringRequired

module id

Example: Quas ducimus illum nulla animi.

Query parameters

versionstringRequired

version of the module

Example: Voluptas necessitatibus voluptas.

scope_orgstringOptional

org name

Example: Temporibus tempora.

scope_projectstringOptional

project name

Example: Eligendi totam vel.

pathstring · min: 1 · max: 1024Required

relative path under the module root; must be "examples" or begin with "examples/"

Example: kPattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$

Header parameters

Harness-AccountstringRequired

account name

Example: Harum enim odit vel illum amet.

Responses

200

OK response.

application/json

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

get/api/modules/{module_id}/examples/tree

GET /api/modules/{module_id}/examples/tree?version=Voluptas+necessitatibus+voluptas.&path=k HTTP/1.1
Host: localhost:80
Harness-Account: Harum enim odit vel illum amet.
Accept: */*

{
  "items": [
    {
      "content_type": "directory",
      "name": "Doloremque voluptates.",
      "path": "Laboriosam et perspiciatis dolores tempora mollitia."
    },
    {
      "content_type": "directory",
      "name": "Doloremque voluptates.",
      "path": "Laboriosam et perspiciatis dolores tempora mollitia."
    },
    {
      "content_type": "directory",
      "name": "Doloremque voluptates.",
      "path": "Laboriosam et perspiciatis dolores tempora mollitia."
    },
    {
      "content_type": "directory",
      "name": "Doloremque voluptates.",
      "path": "Laboriosam et perspiciatis dolores tempora mollitia."
    }
  ]
}