Naming Conventions

Soxom automatically transforms names to match each language’s conventions, ensuring idiomatic code generation.

Language Transforms

Property Names

OpenAPI	TypeScript	Python	Go	Java
user_name	userName	user_name	UserName	userName
createdAt	createdAt	created_at	CreatedAt	createdAt
API_KEY	apiKey	api_key	APIKEY	apiKey
HTMLParser	htmlParser	html_parser	HTMLParser	htmlParser

Method Names

OpenAPI/Config	TypeScript	Python	Go	Java
list	list	list	List	list
get	get	get	Get	get
create	create	create	Create	create
getUserById	getUserById	get_user_by_id	GetUserByID	getUserById

Type/Class Names

OpenAPI Schema	TypeScript	Python	Go	Java
User	User	User	User	User
user_profile	UserProfile	UserProfile	UserProfile	UserProfile
HTTPResponse	HttpResponse	HttpResponse	HTTPResponse	HttpResponse

Method Naming Conventions

Soxom generates method names based on HTTP method and path pattern:

Standard CRUD Operations

HTTP Method	Path Pattern	Default Name
GET	/resources	list
GET	/resources/{id}	get
POST	/resources	create
PUT	/resources/{id}	update
PATCH	/resources/{id}	patch
DELETE	/resources/{id}	delete

Custom Actions

HTTP Method	Path Pattern	Default Name
POST	/resources/{id}/cancel	cancel
POST	/resources/{id}/archive	archive
POST	/resources/batch	batch
GET	/resources/{id}/status	getStatus

Override in soxom.yaml

resources:
  orders:
    methods:
      # Use custom names
      fetchAll: get /orders         # Instead of "list"
      archive: delete /orders/{id}  # Instead of "delete"

Model Naming

Model names come directly from OpenAPI schema names:

components:
  schemas:
    User:           # → User
    UserCreate:     # → UserCreate
    user_settings:  # → UserSettings (PascalCase)
    APIToken:       # → ApiToken / APIToken (language-dependent)

Naming Rules

1. PascalCase for types - All languages use PascalCase for type names
2. Preserve acronyms - API, HTTP, URL handling varies by language
3. Remove invalid characters - Spaces, special chars are removed

Acronym Handling

Different languages handle acronyms differently:

Input	TypeScript	Python	Go	Java
APIKey	ApiKey	ApiKey	APIKey	ApiKey
HTTPStatus	HttpStatus	HttpStatus	HTTPStatus	HttpStatus
userID	userId	user_id	UserID	userId
XMLParser	XmlParser	XmlParser	XMLParser	XmlParser

Note

Go preserves common acronyms (API, HTTP, ID, URL, JSON, XML) in uppercase.

JSON Serialization

Generated code uses original OpenAPI names for JSON:

interface User {
  userName: string;  // TypeScript property name
}

// Serializes to/from:
// { "user_name": "..." }  ← Original OpenAPI name

type User struct {
    UserName string `json:"user_name"` // Tag preserves original
}

Reserved Words

Soxom handles language reserved words automatically:

Conflict	TypeScript	Python	Go	Java
class	class_	class_	Class	classValue
type	type_	type_	Type_	typeValue
default	default_	default_	Default_	defaultValue

Enum Naming

Enum Type Names

UserStatus:
  type: string
  enum: [active, inactive, pending]

Language	Type Name	Values
TypeScript	UserStatus	'active' | 'inactive' | 'pending'
Python	UserStatus(Enum)	ACTIVE, INACTIVE, PENDING
Go	UserStatus	UserStatusActive, UserStatusInactive
Java	UserStatus	ACTIVE, INACTIVE, PENDING

Enum Value Transforms

OpenAPI Value	TypeScript	Python	Go	Java
active	'active'	ACTIVE	UserStatusActive	ACTIVE
in-progress	'in-progress'	IN_PROGRESS	UserStatusInProgress	IN_PROGRESS
PENDING	'PENDING'	PENDING	UserStatusPending	PENDING

File Naming

Generated file names follow language conventions:

Content	TypeScript	Python	Go	Java
User type	user.ts	user.py	user.go	User.java
Users resource	users.ts	users.py	users.go	Users.java
Client	client.ts	client.py	client.go	Client.java

Best Practices

In Your OpenAPI Spec

1. Use snake_case for properties - Most universally compatible
2. Use PascalCase for schemas - Becomes type names directly
3. Use descriptive operationIds - Helps with method naming
4. Avoid reserved words - Even though Soxom handles them

Example

# Good naming in OpenAPI
components:
  schemas:
    User:                    # PascalCase for types
      type: object
      properties:
        user_name:           # snake_case for properties
          type: string
        created_at:          # snake_case with common suffix
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/UserStatus'

    UserStatus:              # PascalCase for enums
      type: string
      enum:
        - active             # lowercase for enum values
        - inactive
        - pending

Next Steps

• Schema Overview - Type generation overview
• Configuration - SDK configuration options