variables and permissions

Author: liammclennan

src/Seq.Api/Client/SeqApiClient.cs

@@ -35,16 +35,16 @@ namespace Seq.Api.Client
     /// <summary>
     /// A low-level client that provides navigation over the linked resource structure of the Seq HTTP API.
     /// </summary>
-    public class SeqApiClient : IDisposable
+    public sealed class SeqApiClient : IDisposable
     {
         readonly string _apiKey;
 
-        // Future versions of Seq may not completely support v1 features, however
+        // Future versions of Seq may not completely support vN-1 features, however
         // providing this as an Accept header will ensure what compatibility is available
         // can be utilized.
-        const string SeqApiV8MediaType = "application/vnd.datalust.seq.v8+json";
+        const string SeqApiV9MediaType = "application/vnd.datalust.seq.v9+json";
 
-        readonly CookieContainer _cookies = new CookieContainer();
+        readonly CookieContainer _cookies = new();
         readonly JsonSerializer _serializer = JsonSerializer.Create(
             new JsonSerializerSettings
             {
@@ -89,7 +89,7 @@ public SeqApiClient(string serverUrl, string apiKey = null, Action<HttpClientHan
                 baseAddress += "/";
 
             HttpClient = new HttpClient(handler) { BaseAddress = new Uri(baseAddress) };
-            HttpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(SeqApiV8MediaType));
+            HttpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(SeqApiV9MediaType));
 
             if (_apiKey != null)
                 HttpClient.DefaultRequestHeaders.Add("X-Seq-ApiKey", _apiKey);
@@ -175,8 +175,8 @@ public async Task PostAsync<TEntity>(ILinked entity, string link, TEntity conten
             var linkUri = ResolveLink(entity, link, parameters);
             var request = new HttpRequestMessage(HttpMethod.Post, linkUri) { Content = MakeJsonContent(content) };
             var stream = await HttpSendAsync(request, cancellationToken).ConfigureAwait(false);
-            using (var reader = new StreamReader(stream))
-                reader.ReadToEnd();
+            using var reader = new StreamReader(stream);
+            await reader.ReadToEndAsync();
         }
 
         /// <summary>
@@ -213,8 +213,8 @@ public async Task<string> PostReadStringAsync<TEntity>(ILinked entity, string li
             var linkUri = ResolveLink(entity, link, parameters);
             var request = new HttpRequestMessage(HttpMethod.Post, linkUri) { Content = MakeJsonContent(content) };
             var stream = await HttpSendAsync(request, cancellationToken).ConfigureAwait(false);
-            using (var reader = new StreamReader(stream))
-                return await reader.ReadToEndAsync();
+            using var reader = new StreamReader(stream);
+            return await reader.ReadToEndAsync();
         }
 
         /// <summary>

src/Seq.Api/Model/Alerting/AlertEntity.cs

@@ -42,7 +42,7 @@ public class AlertEntity : Entity
         public string OwnerId { get; set; }
 
         /// <summary>
-        /// If <c>true</c>, the alert can only be modified by users with the <see cref="Permission.Setup"/> permission.
+        /// If <c>true</c>, the alert can only be modified by users with the <see cref="Permission.Project"/> permission.
         /// </summary>
         public bool IsProtected { get; set; }
 

src/Seq.Api/Model/AppInstances/AppInstanceEntity.cs

@@ -160,5 +160,15 @@ public AppInstanceEntity()
         [Obsolete("Use !AcceptDirectInvocation instead.")]
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
         public bool? DisallowManualInput { get; set; }
+
+        /// <summary>
+        /// The name of the application.
+        /// </summary>
+        public string AppName { get; set; }
+
+        /// <summary>
+        /// Is the application an input application?
+        /// </summary>
+        public bool IsInput { get; set; }
     }
 }

src/Seq.Api/Model/Apps/AppSettingPart.cs

@@ -54,5 +54,16 @@ public class AppSettingPart
         /// for the setting.
         /// </summary>
         public List<AppSettingValuePart> AllowedValues { get; set; } = new List<AppSettingValuePart>();
+
+        /// <summary>
+        /// If the setting value contains code in a programming or markup language, the
+        /// language name.
+        /// </summary>
+        /// <remarks>Valid names are a subset of the names and aliases recognized by
+        /// <a href="https://github.com/github/linguist/blob/master/lib/linguist/languages.yml">GitHub
+        /// Linguist</a>. The generic value <c>code</c> will be specified if the language is non-specific but
+        /// the value should be displayed in fixed-width font. Seq also recognizes the special Seq-specific
+        /// <c>template</c> and <c>expression</c> syntaxes.</remarks>
+        public string Syntax { get; set; }
     }
 }

src/Seq.Api/Model/Dashboarding/DashboardEntity.cs

@@ -34,7 +34,7 @@ public class DashboardEntity : Entity
         public string Title { get; set; }
 
         /// <summary>
-        /// If <c>true</c>, only users with <see cref="Permission.Setup"/> can modify the dashboard.
+        /// If <c>true</c>, only users with <see cref="Permission.Project"/> can modify the dashboard.
         /// </summary>
         public bool IsProtected { get; set; }
 

src/Seq.Api/Model/Data/QueryResultPart.cs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace Seq.Api.Model.Data
@@ -50,6 +51,12 @@ public class QueryResultPart
         /// </summary>
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
         public TimeseriesPart[] Series { get; set; }
+        
+        /// <summary>
+        /// Result variables.
+        /// </summary>
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public Dictionary<string, object> Variables { get; set; }
 
         /// <summary>
         /// On error only, a description of the error.

src/Seq.Api/Model/Link.cs

@@ -26,7 +26,7 @@ namespace Seq.Api.Model
     /// parameterized in order to produce a complete URI (if the template contains no
     /// parameters then it may also be a literal URI).
     /// </summary>
-    public struct Link
+    public readonly struct Link
     {
         /// <summary>
         /// An empty link.

src/Seq.Api/Model/Security/Permission.cs

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using System;
+
 namespace Seq.Api.Model.Security
 {
     /// <summary>
@@ -46,10 +48,23 @@ public enum Permission
         /// Write-access to signals, alerts, preferences etc.
         /// </summary>
         Write,
-        
+
         /// <summary>
         /// Access to administrative features of Seq, management of other users, app installation, backups.
         /// </summary>
-        Setup,
+        [Obsolete("The `Setup` permission has been replaced by `Project` and `System`.")]
+        Setup = 5,
+
+        /// <summary>
+        /// Access to settings required for day-to-day operation of Seq, such as users, retention policies, API keys.
+        /// </summary>
+        Project,
+        
+        /// <summary>
+        /// Access to settings and features that interact with, or provide access to, the underlying host server,
+        /// such as app (plug-in) installation, backup settings, cluster configuration, diagnostics, and features
+        /// relying on outbound network access like package feeds and update checks.
+        /// </summary>
+        System
     }
 }

src/Seq.Api/Model/Shared/EvaluationContextPart.cs

@@ -0,0 +1,39 @@
+// Copyright © Datalust and contributors. 
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Collections.Generic;
+using Seq.Api.Model.Signals;
+
+#nullable enable
+
+namespace Seq.Api.Model.Shared
+{
+    /// <summary>
+    /// Specifies the context that queries and searches execute within.
+    /// </summary>
+    public class EvaluationContextPart
+    {
+        /// <summary>
+        /// An unsaved or modified signal.
+        /// </summary>
+        public SignalEntity? Signal { get; set; }
+        
+        /// <summary>
+        /// Values for free variables that appear in the query or search condition.
+        /// </summary>
+        /// <remarks>Variables will only be visible in the query or search being executed: any free variables
+        /// in signal filters will remain undefined.</remarks>
+        public Dictionary<string, object?>? Variables { get; set; }
+    }
+}

src/Seq.Api/Model/Signals/SignalEntity.cs

@@ -64,7 +64,7 @@ public SignalEntity()
         public bool? IsRestricted { get; set; }
 
         /// <summary>
-        /// If <c>true</c>, the signal can only be modified by users with the <see cref="Permission.Setup"/> permission.
+        /// If <c>true</c>, the signal can only be modified by users with the <see cref="Permission.Project"/> permission.
         /// </summary>
         public bool IsProtected { get; set; }