Voedger Internals
  • Introduction
  • 💡Concepts
    • Event Sourcing & CQRS
    • Editions (deprecated)
      • Community Edition
      • Standart Edition
      • Standart Edition (v1)
  • 🚀Server
    • Overview (Server)
    • Design
      • Query Processor
      • API Gateway implementation
      • N1 Cluster
      • N3 Cluster
      • N5 Cluster
      • Orchestration
      • Sequences
      • Packages overview
        • sys
        • registry
    • Features
      • API Gateway
        • API v2
          • Conventions
            • API URL
            • HTTP methods and processors
            • Naming conventions
            • Query constraints
            • Error handling
          • Documents and records
            • Create document or record
            • Update document or record
            • Deactivate document or record
            • Read document or record
            • Read from CDoc collection
          • Queries
            • Read from query
          • Views
            • Read from view
          • Commands
            • Execute command
          • BLOBs
            • Create BLOB
            • Read BLOB
          • Temporary BLOBs
            • Create temporary BLOB
            • Read temporary BLOB
          • Schemas
            • List app workspaces
            • List workspace roles
            • Read workspace role schema
        • API v1
          • API Conventions
          • BLOBs
      • Admin Endpoint
      • Clusters
        • Bootstrap
        • Monitoring
        • Secure prometheus and grafana
        • Alerting
        • Maintenance
          • SELECT, UPDATE
      • VVMs
      • Applications
        • Deploy Application
        • Sidecar Applications
      • AuthNZ
        • Issue Principal Token
        • Refresh Principal Token
        • Enrich Principal Token
        • ACL Rules
        • Global Roles
      • Data types
        • Core types
        • Small integers
        • Uniques With Multiple Fields
        • Verifiable Fields
      • Workspaces
        • Create Workspace
        • Deactivate Workspace
        • See also (Workspaces)
      • Invites
        • Invite to Workspace
        • Join Workspace
        • Leave Workspace
        • Cancel sent Invite
        • Cancel accepted Invite
        • Update Invite roles
      • Users
        • Create a new user
        • Change user password
        • Send Email
        • Reset password
        • Change Email
      • Notifications
        • Heartbeats
      • Devices
        • Create a new device
        • Join device to workspace
      • Jobs
      • DMBS Drivers
        • AmazonDB Driver
      • Frozen
        • Ephemeral Storage
        • Storage Extensions
  • 🛠️Framework
    • Overview (Framework)
    • Features
      • vpm
      • vpm init
      • vpm tidy
      • vpm baseline
      • vpm orm
      • vpm build
      • API for testing
  • Development
    • Requirements Management
    • Requirements Management (Overview)
Powered by GitBook
On this page
  • Motivation
  • Functional Design
  • Headers
  • Parameters
  • Result
  • See Also
  • Technical design
  • Components

Was this helpful?

Edit on GitHub
  1. 🚀Server
  2. Features
  3. API Gateway
  4. API v2
  5. Schemas

List app workspaces

PreviousSchemasNextList workspace roles

Last updated 1 month ago

Was this helpful?

Motivation

List app workspaces, using API

Functional Design

GET /api/v2/apps/{owner}/{app}/schemas

Returns the hierarchy of non-abstract workspaces in the application with WSProfile as a root. If Authorization header is provided, and user has sys.Developer role, the hierarchy of all workspaces in the application is returned. Otherwise, only workspaces returned which have resources available to .

Headers

Key
Value
Description

Authorization

Bearer {PrincipalToken}

optional

Accept

text/html

To get the response in HTML format (default)

Parameters

Parameter
Type
Description

owner

string

name of a user who owns the application

app

string

name of an application

Result

Code
Description
Body

200

OK

app workspaces hierarchy in the selected format

400

Bad Request

See Also

Technical design

Components

pkg/processors/query2

IApiPathHandler implementation for handling ApiPath_Schemas

  • ~cmp.schemasHandler~❓

newQueryProcessorPipeline: provide API handler for ApiPath_Schemas

  • `cmp.provideSchemasHandler

pkg/sys/it

  • integration test ~it.TestQueryProcessor2_Schemas~❓

published roles
List workspace roles
Read workspace role schema
error object