itproject
| Application Name | Method |
|---|---|
| authenticate | getClaims |
| authenticate | login |
| authenticate | register |
| authenticate | registerFirebase |
| authenticate | verify |
| echo | echo |
| profiles | getuser |
| profiles | updateuser |
| search | search |
| upload | upload |
| Application Name | Type Name |
|---|---|
| itproject | account |
| itproject | artifact |
| itproject | echoRequest |
| itproject | echoResponse |
| itproject | empty |
| itproject | getClaimsResponse |
| itproject | getuserRequest |
| itproject | job |
| itproject | loginRequest |
| itproject | loginResponse |
| itproject | profile |
| itproject | registerRequest |
| itproject | registerResponse |
| itproject | searchRequest |
| itproject | searchResponse |
| itproject | uploadRequest |
| itproject | uploadResponse |
| itproject | verifyRequest |
| itproject | verifyResponse |
- authenticate miroservice that handles authentication and issues JWTs with username claims.
getClaims is used to get which user is currently logged in
Sequence Diagram
Request types
Response types
getClaimsResponse contains a username
Login is used to login to acquire a JWT
Sequence Diagram
Request types
Response types
loginRequest is the response object from Login that is used in bearer authentic ation in the header: "Bearer "
register is used to register a user and acquire a JWT
Sequence Diagram
Request types
Response types
RegisterResponse is the response from the registration services
registerFirebase is used to register a user and acquire a JWT
Sequence Diagram
Request types
Response types
empty is an empty type for messages that don't need a payload
verify is used to verify if a user has permissions to edit a profile
Sequence Diagram
Request types
Response types
verifyResponse is a message that has verified=true if the authenticated used ha s the ability to edit the page
- EchoService is a basic service to test connections
echo is a method to test service deployments
Sequence Diagram
Request types
Response types
echoResponse is the response from the EchoService
- profiles is a service to retrieve and update a profile that is displayed
getuser gets a user from a userid
Sequence Diagram
Request types
Response types
profile is the data model of the page that is displayed to a user
updateuser updates a profile
Sequence Diagram
Request types
Response types
empty is an empty type for messages that don't need a payload
- search is a service that is used to find a profile/user based on a search param eter
Sequence Diagram
Request types
Response types
searchResponse is a type that contains the profiles that match the search term
- upload service is used to upload static assets to gcs
upload uploads a static asset to gcp and returns a url
Sequence Diagram
Request types
Response types
uploadResponse contains the url of the static asset
account is an account that is stored in the firebase database. account contains all of the username/passwords and hashes.
| Field name | Type | Description |
|---|---|---|
| string | ||
| name | string | |
| password | string | |
| preferred_name | string | |
| salt | string | |
| username | string |
itproject.artifact
- artifact is a generic entry in the frontend
| Field name | Type | Description |
|---|---|---|
| description | string | |
| link | string | |
| title | string |
itproject.echoRequest
- echoRequest is the request object for EchoService
| Field name | Type | Description |
|---|---|---|
| message | string |
itproject.echoResponse
- echoResponse is the response from the EchoService
| Field name | Type | Description |
|---|---|---|
| message | string |
itproject.getClaimsResponse
- getClaimsResponse contains a username
| Field name | Type | Description |
|---|---|---|
| username | string |
itproject.getuserRequest
- getuserRequest contains a username to respond
| Field name | Type | Description |
|---|---|---|
| userid | string |
itproject.job
- job contains information to display in the frontend timeline
| Field name | Type | Description |
|---|---|---|
| company | string | |
| dates | string | |
| description | string | |
| title | string |
itproject.loginRequest
- loginRequest is empty because the Bas64(username:password) is contained in the header of the request
itproject.loginResponse
- loginRequest is the response object from Login that is used in bearer authentic ation in the header: "Bearer "
| Field name | Type | Description |
|---|---|---|
| jwt | string |
itproject.profile
- profile is the data model of the page that is displayed to a user
| Field name | Type | Description |
|---|---|---|
| artifacts | sequence of artifact | |
| bio | string | |
| content | string | |
| string | ||
| full_name | string | |
| jobs | sequence of job | |
| links | sequence of STRING | |
| picture | string | |
| username | string |
itproject.registerRequest
- registerRequest contains all the information to register the user in the databa se
| Field name | Type | Description |
|---|---|---|
| string | ||
| fullName | string | |
| password | string | |
| preferredName | string | |
| username | string |
itproject.registerResponse
- RegisterResponse is the response from the registration services
| Field name | Type | Description |
|---|---|---|
| jwt | string |
itproject.searchRequest
- searchRequest has the term query that should be searched for
| Field name | Type | Description |
|---|---|---|
| term | string |
itproject.searchResponse
- searchResponse is a type that contains the profiles that match the search term
| Field name | Type | Description |
|---|---|---|
| results | sequence of profile |
itproject.uploadRequest
- upload request contains the data to upload an asset to gcp
| Field name | Type | Description |
|---|---|---|
| dataurl | string | dataurl is a string that conforms to the data url schema: https: |
| developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs |
|
itproject.uploadResponse
- uploadResponse contains the url of the static asset
| Field name | Type | Description |
|---|---|---|
| url | string |
url is in the form https:
storage.googleapis.com/joshcarp-it-project-storage/
where assetname is a randomly assigned string
|
itproject.verifyRequest
- verifyRequest is used in the veryfy endpoint
| Field name | Type | Description |
|---|---|---|
| username | string |
itproject.verifyResponse
- verifyResponse is a message that has verified=true if the authenticated used ha s the ability to edit the page
| Field name | Type | Description |
|---|---|---|
| verified | bool |