ClientConfigDocument
The settings the Gitmoap command-line tools read to reach Gitmoap.
Served unauthenticated at /.well-known/gitmoap-client-config. Every field
is public by construction: these are the values a client needs before it
can authenticate, so none of them can be a secret.
The gitmoap CLI and git-remote-gitmoap carry only the host this document
is served from and read everything else here, so the API URL, the git
endpoint and the sign-in settings can change without a new client release.
Shape
- api_urlstringBase URL of the REST API, no trailing slash.
- cli_client_idstringThe OAuth client id the CLI signs in as.
- cognito_domainstringThe domain of the hosted sign-in page the login flow authorizes against, without a scheme.
- cognito_regionstringThe AWS region of the sign-in service.
- git_endpointstringWebSocket endpoint for git transport (
wss://…), used bygit-remote-gitmoap. - download_basestring or nulloptionalWhere the client binaries are published, no trailing slash. Absent when none are.
Example
Synthesized example{
"api_url": "https://gitmoap.example/acme/fb3012b2",
"cli_client_id": "5d0a9740-2ade-4b09-94af-71e93946b467",
"cognito_domain": "cognito-domain-1f03",
"cognito_region": "cognito-region-522a",
"git_endpoint": "git-endpoint-d55f",
"download_base": "download-base-8681"
}
Graph
Used inside
No schema contains this one.
Contains
No named schema inside.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 1 operation