Skip to content

LCORE-247: Better service name in config file #308

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 29, 2025
Merged

LCORE-247: Better service name in config file #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbec77b
Better service name in config file
tisnik Jul 29, 2025
f0f3320
Regenerated OpenAPI specification
tisnik Jul 29, 2025
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
4 changes: 2 additions & 2 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"openapi": "3.1.0",
"info": {
"title": "foo bar baz service - OpenAPI",
"description": "foo bar baz service API specification.",
"title": "Lightspeed Core Service (LCS) service - OpenAPI",
"description": "Lightspeed Core Service (LCS) service API specification.",
"license": {
Comment on lines +4 to 6
Copy link
Contributor

@coderabbitai coderabbitai bot Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Inconsistent example still shows old service name

The top-level info.title/description were fixed, but the example response inside /v1/config still returns "name": "foo bar baz" (≈ line 235).
This inconsistency will confuse clients generated from the spec.

-        "title": "Lightspeed Core Service (LCS) service - OpenAPI",
-        "description": "Lightspeed Core Service (LCS) service API specification.",
+        "title": "Lightspeed Core Service (LCS) - OpenAPI",
+        "description": "Lightspeed Core Service (LCS) API specification.",

Additional change required outside this hunk:

-                        "name": "foo bar baz",
+                        "name": "Lightspeed Core Service (LCS)",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"title": "Lightspeed Core Service (LCS) service - OpenAPI",
"description": "Lightspeed Core Service (LCS) service API specification.",
"license": {
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -4,6 +4,6 @@
- "title": "Lightspeed Core Service (LCS) service - OpenAPI",
- "description": "Lightspeed Core Service (LCS) service API specification.",
+ "title": "Lightspeed Core Service (LCS) - OpenAPI",
+ "description": "Lightspeed Core Service (LCS) API specification.",
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
@@ -235,7 +235,7 @@
"examples": {
"default": {
"value": {
- "name": "foo bar baz",
+ "name": "Lightspeed Core Service (LCS)",
"version": "1.2.3",
"status": "ok"
}
🤖 Prompt for AI Agents 
In docs/openapi.json around line 235, the example response inside the /v1/config
endpoint still uses the old service name "foo bar baz". Update this example to
use the new consistent service name "Lightspeed Core Service (LCS) service" to
match the top-level info.title and description, ensuring consistency throughout
the specification.

"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
Expand Down
4 changes: 2 additions & 2 deletions docs/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# foo bar baz service - OpenAPI
# Lightspeed Core Service (LCS) service - OpenAPI

foo bar baz service API specification.
Lightspeed Core Service (LCS) service API specification.

## 🌍 Base URL

Expand Down
2 changes: 1 addition & 1 deletion lightspeed-stack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: foo bar baz
name: Lightspeed Core Service (LCS)
Copy link
Contributor

@coderabbitai coderabbitai bot Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Name updated – search for stale references

Renaming to “Lightspeed Core Service (LCS)” looks correct.
Please verify no other YAML / JSON files or code still reference the old placeholder (“foo bar baz”), otherwise config-parsing or UI breadcrumbs may display inconsistent names.

🏁 Script executed:

#!/bin/bash
# Find any leftover occurrences of the old placeholder
rg -n --ignore-case 'foo bar baz'

Length of output: 422

Update all stale “foo bar baz” references

The placeholder name “foo bar baz” still appears in several files. Please replace these with “Lightspeed Core Service (LCS)” to ensure consistency across configs, docs, and tests:

  • README.md (lines 99, 178)
  • tests/integration/test_configuration.py (line 40)
  • tests/unit/test_configuration.py (line 153)
  • tests/configuration/lightspeed-stack.yaml (line 1)
  • src/app/endpoints/config.py (line 18)
  • docs/openapi.json (line 235)
🤖 Prompt for AI Agents 
In lightspeed-stack.yaml at line 1, replace the placeholder name "foo bar baz"
with "Lightspeed Core Service (LCS)". Additionally, update all occurrences of
"foo bar baz" in README.md at lines 99 and 178,
tests/integration/test_configuration.py at line 40,
tests/unit/test_configuration.py at line 153, src/app/endpoints/config.py at
line 18, and docs/openapi.json at line 235 to "Lightspeed Core Service (LCS)" to
maintain consistency across all files.

service:
host: localhost
port: 8080
Expand Down
Loading