Skip to content

Commit

Permalink
🚚 Rename person file to people
Browse files Browse the repository at this point in the history
Renames `person.tsp` to `people.tsp` because SWAPI uses the plural name
in most documentation.

Includes this in the new CONTRIBUTING documentation. Moves some existing
developing documentation from README into the new documentation.
  • Loading branch information
connorjs committed Sep 9, 2023
1 parent 42ff987 commit 207c66f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

## Developing

### Run scripts

Use `npm run` to list all available scripts. The `release` script executes a
“release build.” The CI build uses this script.

### Directory structure

- [src](./src) contains the TypeSpec (`.tsp`) files

## TypeSpec conventions

- Separate files by type. Name files using the plural form, which SWAPI uses
in its documentation.

- Using `@resource` adds _all_ REST operations. Thus, the spec files explicitly
configure `list` and `read` operations because SWAPI only supports those.
16 changes: 0 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,5 @@ Follow these steps to consume the generated Open API specification for SWAPI.
./node_modules/swapi-typespec/swapi.openapi.yaml
```

## Developing

### Run scripts

Use `npm run` to list all available scripts. The `release` script executes a
“release build.” The CI build uses this script.

### Directory structure

- [src](./src) contains the TypeSpec (`.tsp`) files

### Notes

- Using `@resource` adds _all_ REST operations. Thus, the spec files explicitly
configure `list` and `read` operations because SWAPI only supports those.

[swapi]: https://swapi.dev
[typespec]: https://microsoft.github.io/typespec/
2 changes: 1 addition & 1 deletion src/main.tsp
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
import "./root.tsp";
import "./person.tsp";
import "./people.tsp";
File renamed without changes.

0 comments on commit 207c66f

Please sign in to comment.