Manage Style Guides

📘
Available on paid plans
This feature is currently available only on Lara paid plans. See plans & pricing.

Style guide object

The style guide describes a style guide resource and its metadata.

Field	Type	Description
id	Integer	Unique ID of the style guide. Format: 1234567
name	String	Custom name of the style guide; it can be any string, including spaces, special characters, and non-Latin alphabets. Max length: 250 characters.
content	String	The content of the style guide; it can be any string, including spaces, special characters, and non-Latin alphabets. Max length: 15000 characters.

List style guide

Lists all style guides available to the user

# List all style guides available to the user
styleguides = lara.styleguides.list()

// List all style guides available to the user
const styleguides = await lara.styleguides.list();

// List all style guides available to the user
List<Styleguides> styleguides = lara.styleguides.list();

// List all style guides available to the user
$styleguides = $lara->styleguides->getAll();

// List all style guides available to the user
styleguides, _ := lara.Styleguides.List()

// List all style guides available to the user
val styleguides: List<Styleguides> = lara.styleguides.list()

// List all style guides available to the user
var styleguides = await lara.Styleguides.List();

// List all style guides available to the user
let styleguides = try await lara.styleguides.list()

Upload new style guide

Upload a new style guide with a custom name.

# Upload a new style guide with name 'Style guide 1'        
styleguide = lara.styleguides.create('Style guide 1',"Use a formal tone. Prefer British English spelling. Avoid contractions.")

// Upload a new style guide with name 'Style guide 1'
const styleguide = await lara.styleguides.create('Style guide 1',"Use a formal tone. Prefer British English spelling. Avoid contractions.");

// Upload a new style guide with name 'Style guide 1'
Styleguide styleguide = lara.styleguides.create("Style guide 1","Use a formal tone. Prefer British English spelling. Avoid contractions.");

// Upload a new style guide with name 'Style guide 1'
$styleguide = $lara->styleguides->create('Style guide 1',"Use a formal tone. Prefer British English spelling. Avoid contractions.");

// Upload a new style guide with name 'Style guide 1'
newStyleguide, _ := lara.Styleguides.Create("Style guide 1","Use a formal tone. Prefer British English spelling. Avoid contractions.")

// Upload a new style guide with name "Style guide 1"
val styleguide: Styleguides = lara.styleguides.create("Style guide 1","Use a formal tone. Prefer British English spelling. Avoid contractions.")

// Upload a new style guide with name 'Style guide 1'
var styleguide = await lara.Styleguides.Create("Style guide 1","Use a formal tone. Prefer British English spelling. Avoid contractions.");

// Upload a new style guide with name 'Styleguide 1'
let styleguide = try await lara.styleguides.create(name: "Styleguide 1","Use a formal tone. Prefer British English spelling. Avoid contractions.")

Field	Type	Required	Default	Description
name	String	No		The new name for the style guide
content	String	No		The content of the new style guide

Update style guide

Updates the name and the content of a specific style guide

# Update style guide name
updated_styleguide = lara.styleguides.update(123456, 'New Name for my style guide')

# Update style guide content
updated_styleguide = lara.styleguides.update(123456, None, "Use a non formal tone. Prefer American English spelling.")

// Update style guide name
const updatedStyleguide = await lara.styleguides.update(123456, 'New Name for my style guide');

// Update style guide content
const updatedStyleguide = await lara.styleguides.update(123456, undefined, 'Use a non formal tone. Prefer American English spelling.')

// Update style guide name
Styleguide updatedStyleguide = lara.styleguides.update(123456, 'New Name for my style guide');

// Update style guide content
Styleguide updatedStyleguide = lara.styleguides.update(123456, null, 'Use a non formal tone. Prefer American English spelling.');

// Update style guide name
$updatedStyleguide = $lara->styleguides->update(123456, 'New Name for my style guide');

// Update style guide content
$updatedStyleguide = $lara->styleguides->update(123456, null, 'Use a non formal tone. Prefer American English spelling.');

// Update style guide name
updatedStyleguide, _ := lara.Styleguides.Update(12345, "New Name for my style guide")

// Update style guide content
updatedStyleguide, _ := lara.Styleguides.Update(12345, nil, "Use a non formal tone. Prefer American English spelling.")

// Update style guide name
val updatedStyleguide: Styleguide = lara.styleguides.update(12345, "New Name for my style guide")

// Update style guide name
val updatedStyleguide: Styleguide = lara.styleguides.update(12345, undefined, "Use a non formal tone. Prefer American English spelling.")

// Update style guide name
var updatedStyleguide = await lara.Styleguides.Update(12345, "New Name for my style guide");

// Update style guide content
var updatedStyleguide = await lara.Styleguides.Update(12345, null, "Use a non formal tone. Prefer American English spelling.");

// Update style guide name
let updatedStyleguide = try await lara.styleguides.update(id: 1233456, name: "New Name for my style guide")

// Update style guide content
let updatedStyleguide = try await lara.styleguides.update(id: 123456, content: "Use a non formal tone. Prefer American English spelling.")

Field	Type	Required	Description
id	Integer	Yes	The unique identifier of the style guide to update. Format: 123344
name	String	No	The new name for the style guide
content	String	No	The new content of the new style guide

Delete style guide

Deletes a specific style guide

# Delete a style guide
deleted_styleguide = lara.styleguides.delete(123456)

// Delete a style guide
const deletedStyleguide = await lara.styleguides.delete(123456);

// Delete a style guide
Styleguide deletedStyleguide = lara.styleguides.delete(123456);

// Delete a style guide
$deletedStyleguide = $lara->styleguides->delete(123456);

// Delete a style guide
deletedStyleguide, _ := lara.Styleguides.Delete(123456)

// Delete a style guide
val deletedStyleguide: Glossary = lara.styleguides.delete(123456)

// Delete a style guide
var deletedStyleguide = await lara.Styleguides.Delete(123456);

// Delete a style guide
let deletedStyleguide = try await lara.styleguides.delete(id: 123456)

Field	Type	Required	Default	Description
id	Integer	Yes		The unique identifier of the style guide to delete. Format: 1233456

Availability of style guide in SDKs

Starting from the following SDK versions, the style guide feature is available:

Python: v1.11.0
Node.js (TypeScript/JavaScript): v1.12.0
Java: v1.11.0
PHP: v1.8.0
Go: 1.5.0
.NET: 1.0.0
Swift: v1.7.0

For more details on implementation, refer to the SDK-specific documentation.