Supporting functions for Riak Admin API

.github/workflows/erlang.yml

@@ -34,3 +34,5 @@ jobs:
         run: ./rebar3 do xref, dialyzer
       - name: Run eunit
         run: ./rebar3 as gha do eunit
+      - name: Check format
+        run: ./rebar3 fmt --check

eqc/put_fsm_eqc.erl

@@ -44,7 +44,7 @@
 -include_lib("eqc/include/eqc.hrl").
 -include_lib("eunit/include/eunit.hrl").
 -include("include/riak_kv_vnode.hrl").
--include("../src/riak_kv_wm_raw.hrl").
+-include("include/riak_object.hrl").
 
 -define(REQ_ID, 1234).
 -define(DEFAULT_BUCKET_PROPS,

include/riak_kv_web.hrl

@@ -0,0 +1,68 @@
+%% -------------------------------------------------------------------
+%%
+%% Copyright (c) 2026 Martin Sumner
+%%
+%% This file is provided to you 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.
+%%
+%% -------------------------------------------------------------------
+%% @doc common definitions for web handlers
+
+-define(TXT_HEADER, {'Content-Type', <<"text/plain">>}).
+-define(JSN_HEADER, {'Content-Type', <<"application/json">>}).
+-define(BIN_HEADER, {'Content-Type', <<"application/octet-stream">>}).
+
+-define(HEAD_VCLOCK, <<"X-Riak-Vclock">>).
+-define(HEAD_USERMETA_PREFIX, <<"X-Riak-Meta-">>).
+-define(HEAD_INDEX_PREFIX, <<"X-Riak-Index-">>).
+-define(HEAD_DELETED, <<"X-Riak-Deleted">>).
+-define(HEAD_CONTINUATION, <<"X-Riak-Continuation">>).
+
+%% Case-folded headers to be used in lookups
+-define(HEAD_VCLOCK_CASEFOLD, <<"x-riak-vclock">>).
+-define(HEAD_IFNOTMOD_CASEFOLD, <<"x-riak-if-not-modified">>).
+-define(HEAD_USERMETA_CASEFOLD, <<"x-riak-meta-">>).
+-define(HEAD_INDEX_CASEFOLD, <<"x-riak-index-">>).
+-define(HEAD_CLIENTID_CASEFOLD, <<"x-riak-clientid">>).
+
+-define(Q_2I_CONTINUATION_BIN, <<"continuation">>).
+-define(Q_RESULTS_BIN, <<"results">>).
+-define(Q_KEYS_BIN, <<"keys">>).
+
+%% Names of JSON fields in bucket properties
+-define(JSON_PROPS, <<"props">>).
+-define(JSON_BUCKETS, <<"buckets">>).
+-define(JSON_KEYS, <<"keys">>).
+-define(JSON_MOD, <<"mod">>).
+-define(JSON_FUN, <<"fun">>).
+-define(JSON_NAME, <<"name">>).
+-define(JSON_ARG, <<"arg">>).
+-define(JSON_CHASH, <<"chash_keyfun">>).
+-define(JSON_JSFUN, <<"jsfun">>).
+-define(JSON_JSANON, <<"jsanon">>).
+-define(JSON_JSBUCKET, <<"bucket">>).
+-define(JSON_JSKEY, <<"key">>).
+-define(JSON_ALLOW_MULT, <<"allow_mult">>).
+-define(JSON_DATATYPE, <<"datatype">>).
+-define(JSON_POSTC, <<"postcommit">>).
+-define(JSON_PREC, <<"precommit">>).
+
+%% erlfmt:ignore-begin
+-type stream_fun() ::
+    fun(() ->
+            {binary(), stream_fun()}
+            | done
+            | error
+    ).
+%% erlfmt:ignore-end

include/riak_object.hrl

@@ -1,3 +1,13 @@
 -define(DOT, <<"dot">>). %% The event at which a value was written, stored in metadata
 
-
+%% Names of riak_object metadata fields
+-define(MD_CTYPE,    <<"content-type">>).
+-define(MD_CHARSET,  <<"charset">>).
+-define(MD_ENCODING, <<"content-encoding">>).
+-define(MD_VTAG,     <<"X-Riak-VTag">>).
+-define(MD_LINKS,    <<"Links">>).
+-define(MD_LASTMOD,  <<"X-Riak-Last-Modified">>).
+-define(MD_USERMETA, <<"X-Riak-Meta">>).
+-define(MD_INDEX,    <<"index">>).
+-define(MD_DELETED,  <<"X-Riak-Deleted">>).
+-define(MD_VAL_ENCODING, <<"X-Riak-Val-Encoding">>).