Skip to content

Update README.md #2

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 1 commit into from
Oct 5, 2023
Merged

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 17 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ import "oapi/v1/method.proto";
import "oapi/v1/service.proto";

option (oapi.v1.file) = {
host: "myawesomeapi.com"
servers: {
url: "myawesomeapi.com"
}

security_schemes: {
name: "bearer_auth"
Expand Down Expand Up @@ -150,9 +152,9 @@ message CreateSomethingResponse {
> the best I can.

<details>
<summary><h3>Host definitions</h3></summary>
<summary><h3>Server definitions</h3></summary>

You can define hosts at the file, service, or method level. Each one overrides
You can define servers at the file, service, or method level. Each one overrides
the previous. This allows for more advanced composition.

**Example:**
Expand All @@ -167,17 +169,23 @@ import "oapi/v1/service.proto";


option (oapi.v1.file) = {
host: "myawesomeapi.com" // file-defined for all services and methods
servers {
url: "myawesomeapi.com" // file-defined for all services and methods
}
};

service MyService {
option (oapi.v1.service) = {
host: "myawesomeapi2.com" // overrides file-defined
servers {
url: "myawesomeapi2.com" // overrides file-defined
}
};

rpc CreateSomething (google.protobuf.Empty) returns (google.protobuf.Empty) {
option (oapi.v1.method) = {
host: "myaweseomeapi3.com" // overrides service-defined
servers {
url: "myaweseomeapi3.com" // overrides service-defined
}
};
}
}
Expand Down Expand Up @@ -206,7 +214,9 @@ import "oapi/v1/method.proto";
import "oapi/v1/service.proto";

option (oapi.v1.file) = {
host: "myawesomeapi.com"
servers {
url: "myawesomeapi.com"
}
};

service MyService {
Expand Down