Skip to content

Commit

Permalink
refactor: Change yaml-file to YAML-file for all versions for consiste…
Browse files Browse the repository at this point in the history
…ncy.
  • Loading branch information
SandPod committed Dec 13, 2024
1 parent 94551f8 commit 5b46b8d
Show file tree
Hide file tree
Showing 53 changed files with 85 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/06-concepts/04-exceptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use the Serverpod Insights app to view your logs. It will show any failed or slo

## Serializable exceptions

Serverpod allows adding data to an exception you throw on the server and extracting that data in the client. This is useful for passing error messages back to the client when a call fails. You use the same yaml-files to define the serializable exceptions as you would with any serializable model (see [serialization](serialization) for details). The only difference is that you use the keyword `exception` instead of `class`.
Serverpod allows adding data to an exception you throw on the server and extracting that data in the client. This is useful for passing error messages back to the client when a call fails. You use the same YAML-files to define the serializable exceptions as you would with any serializable model (see [serialization](serialization) for details). The only difference is that you use the keyword `exception` instead of `class`.

```yaml
exception: MyException
Expand Down
4 changes: 2 additions & 2 deletions docs/06-concepts/06-database/04-indexing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Indexing

For performance reasons, you may want to add indexes to your database tables. These are added in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. These are added in the YAML-files defining the serializable objects.

### Add an index

To add an index, add an `indexes` section to the yaml-file. The `indexes` section is a map where the key is the name of the index and the value is a map with the index details.
To add an index, add an `indexes` section to the YAML-file. The `indexes` section is a map where the key is the name of the index and the value is a map with the index details.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.10/03-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.11/03-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you use the `database` or `api` options the field must be nullable.
:::

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.20/04-concepts/02-serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database.

## Serverpod's native serialization
The structure for your serialized classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
The structure for your serialized classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you use the `database` or `api` options the field must be nullable.
:::

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.20/04-concepts/06-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ dependencies:
```

## Referencing a module
It can be useful to reference serializable objects in other modules from the yaml-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.
It can be useful to reference serializable objects in other modules from the YAML-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.

```yaml
class: MyClass
Expand All @@ -84,4 +84,4 @@ In your Flutter package, you most likely want to import the client libraries cre

Most modules will need a set of database tables to function. When naming the tables, you should use the module name as a prefix to the table name to avoid any conflicts. For instance, the Serverpod tables are prefixed with `serverpod_`.

:::
:::
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.21/04-concepts/02-serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database.

## Serverpod's native serialization
The structure for your serialized classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
The structure for your serialized classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you use the `database` or `api` options the field must be nullable.
:::

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.21/04-concepts/06-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ dependencies:
```

## Referencing a module
It can be useful to reference serializable objects in other modules from the yaml-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.
It can be useful to reference serializable objects in other modules from the YAML-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.

```yaml
class: MyClass
Expand All @@ -84,4 +84,4 @@ In your Flutter package, you most likely want to import the client libraries cre

Most modules will need a set of database tables to function. When naming the tables, you should use the module name as a prefix to the table name to avoid any conflicts. For instance, the Serverpod tables are prefixed with `serverpod_`.

:::
:::
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.22/04-concepts/02-serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database.

## Serverpod's native serialization
The structure for your serialized classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
The structure for your serialized classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you use the `database` or `api` options the field must be nullable.
:::

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.22/04-concepts/06-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ dependencies:
```

## Referencing a module
It can be useful to reference serializable objects in other modules from the yaml-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.
It can be useful to reference serializable objects in other modules from the YAML-files in your protocol directory. You do this by adding the module prefix, followed by the nickname of the package. For instance, this is how you reference a serializable class in the auth package.

```yaml
class: MyClass
Expand All @@ -84,4 +84,4 @@ In your Flutter package, you most likely want to import the client libraries cre

Most modules will need a set of database tables to function. When naming the tables, you should use the module name as a prefix to the table name to avoid any conflicts. For instance, the Serverpod tables are prefixed with `serverpod_`.

:::
:::
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.5/02-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.6/02-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.7/03-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.8/03-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.9.9/03-concepts/02-serialization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Serialization
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. The structure for the classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fields:
Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the `api` flag. By default, a field is accessible to both the API and the database.

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1.0.0/04-concepts/02-serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database.

## Serverpod's native serialization
The structure for your serialized classes is defined in yaml-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.
The structure for your serialized classes is defined in YAML-files in the `protocol` directory. Run `serverpod generate` to build the Dart code for the classes and make them accessible to both the server and client.

Here is a simple example of a yaml-file defining a serializable class:
Here is a simple example of a YAML-file defining a serializable class:

```yaml
class: Company
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you use the `database` or `api` options the field must be nullable.
:::

### Database indexes
For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.
For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.

```yaml
class: Company
Expand Down
Loading

0 comments on commit 5b46b8d

Please sign in to comment.