blob: a9a786d7d8e61b30f9b18ebd65f2844d4964d152 [file] [log] [blame]
Ed Tanous911ac312017-08-15 09:37:42 -07001#pragma once
2
Ed Tanous81d523a2022-05-25 12:00:51 -07003#include "error_messages.hpp"
4#include "utility.hpp"
5
Ed Tanous04e438c2020-10-03 08:06:26 -07006#include <app.hpp>
Ed Tanousa8c4ce92021-03-24 08:44:51 -07007#include <http_request.hpp>
8#include <http_response.hpp>
Ed Tanous81d523a2022-05-25 12:00:51 -07009#include <schemas.hpp>
Ed Tanousa8c4ce92021-03-24 08:44:51 -070010
11#include <string>
Ed Tanous1abe55e2018-09-05 08:30:59 -070012
Ed Tanous1abe55e2018-09-05 08:30:59 -070013namespace redfish
14{
Ed Tanousa8c4ce92021-03-24 08:44:51 -070015
Ed Tanousd3355c52022-05-11 14:40:49 -070016inline void redfishGet(App& app, const crow::Request& req,
17 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
18{
Carson Labrado3ba00072022-06-06 19:40:56 +000019 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanousd3355c52022-05-11 14:40:49 -070020 {
21 return;
22 }
23 asyncResp->res.jsonValue["v1"] = "/redfish/v1/";
24}
25
Ed Tanous8c623a92022-05-24 11:54:51 -070026inline void redfish404(App& app, const crow::Request& req,
27 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
28 const std::string& path)
29{
30 asyncResp->res.addHeader(boost::beast::http::field::allow, "");
31
32 // If we fall to this route, we didn't have a more specific route, so return
33 // 404
Nan Zhou686b7092022-06-15 20:02:27 +000034 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous8c623a92022-05-24 11:54:51 -070035 {
36 return;
37 }
38
39 BMCWEB_LOG_ERROR << "404 on path " << path;
40
41 boost::urls::string_value name = req.urlView.segments().back();
42 std::string_view nameStr(name.data(), name.size());
43 // Note, if we hit the wildcard route, we don't know the "type" the user was
44 // actually requesting, but giving them a return with an empty string is
45 // still better than nothing.
46 messages::resourceNotFound(asyncResp->res, "", nameStr);
47}
48
Ed Tanous81d523a2022-05-25 12:00:51 -070049inline void
50 jsonSchemaIndexGet(App& app, const crow::Request& req,
51 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
52{
53 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
54 {
55 return;
56 }
57 nlohmann::json& json = asyncResp->res.jsonValue;
58 json["@odata.id"] = "/redfish/v1/JsonSchemas";
59 json["@odata.context"] =
60 "/redfish/v1/$metadata#JsonSchemaFileCollection.JsonSchemaFileCollection";
61 json["@odata.type"] = "#JsonSchemaFileCollection.JsonSchemaFileCollection";
62 json["Name"] = "JsonSchemaFile Collection";
63 json["Description"] = "Collection of JsonSchemaFiles";
64 nlohmann::json::array_t members;
65 for (const std::string_view schema : schemas)
66 {
67 nlohmann::json::object_t member;
68 member["@odata.id"] = crow::utility::urlFromPieces(
69 "redfish", "v1", "JsonSchemas", schema);
70 members.push_back(std::move(member));
71 }
72 json["Members"] = std::move(members);
73 json["Members@odata.count"] = schemas.size();
74}
75
76inline void jsonSchemaGet(App& app, const crow::Request& req,
77 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
78 const std::string& schema)
79{
80 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
81 {
82 return;
83 }
84
85 if (std::find(schemas.begin(), schemas.end(), schema) == schemas.end())
86 {
87 messages::resourceNotFound(asyncResp->res,
88 "JsonSchemaFile.JsonSchemaFile", schema);
89 return;
90 }
91
92 nlohmann::json& json = asyncResp->res.jsonValue;
93 json["@odata.context"] =
94 "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile";
95 json["@odata.id"] =
96 crow::utility::urlFromPieces("redfish", "v1", "JsonSchemas", schema);
97 json["@odata.type"] = "#JsonSchemaFile.v1_0_2.JsonSchemaFile";
98 json["Name"] = schema + " Schema File";
99 json["Description"] = schema + " Schema File Location";
100 json["Id"] = schema;
101 std::string schemaName = "#";
102 schemaName += schema;
103 schemaName += ".";
104 schemaName += schema;
105 json["Schema"] = std::move(schemaName);
106 constexpr std::array<std::string_view, 1> languages{"en"};
107 json["Languages"] = languages;
108 json["Languages@odata.count"] = languages.size();
109
110 nlohmann::json::array_t locationArray;
111 nlohmann::json::object_t locationEntry;
112 locationEntry["Language"] = "en";
113 locationEntry["PublicationUri"] =
114 "http://redfish.dmtf.org/schemas/v1/" + schema + ".json";
115 locationEntry["Uri"] = crow::utility::urlFromPieces(
116 "redfish", "v1", "JsonSchemas", schema, std::string(schema) + ".json");
117
118 locationArray.emplace_back(locationEntry);
119
120 json["Location"] = std::move(locationArray);
121 json["Location@odata.count"] = 1;
122}
123
Ed Tanousf65fca62022-05-24 12:49:41 -0700124inline void requestRoutesRedfish(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700125{
126 BMCWEB_ROUTE(app, "/redfish/")
Ed Tanousb41187f2019-10-24 16:30:02 -0700127 .methods(boost::beast::http::verb::get)(
Ed Tanousd3355c52022-05-11 14:40:49 -0700128 std::bind_front(redfishGet, std::ref(app)));
Ed Tanous8c623a92022-05-24 11:54:51 -0700129
Ed Tanous81d523a2022-05-25 12:00:51 -0700130 BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/<str>/")
131 .methods(boost::beast::http::verb::get)(
132 std::bind_front(jsonSchemaGet, std::ref(app)));
133
134 BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/")
135 .methods(boost::beast::http::verb::get)(
136 std::bind_front(jsonSchemaIndexGet, std::ref(app)));
Ed Tanouse9dd1d32022-06-17 11:56:00 -0700137
138 // Note, this route must always be registered last
139 BMCWEB_ROUTE(app, "/redfish/<path>")
140 (std::bind_front(redfish404, std::ref(app)));
Ed Tanous3dac7492017-08-02 13:46:20 -0700141}
Ed Tanousf65fca62022-05-24 12:49:41 -0700142
Ed Tanous1abe55e2018-09-05 08:30:59 -0700143} // namespace redfish