Skip to content
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

chore(endpoints): migrate regions step 1 - in openapi-appengine.yaml #13016

Merged
merged 2 commits into from
Dec 29, 2024
Merged

chore(endpoints): migrate regions step 1 - in openapi-appengine.yaml #13016

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b09d3ed
chore(endpoints): add regions to openapi.yaml
eapl-gemugami Dec 24, 2024
7a469dd
chore(endpoints): remove region to openapi-appengine.yaml
eapl-gemugami Dec 24, 2024
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
6 changes: 4 additions & 2 deletions endpoints/getting-started/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# [START endpoints_swagger_yaml_python]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the AUTHORING_GUIDE.md, region tags should be placed after the license header but before imports and global configurations. In this case, the endpoints_swagger_yaml_python region tag should be placed before the swagger tag. It's important to maintain consistency and clarity in region tag placement for documentation generation.

Suggested change
# [START endpoints_swagger_yaml_python]
# [START swagger]
# [START endpoints_swagger_yaml_python]

# [START swagger]
swagger: "2.0"
info:
Expand All @@ -20,6 +21,7 @@ info:
version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
# [END swagger]
# [END endpoints_swagger_yaml_python]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the AUTHORING_GUIDE.md, region tags should be placed after the license header but before imports and global configurations. In this case, the endpoints_swagger_yaml_python region tag should be placed after the swagger tag. It's important to maintain consistency and clarity in region tag placement for documentation generation.

Suggested change
# [END endpoints_swagger_yaml_python]
# [END endpoints_swagger_yaml_python]
# [END swagger]

consumes:
- "application/json"
produces:
Expand Down Expand Up @@ -103,6 +105,7 @@ definitions:
type: "string"
email:
type: "string"
# [START endpoints_security_definitions_yaml_python]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the AUTHORING_GUIDE.md, region tags should be placed after the license header but before imports and global configurations. In this case, the endpoints_security_definitions_yaml_python region tag should be placed before the securityDef tag. It's important to maintain consistency and clarity in region tag placement for documentation generation.

Suggested change
# [START endpoints_security_definitions_yaml_python]
# [START securityDef]
# [START endpoints_security_definitions_yaml_python]

# [START securityDef]
securityDefinitions:
# This section configures basic authentication with an API key.
Expand All @@ -111,6 +114,7 @@ securityDefinitions:
name: "key"
in: "query"
# [END securityDef]
# [END endpoints_security_definitions_yaml_python]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the AUTHORING_GUIDE.md, region tags should be placed after the license header but before imports and global configurations. In this case, the endpoints_security_definitions_yaml_python region tag should be placed after the securityDef tag. It's important to maintain consistency and clarity in region tag placement for documentation generation.

Suggested change
# [END endpoints_security_definitions_yaml_python]
# [END endpoints_security_definitions_yaml_python]
# [END securityDef]

# This section configures authentication using Google API Service Accounts
# to sign a json web token. This is mostly used for server-to-server
# communication.
Expand Down Expand Up @@ -162,12 +166,10 @@ securityDefinitions:
# Your OAuth2 client's Client ID must be added here. You can add multiple client IDs to accept tokens form multiple clients.
x-google-audiences: "YOUR-CLIENT-ID"
# This section configures authentication using Firebase Auth.
# [START firebaseAuth]
firebase:
authorizationUrl: ""
flow: "implicit"
type: "oauth2"
x-google-issuer: "https://securetoken.google.com/YOUR-PROJECT-ID"
x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/[email protected]"
x-google-audiences: "YOUR-PROJECT-ID"
Comment on lines 169 to 175
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The firebaseAuth region tags have been removed in this pull request. Please update the documentation to reflect this change. It's important to keep the documentation synchronized with the code.

# [END firebaseAuth]