BE: Add new query API to list workspace ports
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
MR: Pending
Description
We want to introduce a new graphQL type for workspace ports that contains all the fields introduced in the workspaces_ports
table and add the relevant resolvers and connections to query the fields for this new type.
Acceptance Criteria
-
New graphQL type for workspace_ports -
Method to return access_url with the format #{port_number}-#{workspace_name}.#{agent_dns_zone}
-
New field for workspace_ports in the workspace type -
New finder/resolver for workspace_ports field -
GraphQL docs updated -
Check README for info on writing resolvers and specs -
Add relevant request specs to the ee/spec/requests/api/graphql/remote_development/workspace
folder -
Add unit tests for finder -
Update tests.yml
andscripts/verify-tff-mapping
-
Read and update ee/spec/requests/api/graphql/remote_development/README.md
-
Update remote_development integration_spec.rb
to test the new fields
Technical Requirement
GraphQL changes
-
Type.workspace
name type field workspacePorts
[WorkspacePort!]
-
Type.workspacePort
name type field id
GlobalIDType[::RemoteDevelopment::WorkspacePort]
field portNumber
Int
field portType
Enum
[default
,user_defined
]field accessUrl
String
field createdAt
TimeType
field updatedAt
TimeType
-
Fields for the new Type should be marked
experimental
according to mark-schema-items-as-experiments
Edited by 🤖 GitLab Bot 🤖