Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add styling for HTTP request methods #17682

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/api-reference/automatic-compaction-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Note that this endpoint returns an HTTP `200 OK` message code even if the dataso

#### URL

`POST` `/druid/coordinator/v1/config/compaction`
<code class="postAPI">POST</code> <code>/druid/coordinator/v1/config/compaction</code>

#### Responses

Expand Down Expand Up @@ -138,7 +138,7 @@ Removes the automatic compaction configuration for a datasource. This updates th

#### URL

`DELETE` `/druid/coordinator/v1/config/compaction/{dataSource}`
<code class="deleteAPI">DELETE</code> <code>/druid/coordinator/v1/config/compaction/&#123;dataSource&#125;</code>

#### Responses

Expand Down Expand Up @@ -196,7 +196,7 @@ Note that while the max compaction tasks can theoretically be set to 2147483647,

#### URL

`POST` `/druid/coordinator/v1/config/compaction/taskslots`
<code class="postAPI">POST</code> <code>/druid/coordinator/v1/config/compaction/taskslots</code>

#### Query parameters

Expand Down Expand Up @@ -268,7 +268,7 @@ You can use this endpoint to retrieve `compactionTaskSlotRatio` and `maxCompacti

#### URL

`GET` `/druid/coordinator/v1/config/compaction`
<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction</code>

#### Responses

Expand Down Expand Up @@ -417,7 +417,7 @@ Retrieves the automatic compaction configuration for a datasource.

#### URL

`GET` `/druid/coordinator/v1/config/compaction/{dataSource}`
<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction/&#123;dataSource&#125;</code>

#### Responses

Expand Down Expand Up @@ -529,7 +529,7 @@ The response contains a list of objects with the following keys:

#### URL

`GET` `/druid/coordinator/v1/config/compaction/{dataSource}/history`
<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction/&#123;dataSource&#125;/history</code>

#### Query parameters
* `interval` (optional)
Expand Down Expand Up @@ -689,7 +689,7 @@ Returns the total size of segments awaiting compaction for a given datasource. R

#### URL

`GET` `/druid/coordinator/v1/compaction/progress?dataSource={dataSource}`
<code class="getAPI">GET</code> <code>druid/coordinator/v1/compaction/progress?dataSource=&#123;dataSource&#125;</code>

#### Query parameter
* `dataSource` (required)
Expand Down Expand Up @@ -773,7 +773,7 @@ The `latestStatus` object has the following properties:

#### URL

`GET` `/druid/coordinator/v1/compaction/status`
<code class="getAPI">GET</code> <code>/druid/coordinator/v1/compaction/status</code>

#### Query parameters
* `dataSource` (optional)
Expand Down
3 changes: 2 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ module.exports={
],
"stylesheets": [
"https://use.fontawesome.com/releases/v5.7.2/css/all.css",
"/css/code-block-buttons.css"
"/css/code-block-buttons.css",
"/css/api.css"
],
"favicon": "img/favicon.png",
"customFields": {
Expand Down
31 changes: 31 additions & 0 deletions website/static/css/api.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* 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.
*/

/* API docs css */
.getAPI {
color: #0073e6;
font-weight: bold;
}
.postAPI {
color: #00bf7d;
font-weight: bold;
}
.deleteAPI {
color: #f49200;
font-weight: bold;
}