Post organisations schema utils info
SchemaInfo processes the schema referenced by the provided URL and returns information to allow a user to create an App.
Deprecated: This endpoint is no longer supported, users should create a Schema using the CreateSchema
(POST /organisations//schemas) operation, and use the GetSchemaInfo
operation to retrieve
this information.
Authorizations
Path Parameters
SchemaType is the type of schema which an App implements. The only supported values are currently "openapi", but is planned to be extended to include gRPC, GraphQL and SOAP.
Body
SourceURL is the URL which can be used to download the original schema document.
Response
The ID of the Schema record if it is stored.
Title is calculated from the parsed schema. Not all schemas contain this information so may be null.
Description is a human-friendly name for this server address. If a friendly name isn't available then this defaults to the URL.
URL is the server address listening for requests.
Type denotes the type of schema the corresponding App is backed by. Currently the only supported value is "openapi", but other types such as "soap", "graphql" and "grpc" are on the roadmap.
Version denotes the version of the schema specification. This property is contextual based on the schema
type, for example openapi schemas will contain the OpenAPI specification version (currently only 3.0.x is
supported), but grpc
APIs could be "proto2" or "proto3".
URL is the private address for accessing the schema. This is not guaranteed to be publicly accessible and could be a non-HTTP protocol (i.e. gs:// or s3://)
SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.
Type denotes the method of authentication. Valid values are: "oidc"
, "oauth2"
, "apikey"
, `"httpBasicAuth"
IsValid is true if and only if the data
field is populated with all the required information to enable
an organisation to connect to the App via this auth type. It is allowed for an App to have invalid auth
configs providing there is at least one valid.
AppAuthConfigData should JSON-marshal to one of the types specified in the jsonschema oneOf:
- AppAuthConfigOIDC
- AppAuthConfigOAuth2
- AppAuthConfigApiKey
- AppAuthConfigHTTPRefresh
- AppAuthConfigHTTPBasicAuth
- AppAuthConfigJWTBearer
- AppAuthConfigCustomFunction