Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Switch to GitLab Next
Sign in / Register
Toggle navigation
Open sidebar
glngn
glngn-server-examples
Commits
b310e8bd
Commit
b310e8bd
authored
Jan 06, 2020
by
Corey O'Connor
Browse files
expand on guide
parent
8f84cd65
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
25 additions
and
7 deletions
+25
-7
README.md
README.md
+25
-7
No files found.
README.md
View file @
b310e8bd
...
...
@@ -175,25 +175,43 @@ representation.
### API Tour
TODO: Go over the general types of default routes)
-
All routes prefixed with a
`_`
are operations routes. These are provided by glngn server.
-
`/_ops/`
-
Deployment
`_ops`
routes
-
These are always available
-
`/_ops/groups`
-
query and modify the available groups.
-
EG:
`/_ops/groups`
: query and modify the available groups.
-
`/$GROUP/_ops`
-
Group
`_ops`
routes,
`/$GROUP/_ops`
, require a group to be created
-
`/$GROUP/$SERVICE/_ops`
-
Service fragment
`_ops`
routes,
`/$GROUP/$SERVICE/_ops`
, require the service fragment to be
instantiated under the group.
-
automatically generated for each instantiated service fragment
-
`/$GROUP/$SERVICE/...`
-
All other routes under a service are provided by a Service Fragment's
`endpoints`
.
### Groups
###
Create a
Groups
TODO: show dynamic instantiation of a group
The
`/_ops/groups`
endpoint is used to query the existing groups and create new groups.
All services are namespaced under a group. Before we can instantiate and use a service we must
first create a group:
### Service Fragment
s
###
Instantiate a
Service Fragment
TODO: show dynamic instantiation of a service fragment under a group
### Use a Service Fragment
TODO:
1.
show dynamic instantiation of a service fragment in OpenAPI schema.
2.
demo using the counter service fragment
### Capturing Events
TODO:
1.
demo capturing unmodeled events:
1.
deployment-wide (?)
2.
group events
3.
service events
2.
demo capturing a service modeled event
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment